ibm 1.78.0, Apr 30 25

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getDlRouteReports

Explore with Pulumi AI

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

Import the details of an existing infrastructure Direct Link Route Reports as a read-only data source. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. For more information, about Direct Link route reports, see Direct Link Route Report.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const testDlReports = ibm.getDlRouteReports({
    gateway: ibm_dl_gateway.test_dl_gateway.id,
});

import pulumi
import pulumi_ibm as ibm

test_dl_reports = ibm.get_dl_route_reports(gateway=ibm_dl_gateway["test_dl_gateway"]["id"])

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetDlRouteReports(ctx, &ibm.GetDlRouteReportsArgs{
			Gateway: ibm_dl_gateway.Test_dl_gateway.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var testDlReports = Ibm.GetDlRouteReports.Invoke(new()
    {
        Gateway = ibm_dl_gateway.Test_dl_gateway.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetDlRouteReportsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testDlReports = IbmFunctions.getDlRouteReports(GetDlRouteReportsArgs.builder()
            .gateway(ibm_dl_gateway.test_dl_gateway().id())
            .build());

    }
}

variables:
  testDlReports:
    fn::invoke:
      function: ibm:getDlRouteReports
      arguments:
        gateway: ${ibm_dl_gateway.test_dl_gateway.id}

Using getDlRouteReports

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDlRouteReports(args: GetDlRouteReportsArgs, opts?: InvokeOptions): Promise<GetDlRouteReportsResult>
function getDlRouteReportsOutput(args: GetDlRouteReportsOutputArgs, opts?: InvokeOptions): Output<GetDlRouteReportsResult>

def get_dl_route_reports(gateway: Optional[str] = None,
                         id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetDlRouteReportsResult
def get_dl_route_reports_output(gateway: Optional[pulumi.Input[str]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetDlRouteReportsResult]

func GetDlRouteReports(ctx *Context, args *GetDlRouteReportsArgs, opts ...InvokeOption) (*GetDlRouteReportsResult, error)
func GetDlRouteReportsOutput(ctx *Context, args *GetDlRouteReportsOutputArgs, opts ...InvokeOption) GetDlRouteReportsResultOutput

> Note: This function is named GetDlRouteReports in the Go SDK.

public static class GetDlRouteReports 
{
    public static Task<GetDlRouteReportsResult> InvokeAsync(GetDlRouteReportsArgs args, InvokeOptions? opts = null)
    public static Output<GetDlRouteReportsResult> Invoke(GetDlRouteReportsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDlRouteReportsResult> getDlRouteReports(GetDlRouteReportsArgs args, InvokeOptions options)
public static Output<GetDlRouteReportsResult> getDlRouteReports(GetDlRouteReportsArgs args, InvokeOptions options)

fn::invoke:
  function: ibm:index/getDlRouteReports:getDlRouteReports
  arguments:
    # arguments dictionary

The following arguments are supported:

Gateway string: Direct Link Gateway ID.
Id string: (String) Route report identifier.

Gateway string: Direct Link Gateway ID.
Id string: (String) Route report identifier.

gateway String: Direct Link Gateway ID.
id String: (String) Route report identifier.

gateway string: Direct Link Gateway ID.
id string: (String) Route report identifier.

gateway str: Direct Link Gateway ID.
id str: (String) Route report identifier.

gateway String: Direct Link Gateway ID.
id String: (String) Route report identifier.

getDlRouteReports Result

The following output properties are available:

Gateway string
Id string: (String) Route report identifier.
RouteReports List<GetDlRouteReportsRouteReport>: (String) List of all route reports for the transit gateway Nested scheme for route_reports

Gateway string
Id string: (String) Route report identifier.
RouteReports []GetDlRouteReportsRouteReport: (String) List of all route reports for the transit gateway Nested scheme for route_reports

gateway String
id String: (String) Route report identifier.
routeReports List<GetDlRouteReportsRouteReport>: (String) List of all route reports for the transit gateway Nested scheme for route_reports

gateway string
id string: (String) Route report identifier.
routeReports GetDlRouteReportsRouteReport[]: (String) List of all route reports for the transit gateway Nested scheme for route_reports

gateway str
id str: (String) Route report identifier.
route_reports Sequence[GetDlRouteReportsRouteReport]: (String) List of all route reports for the transit gateway Nested scheme for route_reports

gateway String
id String: (String) Route report identifier.
routeReports List<Property Map>: (String) List of all route reports for the transit gateway Nested scheme for route_reports

Supporting Types

GetDlRouteReportsRouteReport

AdvertisedRoutes List<GetDlRouteReportsRouteReportAdvertisedRoute>: (List) List of connection prefixes advertised to the on-prem network. Nested scheme for advertised_routes:
CreatedAt string: (String) The date and time resource created.
GatewayRoutes List<GetDlRouteReportsRouteReportGatewayRoute>: (List) List of local/direct routes. Nested scheme for gateway_routes:
Id string: (String) Route report identifier.
OnPremRoutes List<GetDlRouteReportsRouteReportOnPremRoute>: (List) List of on premises routes Nested scheme for on_prem_routes:
OverlappingRoutes List<GetDlRouteReportsRouteReportOverlappingRoute>: (List) List of overlapping routes. Nested scheme for overlapping_routes:
Status string: (String) The route report status.
UpdatedAt string: (String) The date and time resource was updated.
VirtualConnectionRoutes List<GetDlRouteReportsRouteReportVirtualConnectionRoute>: (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes

AdvertisedRoutes []GetDlRouteReportsRouteReportAdvertisedRoute: (List) List of connection prefixes advertised to the on-prem network. Nested scheme for advertised_routes:
CreatedAt string: (String) The date and time resource created.
GatewayRoutes []GetDlRouteReportsRouteReportGatewayRoute: (List) List of local/direct routes. Nested scheme for gateway_routes:
Id string: (String) Route report identifier.
OnPremRoutes []GetDlRouteReportsRouteReportOnPremRoute: (List) List of on premises routes Nested scheme for on_prem_routes:
OverlappingRoutes []GetDlRouteReportsRouteReportOverlappingRoute: (List) List of overlapping routes. Nested scheme for overlapping_routes:
Status string: (String) The route report status.
UpdatedAt string: (String) The date and time resource was updated.
VirtualConnectionRoutes []GetDlRouteReportsRouteReportVirtualConnectionRoute: (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes

advertisedRoutes List<GetDlRouteReportsRouteReportAdvertisedRoute>: (List) List of connection prefixes advertised to the on-prem network. Nested scheme for advertised_routes:
createdAt String: (String) The date and time resource created.
gatewayRoutes List<GetDlRouteReportsRouteReportGatewayRoute>: (List) List of local/direct routes. Nested scheme for gateway_routes:
id String: (String) Route report identifier.
onPremRoutes List<GetDlRouteReportsRouteReportOnPremRoute>: (List) List of on premises routes Nested scheme for on_prem_routes:
overlappingRoutes List<GetDlRouteReportsRouteReportOverlappingRoute>: (List) List of overlapping routes. Nested scheme for overlapping_routes:
status String: (String) The route report status.
updatedAt String: (String) The date and time resource was updated.
virtualConnectionRoutes List<GetDlRouteReportsRouteReportVirtualConnectionRoute>: (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes

advertisedRoutes GetDlRouteReportsRouteReportAdvertisedRoute[]: (List) List of connection prefixes advertised to the on-prem network. Nested scheme for advertised_routes:
createdAt string: (String) The date and time resource created.
gatewayRoutes GetDlRouteReportsRouteReportGatewayRoute[]: (List) List of local/direct routes. Nested scheme for gateway_routes:
id string: (String) Route report identifier.
onPremRoutes GetDlRouteReportsRouteReportOnPremRoute[]: (List) List of on premises routes Nested scheme for on_prem_routes:
overlappingRoutes GetDlRouteReportsRouteReportOverlappingRoute[]: (List) List of overlapping routes. Nested scheme for overlapping_routes:
status string: (String) The route report status.
updatedAt string: (String) The date and time resource was updated.
virtualConnectionRoutes GetDlRouteReportsRouteReportVirtualConnectionRoute[]: (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes

advertised_routes Sequence[GetDlRouteReportsRouteReportAdvertisedRoute]: (List) List of connection prefixes advertised to the on-prem network. Nested scheme for advertised_routes:
created_at str: (String) The date and time resource created.
gateway_routes Sequence[GetDlRouteReportsRouteReportGatewayRoute]: (List) List of local/direct routes. Nested scheme for gateway_routes:
id str: (String) Route report identifier.
on_prem_routes Sequence[GetDlRouteReportsRouteReportOnPremRoute]: (List) List of on premises routes Nested scheme for on_prem_routes:
overlapping_routes Sequence[GetDlRouteReportsRouteReportOverlappingRoute]: (List) List of overlapping routes. Nested scheme for overlapping_routes:
status str: (String) The route report status.
updated_at str: (String) The date and time resource was updated.
virtual_connection_routes Sequence[GetDlRouteReportsRouteReportVirtualConnectionRoute]: (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes

advertisedRoutes List<Property Map>: (List) List of connection prefixes advertised to the on-prem network. Nested scheme for advertised_routes:
createdAt String: (String) The date and time resource created.
gatewayRoutes List<Property Map>: (List) List of local/direct routes. Nested scheme for gateway_routes:
id String: (String) Route report identifier.
onPremRoutes List<Property Map>: (List) List of on premises routes Nested scheme for on_prem_routes:
overlappingRoutes List<Property Map>: (List) List of overlapping routes. Nested scheme for overlapping_routes:
status String: (String) The route report status.
updatedAt String: (String) The date and time resource was updated.
virtualConnectionRoutes List<Property Map>: (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes

GetDlRouteReportsRouteReportAdvertisedRoute

AsPath string: (String) The BGP AS path of the route.
Prefix string: (String) The prefix used in the route.

AsPath string: (String) The BGP AS path of the route.
Prefix string: (String) The prefix used in the route.

asPath String: (String) The BGP AS path of the route.
prefix String: (String) The prefix used in the route.

asPath string: (String) The BGP AS path of the route.
prefix string: (String) The prefix used in the route.

as_path str: (String) The BGP AS path of the route.
prefix str: (String) The prefix used in the route.

asPath String: (String) The BGP AS path of the route.
prefix String: (String) The prefix used in the route.

GetDlRouteReportsRouteReportGatewayRoute

Prefix string: (String) The prefix used in the route.

Prefix string: (String) The prefix used in the route.

prefix String: (String) The prefix used in the route.

prefix string: (String) The prefix used in the route.

prefix str: (String) The prefix used in the route.

prefix String: (String) The prefix used in the route.

GetDlRouteReportsRouteReportOnPremRoute

AsPath string: (String) The BGP AS path of the route.
NextHop string: (String) Next hop address.
Prefix string: (String) The prefix used in the route.

AsPath string: (String) The BGP AS path of the route.
NextHop string: (String) Next hop address.
Prefix string: (String) The prefix used in the route.

asPath String: (String) The BGP AS path of the route.
nextHop String: (String) Next hop address.
prefix String: (String) The prefix used in the route.

asPath string: (String) The BGP AS path of the route.
nextHop string: (String) Next hop address.
prefix string: (String) The prefix used in the route.

as_path str: (String) The BGP AS path of the route.
next_hop str: (String) Next hop address.
prefix str: (String) The prefix used in the route.

asPath String: (String) The BGP AS path of the route.
nextHop String: (String) Next hop address.
prefix String: (String) The prefix used in the route.

GetDlRouteReportsRouteReportOverlappingRoute

Routes List<GetDlRouteReportsRouteReportOverlappingRouteRoute>: (List) List of virtual connection routes. Nested scheme for routes:

Routes []GetDlRouteReportsRouteReportOverlappingRouteRoute: (List) List of virtual connection routes. Nested scheme for routes:

routes List<GetDlRouteReportsRouteReportOverlappingRouteRoute>: (List) List of virtual connection routes. Nested scheme for routes:

routes GetDlRouteReportsRouteReportOverlappingRouteRoute[]: (List) List of virtual connection routes. Nested scheme for routes:

routes Sequence[GetDlRouteReportsRouteReportOverlappingRouteRoute]: (List) List of virtual connection routes. Nested scheme for routes:

routes List<Property Map>: (List) List of virtual connection routes. Nested scheme for routes:

GetDlRouteReportsRouteReportOverlappingRouteRoute

Prefix string: (String) The prefix used in the route.
Type string: (String) The type of route.
VirtualConnectionId string: (String) Virtual Connection ID

Prefix string: (String) The prefix used in the route.
Type string: (String) The type of route.
VirtualConnectionId string: (String) Virtual Connection ID

prefix String: (String) The prefix used in the route.
type String: (String) The type of route.
virtualConnectionId String: (String) Virtual Connection ID

prefix string: (String) The prefix used in the route.
type string: (String) The type of route.
virtualConnectionId string: (String) Virtual Connection ID

prefix str: (String) The prefix used in the route.
type str: (String) The type of route.
virtual_connection_id str: (String) Virtual Connection ID

prefix String: (String) The prefix used in the route.
type String: (String) The type of route.
virtualConnectionId String: (String) Virtual Connection ID

GetDlRouteReportsRouteReportVirtualConnectionRoute

Routes List<GetDlRouteReportsRouteReportVirtualConnectionRouteRoute>: (List) List of virtual connection routes. Nested scheme for routes:
VirtualConnectionId string: (String) Virtual Connection ID
VirtualConnectionName string: (String) Virtual Connection name
VirtualConnectionType string: (String) Virtual Connection type

Routes []GetDlRouteReportsRouteReportVirtualConnectionRouteRoute: (List) List of virtual connection routes. Nested scheme for routes:
VirtualConnectionId string: (String) Virtual Connection ID
VirtualConnectionName string: (String) Virtual Connection name
VirtualConnectionType string: (String) Virtual Connection type

routes List<GetDlRouteReportsRouteReportVirtualConnectionRouteRoute>: (List) List of virtual connection routes. Nested scheme for routes:
virtualConnectionId String: (String) Virtual Connection ID
virtualConnectionName String: (String) Virtual Connection name
virtualConnectionType String: (String) Virtual Connection type

routes GetDlRouteReportsRouteReportVirtualConnectionRouteRoute[]: (List) List of virtual connection routes. Nested scheme for routes:
virtualConnectionId string: (String) Virtual Connection ID
virtualConnectionName string: (String) Virtual Connection name
virtualConnectionType string: (String) Virtual Connection type

routes Sequence[GetDlRouteReportsRouteReportVirtualConnectionRouteRoute]: (List) List of virtual connection routes. Nested scheme for routes:
virtual_connection_id str: (String) Virtual Connection ID
virtual_connection_name str: (String) Virtual Connection name
virtual_connection_type str: (String) Virtual Connection type

routes List<Property Map>: (List) List of virtual connection routes. Nested scheme for routes:
virtualConnectionId String: (String) Virtual Connection ID
virtualConnectionName String: (String) Virtual Connection name
virtualConnectionType String: (String) Virtual Connection type

GetDlRouteReportsRouteReportVirtualConnectionRouteRoute

Active bool: (Bool) Indicates whether the route is the preferred path of the prefix.
LocalPreference string: (String) The local preference of the route. This attribute can manipulate the chosen path on routes.
Prefix string: (String) The prefix used in the route.

Active bool: (Bool) Indicates whether the route is the preferred path of the prefix.
LocalPreference string: (String) The local preference of the route. This attribute can manipulate the chosen path on routes.
Prefix string: (String) The prefix used in the route.

active Boolean: (Bool) Indicates whether the route is the preferred path of the prefix.
localPreference String: (String) The local preference of the route. This attribute can manipulate the chosen path on routes.
prefix String: (String) The prefix used in the route.

active boolean: (Bool) Indicates whether the route is the preferred path of the prefix.
localPreference string: (String) The local preference of the route. This attribute can manipulate the chosen path on routes.
prefix string: (String) The prefix used in the route.

active bool: (Bool) Indicates whether the route is the preferred path of the prefix.
local_preference str: (String) The local preference of the route. This attribute can manipulate the chosen path on routes.
prefix str: (String) The prefix used in the route.

active Boolean: (Bool) Indicates whether the route is the preferred path of the prefix.
localPreference String: (String) The local preference of the route. This attribute can manipulate the chosen path on routes.
prefix String: (String) The prefix used in the route.

Package Details

Repository: ibm ibm-cloud/terraform-provider-ibm
License
Notes: This Pulumi package is based on the ibm Terraform Provider.

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

ibm.getDlRouteReports

On this page

On this page

Example Usage

Using getDlRouteReports

getDlRouteReports Result

Supporting Types

GetDlRouteReportsRouteReport

GetDlRouteReportsRouteReportAdvertisedRoute

GetDlRouteReportsRouteReportGatewayRoute

GetDlRouteReportsRouteReportOnPremRoute

GetDlRouteReportsRouteReportOverlappingRoute

GetDlRouteReportsRouteReportOverlappingRouteRoute

GetDlRouteReportsRouteReportVirtualConnectionRoute

GetDlRouteReportsRouteReportVirtualConnectionRouteRoute

Package Details

On this page

On this page