1. Packages
  2. Ibm Provider
  3. API Docs
  4. getDlRouteReport
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getDlRouteReport

Explore with Pulumi AI

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

    Import the details of an existing infrastructure Direct Link Route Report 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

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    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.dl_gateway().id())
                .routeReport(ibm_dl_route_report.dl_route_report().route_report_id())
                .build());
    
        }
    }
    
    variables:
      testDlReports:
        fn::invoke:
          function: ibm:getDlRouteReports
          arguments:
            gateway: ${ibm_dl_gateway.dl_gateway.id}
            routeReport: ${ibm_dl_route_report.dl_route_report.route_report_id}
    

    Using getDlRouteReport

    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 getDlRouteReport(args: GetDlRouteReportArgs, opts?: InvokeOptions): Promise<GetDlRouteReportResult>
    function getDlRouteReportOutput(args: GetDlRouteReportOutputArgs, opts?: InvokeOptions): Output<GetDlRouteReportResult>
    def get_dl_route_report(gateway: Optional[str] = None,
                            id: Optional[str] = None,
                            route_report: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetDlRouteReportResult
    def get_dl_route_report_output(gateway: Optional[pulumi.Input[str]] = None,
                            id: Optional[pulumi.Input[str]] = None,
                            route_report: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetDlRouteReportResult]
    func LookupDlRouteReport(ctx *Context, args *LookupDlRouteReportArgs, opts ...InvokeOption) (*LookupDlRouteReportResult, error)
    func LookupDlRouteReportOutput(ctx *Context, args *LookupDlRouteReportOutputArgs, opts ...InvokeOption) LookupDlRouteReportResultOutput

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

    public static class GetDlRouteReport 
    {
        public static Task<GetDlRouteReportResult> InvokeAsync(GetDlRouteReportArgs args, InvokeOptions? opts = null)
        public static Output<GetDlRouteReportResult> Invoke(GetDlRouteReportInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDlRouteReportResult> getDlRouteReport(GetDlRouteReportArgs args, InvokeOptions options)
    public static Output<GetDlRouteReportResult> getDlRouteReport(GetDlRouteReportArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getDlRouteReport:getDlRouteReport
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Gateway string
    Direct Link Gateway ID.
    RouteReport string
    Unique identifier of the route report
    Id string
    Gateway string
    Direct Link Gateway ID.
    RouteReport string
    Unique identifier of the route report
    Id string
    gateway String
    Direct Link Gateway ID.
    routeReport String
    Unique identifier of the route report
    id String
    gateway string
    Direct Link Gateway ID.
    routeReport string
    Unique identifier of the route report
    id string
    gateway str
    Direct Link Gateway ID.
    route_report str
    Unique identifier of the route report
    id str
    gateway String
    Direct Link Gateway ID.
    routeReport String
    Unique identifier of the route report
    id String

    getDlRouteReport Result

    The following output properties are available:

    AdvertisedRoutes List<GetDlRouteReportAdvertisedRoute>
    (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.
    Gateway string
    GatewayRoutes List<GetDlRouteReportGatewayRoute>
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    Id string
    OnPremRoutes List<GetDlRouteReportOnPremRoute>
    (List) List of on premises routes Nested scheme for on_prem_routes:
    OverlappingRoutes List<GetDlRouteReportOverlappingRoute>
    (List) List of overlapping routes. Nested scheme for overlapping_routes:
    RouteReport string
    Status string
    (String) The route report status.
    UpdatedAt string
    (String) The date and time resource was updated.
    VirtualConnectionRoutes List<GetDlRouteReportVirtualConnectionRoute>
    (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes
    AdvertisedRoutes []GetDlRouteReportAdvertisedRoute
    (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.
    Gateway string
    GatewayRoutes []GetDlRouteReportGatewayRoute
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    Id string
    OnPremRoutes []GetDlRouteReportOnPremRoute
    (List) List of on premises routes Nested scheme for on_prem_routes:
    OverlappingRoutes []GetDlRouteReportOverlappingRoute
    (List) List of overlapping routes. Nested scheme for overlapping_routes:
    RouteReport string
    Status string
    (String) The route report status.
    UpdatedAt string
    (String) The date and time resource was updated.
    VirtualConnectionRoutes []GetDlRouteReportVirtualConnectionRoute
    (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes
    advertisedRoutes List<GetDlRouteReportAdvertisedRoute>
    (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.
    gateway String
    gatewayRoutes List<GetDlRouteReportGatewayRoute>
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    id String
    onPremRoutes List<GetDlRouteReportOnPremRoute>
    (List) List of on premises routes Nested scheme for on_prem_routes:
    overlappingRoutes List<GetDlRouteReportOverlappingRoute>
    (List) List of overlapping routes. Nested scheme for overlapping_routes:
    routeReport String
    status String
    (String) The route report status.
    updatedAt String
    (String) The date and time resource was updated.
    virtualConnectionRoutes List<GetDlRouteReportVirtualConnectionRoute>
    (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes
    advertisedRoutes GetDlRouteReportAdvertisedRoute[]
    (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.
    gateway string
    gatewayRoutes GetDlRouteReportGatewayRoute[]
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    id string
    onPremRoutes GetDlRouteReportOnPremRoute[]
    (List) List of on premises routes Nested scheme for on_prem_routes:
    overlappingRoutes GetDlRouteReportOverlappingRoute[]
    (List) List of overlapping routes. Nested scheme for overlapping_routes:
    routeReport string
    status string
    (String) The route report status.
    updatedAt string
    (String) The date and time resource was updated.
    virtualConnectionRoutes GetDlRouteReportVirtualConnectionRoute[]
    (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes
    advertised_routes Sequence[GetDlRouteReportAdvertisedRoute]
    (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 str
    gateway_routes Sequence[GetDlRouteReportGatewayRoute]
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    id str
    on_prem_routes Sequence[GetDlRouteReportOnPremRoute]
    (List) List of on premises routes Nested scheme for on_prem_routes:
    overlapping_routes Sequence[GetDlRouteReportOverlappingRoute]
    (List) List of overlapping routes. Nested scheme for overlapping_routes:
    route_report str
    status str
    (String) The route report status.
    updated_at str
    (String) The date and time resource was updated.
    virtual_connection_routes Sequence[GetDlRouteReportVirtualConnectionRoute]
    (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.
    gateway String
    gatewayRoutes List<Property Map>
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    id String
    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:
    routeReport String
    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

    Supporting Types

    GetDlRouteReportAdvertisedRoute

    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.

    GetDlRouteReportGatewayRoute

    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.

    GetDlRouteReportOnPremRoute

    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.

    GetDlRouteReportOverlappingRoute

    Routes List<GetDlRouteReportOverlappingRouteRoute>
    (List) List of virtual connection routes. Nested scheme for routes:
    Routes []GetDlRouteReportOverlappingRouteRoute
    (List) List of virtual connection routes. Nested scheme for routes:
    routes List<GetDlRouteReportOverlappingRouteRoute>
    (List) List of virtual connection routes. Nested scheme for routes:
    routes GetDlRouteReportOverlappingRouteRoute[]
    (List) List of virtual connection routes. Nested scheme for routes:
    routes Sequence[GetDlRouteReportOverlappingRouteRoute]
    (List) List of virtual connection routes. Nested scheme for routes:
    routes List<Property Map>
    (List) List of virtual connection routes. Nested scheme for routes:

    GetDlRouteReportOverlappingRouteRoute

    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

    GetDlRouteReportVirtualConnectionRoute

    Routes List<GetDlRouteReportVirtualConnectionRouteRoute>
    (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 []GetDlRouteReportVirtualConnectionRouteRoute
    (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<GetDlRouteReportVirtualConnectionRouteRoute>
    (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 GetDlRouteReportVirtualConnectionRouteRoute[]
    (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[GetDlRouteReportVirtualConnectionRouteRoute]
    (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

    GetDlRouteReportVirtualConnectionRouteRoute

    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 logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud