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

ibm.DlRouteReport

Explore with Pulumi AI

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

    Provides a resource for ibm_dl_route_report. This allows to create and delete a route report for a directlink gateway. For more information, see about Direct Link Route Report.

    Example Usage

    In the following example, you can create Direct Link Route Report for dedicated gateway:

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const testDlRouters = ibm.getDlRouters({
        offeringType: "dedicated",
        locationName: "dal10",
    });
    const testDlGateway = new ibm.DlGateway("testDlGateway", {
        bgpAsn: 64999,
        global: true,
        metered: false,
        speedMbps: 1000,
        type: "dedicated",
        crossConnectRouter: testDlRouters.then(testDlRouters => testDlRouters.crossConnectRouters?.[0]?.routerName),
        locationName: testDlRouters.then(testDlRouters => testDlRouters.locationName),
        customerName: "Customer1",
        carrierName: "Carrier1",
    });
    const dlRouteReport = new ibm.DlRouteReport("dlRouteReport", {gateway: testDlGateway.dlGatewayId});
    
    import pulumi
    import pulumi_ibm as ibm
    
    test_dl_routers = ibm.get_dl_routers(offering_type="dedicated",
        location_name="dal10")
    test_dl_gateway = ibm.DlGateway("testDlGateway",
        bgp_asn=64999,
        global_=True,
        metered=False,
        speed_mbps=1000,
        type="dedicated",
        cross_connect_router=test_dl_routers.cross_connect_routers[0].router_name,
        location_name=test_dl_routers.location_name,
        customer_name="Customer1",
        carrier_name="Carrier1")
    dl_route_report = ibm.DlRouteReport("dlRouteReport", gateway=test_dl_gateway.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 {
    		testDlRouters, err := ibm.GetDlRouters(ctx, &ibm.GetDlRoutersArgs{
    			OfferingType: "dedicated",
    			LocationName: "dal10",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		testDlGateway, err := ibm.NewDlGateway(ctx, "testDlGateway", &ibm.DlGatewayArgs{
    			BgpAsn:             pulumi.Float64(64999),
    			Global:             pulumi.Bool(true),
    			Metered:            pulumi.Bool(false),
    			SpeedMbps:          pulumi.Float64(1000),
    			Type:               pulumi.String("dedicated"),
    			CrossConnectRouter: pulumi.String(testDlRouters.CrossConnectRouters[0].RouterName),
    			LocationName:       pulumi.String(testDlRouters.LocationName),
    			CustomerName:       pulumi.String("Customer1"),
    			CarrierName:        pulumi.String("Carrier1"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ibm.NewDlRouteReport(ctx, "dlRouteReport", &ibm.DlRouteReportArgs{
    			Gateway: testDlGateway.DlGatewayId,
    		})
    		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 testDlRouters = Ibm.GetDlRouters.Invoke(new()
        {
            OfferingType = "dedicated",
            LocationName = "dal10",
        });
    
        var testDlGateway = new Ibm.DlGateway("testDlGateway", new()
        {
            BgpAsn = 64999,
            Global = true,
            Metered = false,
            SpeedMbps = 1000,
            Type = "dedicated",
            CrossConnectRouter = testDlRouters.Apply(getDlRoutersResult => getDlRoutersResult.CrossConnectRouters[0]?.RouterName),
            LocationName = testDlRouters.Apply(getDlRoutersResult => getDlRoutersResult.LocationName),
            CustomerName = "Customer1",
            CarrierName = "Carrier1",
        });
    
        var dlRouteReport = new Ibm.DlRouteReport("dlRouteReport", new()
        {
            Gateway = testDlGateway.DlGatewayId,
        });
    
    });
    
    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.GetDlRoutersArgs;
    import com.pulumi.ibm.DlGateway;
    import com.pulumi.ibm.DlGatewayArgs;
    import com.pulumi.ibm.DlRouteReport;
    import com.pulumi.ibm.DlRouteReportArgs;
    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 testDlRouters = IbmFunctions.getDlRouters(GetDlRoutersArgs.builder()
                .offeringType("dedicated")
                .locationName("dal10")
                .build());
    
            var testDlGateway = new DlGateway("testDlGateway", DlGatewayArgs.builder()
                .bgpAsn(64999)
                .global(true)
                .metered(false)
                .speedMbps(1000)
                .type("dedicated")
                .crossConnectRouter(testDlRouters.applyValue(getDlRoutersResult -> getDlRoutersResult.crossConnectRouters()[0].routerName()))
                .locationName(testDlRouters.applyValue(getDlRoutersResult -> getDlRoutersResult.locationName()))
                .customerName("Customer1")
                .carrierName("Carrier1")
                .build());
    
            var dlRouteReport = new DlRouteReport("dlRouteReport", DlRouteReportArgs.builder()
                .gateway(testDlGateway.dlGatewayId())
                .build());
    
        }
    }
    
    resources:
      testDlGateway:
        type: ibm:DlGateway
        properties:
          bgpAsn: 64999
          global: true
          metered: false
          speedMbps: 1000
          type: dedicated
          crossConnectRouter: ${testDlRouters.crossConnectRouters[0].routerName}
          locationName: ${testDlRouters.locationName}
          customerName: Customer1
          carrierName: Carrier1
      dlRouteReport:
        type: ibm:DlRouteReport
        properties:
          gateway: ${testDlGateway.dlGatewayId}
    variables:
      testDlRouters:
        fn::invoke:
          function: ibm:getDlRouters
          arguments:
            offeringType: dedicated
            locationName: dal10
    

    In the following example, you can create Direct Link Route Report on connect gateway:

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const testDsDlPorts = ibm.getDlPorts({});
    const testDlConnect = new ibm.DlGateway("testDlConnect", {
        bgpAsn: 64999,
        global: true,
        metered: false,
        speedMbps: 1000,
        type: "connect",
        port: testDsDlPorts.then(testDsDlPorts => testDsDlPorts.ports?.[0]?.portId),
    });
    const dlRouteReport = new ibm.DlRouteReport("dlRouteReport", {gateway: ibm_dl_gateway.test_dl_gateway.id});
    
    import pulumi
    import pulumi_ibm as ibm
    
    test_ds_dl_ports = ibm.get_dl_ports()
    test_dl_connect = ibm.DlGateway("testDlConnect",
        bgp_asn=64999,
        global_=True,
        metered=False,
        speed_mbps=1000,
        type="connect",
        port=test_ds_dl_ports.ports[0].port_id)
    dl_route_report = ibm.DlRouteReport("dlRouteReport", 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 {
    		testDsDlPorts, err := ibm.GetDlPorts(ctx, &ibm.GetDlPortsArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = ibm.NewDlGateway(ctx, "testDlConnect", &ibm.DlGatewayArgs{
    			BgpAsn:    pulumi.Float64(64999),
    			Global:    pulumi.Bool(true),
    			Metered:   pulumi.Bool(false),
    			SpeedMbps: pulumi.Float64(1000),
    			Type:      pulumi.String("connect"),
    			Port:      pulumi.String(testDsDlPorts.Ports[0].PortId),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ibm.NewDlRouteReport(ctx, "dlRouteReport", &ibm.DlRouteReportArgs{
    			Gateway: pulumi.Any(ibm_dl_gateway.Test_dl_gateway.Id),
    		})
    		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 testDsDlPorts = Ibm.GetDlPorts.Invoke();
    
        var testDlConnect = new Ibm.DlGateway("testDlConnect", new()
        {
            BgpAsn = 64999,
            Global = true,
            Metered = false,
            SpeedMbps = 1000,
            Type = "connect",
            Port = testDsDlPorts.Apply(getDlPortsResult => getDlPortsResult.Ports[0]?.PortId),
        });
    
        var dlRouteReport = new Ibm.DlRouteReport("dlRouteReport", 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.GetDlPortsArgs;
    import com.pulumi.ibm.DlGateway;
    import com.pulumi.ibm.DlGatewayArgs;
    import com.pulumi.ibm.DlRouteReport;
    import com.pulumi.ibm.DlRouteReportArgs;
    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 testDsDlPorts = IbmFunctions.getDlPorts();
    
            var testDlConnect = new DlGateway("testDlConnect", DlGatewayArgs.builder()
                .bgpAsn(64999)
                .global(true)
                .metered(false)
                .speedMbps(1000)
                .type("connect")
                .port(testDsDlPorts.applyValue(getDlPortsResult -> getDlPortsResult.ports()[0].portId()))
                .build());
    
            var dlRouteReport = new DlRouteReport("dlRouteReport", DlRouteReportArgs.builder()
                .gateway(ibm_dl_gateway.test_dl_gateway().id())
                .build());
    
        }
    }
    
    resources:
      testDlConnect:
        type: ibm:DlGateway
        properties:
          bgpAsn: 64999
          global: true
          metered: false
          speedMbps: 1000
          type: connect
          port: ${testDsDlPorts.ports[0].portId}
      dlRouteReport:
        type: ibm:DlRouteReport
        properties:
          gateway: ${ibm_dl_gateway.test_dl_gateway.id}
    variables:
      testDsDlPorts:
        fn::invoke:
          function: ibm:getDlPorts
          arguments: {}
    

    Create DlRouteReport Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DlRouteReport(name: string, args: DlRouteReportArgs, opts?: CustomResourceOptions);
    @overload
    def DlRouteReport(resource_name: str,
                      args: DlRouteReportArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def DlRouteReport(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      gateway: Optional[str] = None,
                      dl_route_report_id: Optional[str] = None,
                      timeouts: Optional[DlRouteReportTimeoutsArgs] = None)
    func NewDlRouteReport(ctx *Context, name string, args DlRouteReportArgs, opts ...ResourceOption) (*DlRouteReport, error)
    public DlRouteReport(string name, DlRouteReportArgs args, CustomResourceOptions? opts = null)
    public DlRouteReport(String name, DlRouteReportArgs args)
    public DlRouteReport(String name, DlRouteReportArgs args, CustomResourceOptions options)
    
    type: ibm:DlRouteReport
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DlRouteReportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DlRouteReportArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DlRouteReportArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DlRouteReportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DlRouteReportArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var dlRouteReportResource = new Ibm.DlRouteReport("dlRouteReportResource", new()
    {
        Gateway = "string",
        DlRouteReportId = "string",
        Timeouts = new Ibm.Inputs.DlRouteReportTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
        },
    });
    
    example, err := ibm.NewDlRouteReport(ctx, "dlRouteReportResource", &ibm.DlRouteReportArgs{
    	Gateway:         pulumi.String("string"),
    	DlRouteReportId: pulumi.String("string"),
    	Timeouts: &ibm.DlRouteReportTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    	},
    })
    
    var dlRouteReportResource = new DlRouteReport("dlRouteReportResource", DlRouteReportArgs.builder()
        .gateway("string")
        .dlRouteReportId("string")
        .timeouts(DlRouteReportTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .build())
        .build());
    
    dl_route_report_resource = ibm.DlRouteReport("dlRouteReportResource",
        gateway="string",
        dl_route_report_id="string",
        timeouts={
            "create": "string",
            "delete": "string",
        })
    
    const dlRouteReportResource = new ibm.DlRouteReport("dlRouteReportResource", {
        gateway: "string",
        dlRouteReportId: "string",
        timeouts: {
            create: "string",
            "delete": "string",
        },
    });
    
    type: ibm:DlRouteReport
    properties:
        dlRouteReportId: string
        gateway: string
        timeouts:
            create: string
            delete: string
    

    DlRouteReport Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DlRouteReport resource accepts the following input properties:

    Gateway string
    Direct Link Gateway ID.
    DlRouteReportId string
    Timeouts DlRouteReportTimeouts
    Gateway string
    Direct Link Gateway ID.
    DlRouteReportId string
    Timeouts DlRouteReportTimeoutsArgs
    gateway String
    Direct Link Gateway ID.
    dlRouteReportId String
    timeouts DlRouteReportTimeouts
    gateway string
    Direct Link Gateway ID.
    dlRouteReportId string
    timeouts DlRouteReportTimeouts
    gateway String
    Direct Link Gateway ID.
    dlRouteReportId String
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DlRouteReport resource produces the following output properties:

    AdvertisedRoutes List<DlRouteReportAdvertisedRoute>
    (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<DlRouteReportGatewayRoute>
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    Id string
    The provider-assigned unique ID for this managed resource.
    OnPremRoutes List<DlRouteReportOnPremRoute>
    (List) List of on premises routes Nested scheme for on_prem_routes:
    OverlappingRoutes List<DlRouteReportOverlappingRoute>
    (List) List of overlapping routes. Nested scheme for overlapping_routes:
    RouteReportId string
    (String) The unique identifier of this route report.
    Status string
    (String) The route report status.
    UpdatedAt string
    (String) The date and time resource was updated.
    VirtualConnectionRoutes List<DlRouteReportVirtualConnectionRoute>
    (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes
    AdvertisedRoutes []DlRouteReportAdvertisedRoute
    (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 []DlRouteReportGatewayRoute
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    Id string
    The provider-assigned unique ID for this managed resource.
    OnPremRoutes []DlRouteReportOnPremRoute
    (List) List of on premises routes Nested scheme for on_prem_routes:
    OverlappingRoutes []DlRouteReportOverlappingRoute
    (List) List of overlapping routes. Nested scheme for overlapping_routes:
    RouteReportId string
    (String) The unique identifier of this route report.
    Status string
    (String) The route report status.
    UpdatedAt string
    (String) The date and time resource was updated.
    VirtualConnectionRoutes []DlRouteReportVirtualConnectionRoute
    (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes
    advertisedRoutes List<DlRouteReportAdvertisedRoute>
    (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<DlRouteReportGatewayRoute>
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    id String
    The provider-assigned unique ID for this managed resource.
    onPremRoutes List<DlRouteReportOnPremRoute>
    (List) List of on premises routes Nested scheme for on_prem_routes:
    overlappingRoutes List<DlRouteReportOverlappingRoute>
    (List) List of overlapping routes. Nested scheme for overlapping_routes:
    routeReportId String
    (String) The unique identifier of this route report.
    status String
    (String) The route report status.
    updatedAt String
    (String) The date and time resource was updated.
    virtualConnectionRoutes List<DlRouteReportVirtualConnectionRoute>
    (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes
    advertisedRoutes DlRouteReportAdvertisedRoute[]
    (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 DlRouteReportGatewayRoute[]
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    id string
    The provider-assigned unique ID for this managed resource.
    onPremRoutes DlRouteReportOnPremRoute[]
    (List) List of on premises routes Nested scheme for on_prem_routes:
    overlappingRoutes DlRouteReportOverlappingRoute[]
    (List) List of overlapping routes. Nested scheme for overlapping_routes:
    routeReportId string
    (String) The unique identifier of this route report.
    status string
    (String) The route report status.
    updatedAt string
    (String) The date and time resource was updated.
    virtualConnectionRoutes DlRouteReportVirtualConnectionRoute[]
    (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes
    advertised_routes Sequence[DlRouteReportAdvertisedRoute]
    (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[DlRouteReportGatewayRoute]
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    id str
    The provider-assigned unique ID for this managed resource.
    on_prem_routes Sequence[DlRouteReportOnPremRoute]
    (List) List of on premises routes Nested scheme for on_prem_routes:
    overlapping_routes Sequence[DlRouteReportOverlappingRoute]
    (List) List of overlapping routes. Nested scheme for overlapping_routes:
    route_report_id str
    (String) The unique identifier of this route report.
    status str
    (String) The route report status.
    updated_at str
    (String) The date and time resource was updated.
    virtual_connection_routes Sequence[DlRouteReportVirtualConnectionRoute]
    (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
    The provider-assigned unique ID for this managed resource.
    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:
    routeReportId String
    (String) The unique identifier of this route report.
    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

    Look up Existing DlRouteReport Resource

    Get an existing DlRouteReport resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DlRouteReportState, opts?: CustomResourceOptions): DlRouteReport
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            advertised_routes: Optional[Sequence[DlRouteReportAdvertisedRouteArgs]] = None,
            created_at: Optional[str] = None,
            dl_route_report_id: Optional[str] = None,
            gateway: Optional[str] = None,
            gateway_routes: Optional[Sequence[DlRouteReportGatewayRouteArgs]] = None,
            on_prem_routes: Optional[Sequence[DlRouteReportOnPremRouteArgs]] = None,
            overlapping_routes: Optional[Sequence[DlRouteReportOverlappingRouteArgs]] = None,
            route_report_id: Optional[str] = None,
            status: Optional[str] = None,
            timeouts: Optional[DlRouteReportTimeoutsArgs] = None,
            updated_at: Optional[str] = None,
            virtual_connection_routes: Optional[Sequence[DlRouteReportVirtualConnectionRouteArgs]] = None) -> DlRouteReport
    func GetDlRouteReport(ctx *Context, name string, id IDInput, state *DlRouteReportState, opts ...ResourceOption) (*DlRouteReport, error)
    public static DlRouteReport Get(string name, Input<string> id, DlRouteReportState? state, CustomResourceOptions? opts = null)
    public static DlRouteReport get(String name, Output<String> id, DlRouteReportState state, CustomResourceOptions options)
    resources:  _:    type: ibm:DlRouteReport    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdvertisedRoutes List<DlRouteReportAdvertisedRoute>
    (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.
    DlRouteReportId string
    Gateway string
    Direct Link Gateway ID.
    GatewayRoutes List<DlRouteReportGatewayRoute>
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    OnPremRoutes List<DlRouteReportOnPremRoute>
    (List) List of on premises routes Nested scheme for on_prem_routes:
    OverlappingRoutes List<DlRouteReportOverlappingRoute>
    (List) List of overlapping routes. Nested scheme for overlapping_routes:
    RouteReportId string
    (String) The unique identifier of this route report.
    Status string
    (String) The route report status.
    Timeouts DlRouteReportTimeouts
    UpdatedAt string
    (String) The date and time resource was updated.
    VirtualConnectionRoutes List<DlRouteReportVirtualConnectionRoute>
    (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes
    AdvertisedRoutes []DlRouteReportAdvertisedRouteArgs
    (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.
    DlRouteReportId string
    Gateway string
    Direct Link Gateway ID.
    GatewayRoutes []DlRouteReportGatewayRouteArgs
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    OnPremRoutes []DlRouteReportOnPremRouteArgs
    (List) List of on premises routes Nested scheme for on_prem_routes:
    OverlappingRoutes []DlRouteReportOverlappingRouteArgs
    (List) List of overlapping routes. Nested scheme for overlapping_routes:
    RouteReportId string
    (String) The unique identifier of this route report.
    Status string
    (String) The route report status.
    Timeouts DlRouteReportTimeoutsArgs
    UpdatedAt string
    (String) The date and time resource was updated.
    VirtualConnectionRoutes []DlRouteReportVirtualConnectionRouteArgs
    (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes
    advertisedRoutes List<DlRouteReportAdvertisedRoute>
    (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.
    dlRouteReportId String
    gateway String
    Direct Link Gateway ID.
    gatewayRoutes List<DlRouteReportGatewayRoute>
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    onPremRoutes List<DlRouteReportOnPremRoute>
    (List) List of on premises routes Nested scheme for on_prem_routes:
    overlappingRoutes List<DlRouteReportOverlappingRoute>
    (List) List of overlapping routes. Nested scheme for overlapping_routes:
    routeReportId String
    (String) The unique identifier of this route report.
    status String
    (String) The route report status.
    timeouts DlRouteReportTimeouts
    updatedAt String
    (String) The date and time resource was updated.
    virtualConnectionRoutes List<DlRouteReportVirtualConnectionRoute>
    (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes
    advertisedRoutes DlRouteReportAdvertisedRoute[]
    (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.
    dlRouteReportId string
    gateway string
    Direct Link Gateway ID.
    gatewayRoutes DlRouteReportGatewayRoute[]
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    onPremRoutes DlRouteReportOnPremRoute[]
    (List) List of on premises routes Nested scheme for on_prem_routes:
    overlappingRoutes DlRouteReportOverlappingRoute[]
    (List) List of overlapping routes. Nested scheme for overlapping_routes:
    routeReportId string
    (String) The unique identifier of this route report.
    status string
    (String) The route report status.
    timeouts DlRouteReportTimeouts
    updatedAt string
    (String) The date and time resource was updated.
    virtualConnectionRoutes DlRouteReportVirtualConnectionRoute[]
    (List) List of routes on virtual connections. Nested scheme for virtual_connection_routes
    advertised_routes Sequence[DlRouteReportAdvertisedRouteArgs]
    (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.
    dl_route_report_id str
    gateway str
    Direct Link Gateway ID.
    gateway_routes Sequence[DlRouteReportGatewayRouteArgs]
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    on_prem_routes Sequence[DlRouteReportOnPremRouteArgs]
    (List) List of on premises routes Nested scheme for on_prem_routes:
    overlapping_routes Sequence[DlRouteReportOverlappingRouteArgs]
    (List) List of overlapping routes. Nested scheme for overlapping_routes:
    route_report_id str
    (String) The unique identifier of this route report.
    status str
    (String) The route report status.
    timeouts DlRouteReportTimeoutsArgs
    updated_at str
    (String) The date and time resource was updated.
    virtual_connection_routes Sequence[DlRouteReportVirtualConnectionRouteArgs]
    (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.
    dlRouteReportId String
    gateway String
    Direct Link Gateway ID.
    gatewayRoutes List<Property Map>
    (List) List of local/direct routes. Nested scheme for gateway_routes:
    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:
    routeReportId String
    (String) The unique identifier of this route report.
    status String
    (String) The route report status.
    timeouts Property Map
    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

    DlRouteReportAdvertisedRoute, DlRouteReportAdvertisedRouteArgs

    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.

    DlRouteReportGatewayRoute, DlRouteReportGatewayRouteArgs

    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.

    DlRouteReportOnPremRoute, DlRouteReportOnPremRouteArgs

    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.

    DlRouteReportOverlappingRoute, DlRouteReportOverlappingRouteArgs

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

    DlRouteReportOverlappingRouteRoute, DlRouteReportOverlappingRouteRouteArgs

    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

    DlRouteReportTimeouts, DlRouteReportTimeoutsArgs

    Create string
    Delete string
    Create string
    Delete string
    create String
    delete String
    create string
    delete string
    create str
    delete str
    create String
    delete String

    DlRouteReportVirtualConnectionRoute, DlRouteReportVirtualConnectionRouteArgs

    Routes List<DlRouteReportVirtualConnectionRouteRoute>
    (List) List of 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 []DlRouteReportVirtualConnectionRouteRoute
    (List) List of 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<DlRouteReportVirtualConnectionRouteRoute>
    (List) List of 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 DlRouteReportVirtualConnectionRouteRoute[]
    (List) List of 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[DlRouteReportVirtualConnectionRouteRoute]
    (List) List of 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 connection routes. Nested scheme for routes:
    virtualConnectionId String
    (String) Virtual Connection ID
    virtualConnectionName String
    (String) Virtual Connection name
    virtualConnectionType String
    (String) Virtual Connection type

    DlRouteReportVirtualConnectionRouteRoute, DlRouteReportVirtualConnectionRouteRouteArgs

    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.

    Import

    You can import the ibm_dl_route_report resource by using id.

    The id property can be formed from gateway and route_report_id in the following format:

    /<route_report_id>

    • gateway: A String. The unique identifier of a directlink gateway.

    • route_report_id: A String. The unique identifier of the route report.

    $ pulumi import ibm:index/dlRouteReport:DlRouteReport dl_route_report <gateway>/<route_report_id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    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