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

ibm.getDlRouters

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 IBM Cloud infrastructure Direct Link Location specific cross connect router information. For more information, about Direct Link cross connect router, see virtual routing and forwarding on IBM Cloud.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const testDlRouters = ibm.getDlRouters({
        locationName: "dal09",
        offeringType: "dedicated",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    test_dl_routers = ibm.get_dl_routers(location_name="dal09",
        offering_type="dedicated")
    
    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.GetDlRouters(ctx, &ibm.GetDlRoutersArgs{
    			LocationName: "dal09",
    			OfferingType: "dedicated",
    		}, 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 testDlRouters = Ibm.GetDlRouters.Invoke(new()
        {
            LocationName = "dal09",
            OfferingType = "dedicated",
        });
    
    });
    
    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 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()
                .locationName("dal09")
                .offeringType("dedicated")
                .build());
    
        }
    }
    
    variables:
      testDlRouters:
        fn::invoke:
          function: ibm:getDlRouters
          arguments:
            locationName: dal09
            offeringType: dedicated
    

    Using getDlRouters

    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 getDlRouters(args: GetDlRoutersArgs, opts?: InvokeOptions): Promise<GetDlRoutersResult>
    function getDlRoutersOutput(args: GetDlRoutersOutputArgs, opts?: InvokeOptions): Output<GetDlRoutersResult>
    def get_dl_routers(id: Optional[str] = None,
                       location_name: Optional[str] = None,
                       offering_type: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDlRoutersResult
    def get_dl_routers_output(id: Optional[pulumi.Input[str]] = None,
                       location_name: Optional[pulumi.Input[str]] = None,
                       offering_type: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetDlRoutersResult]
    func GetDlRouters(ctx *Context, args *GetDlRoutersArgs, opts ...InvokeOption) (*GetDlRoutersResult, error)
    func GetDlRoutersOutput(ctx *Context, args *GetDlRoutersOutputArgs, opts ...InvokeOption) GetDlRoutersResultOutput

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

    public static class GetDlRouters 
    {
        public static Task<GetDlRoutersResult> InvokeAsync(GetDlRoutersArgs args, InvokeOptions? opts = null)
        public static Output<GetDlRoutersResult> Invoke(GetDlRoutersInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDlRoutersResult> getDlRouters(GetDlRoutersArgs args, InvokeOptions options)
    public static Output<GetDlRoutersResult> getDlRouters(GetDlRoutersArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getDlRouters:getDlRouters
      arguments:
        # arguments dictionary

    The following arguments are supported:

    LocationName string
    The name of the Direct Link Location.
    OfferingType string
    The Direct Link offering type. Only dedicated is supported in this API.
    Id string
    LocationName string
    The name of the Direct Link Location.
    OfferingType string
    The Direct Link offering type. Only dedicated is supported in this API.
    Id string
    locationName String
    The name of the Direct Link Location.
    offeringType String
    The Direct Link offering type. Only dedicated is supported in this API.
    id String
    locationName string
    The name of the Direct Link Location.
    offeringType string
    The Direct Link offering type. Only dedicated is supported in this API.
    id string
    location_name str
    The name of the Direct Link Location.
    offering_type str
    The Direct Link offering type. Only dedicated is supported in this API.
    id str
    locationName String
    The name of the Direct Link Location.
    offeringType String
    The Direct Link offering type. Only dedicated is supported in this API.
    id String

    getDlRouters Result

    The following output properties are available:

    CrossConnectRouters List<GetDlRoutersCrossConnectRouter>
    (List) List of all the cross connect router details.
    Id string
    LocationName string
    OfferingType string
    CrossConnectRouters []GetDlRoutersCrossConnectRouter
    (List) List of all the cross connect router details.
    Id string
    LocationName string
    OfferingType string
    crossConnectRouters List<GetDlRoutersCrossConnectRouter>
    (List) List of all the cross connect router details.
    id String
    locationName String
    offeringType String
    crossConnectRouters GetDlRoutersCrossConnectRouter[]
    (List) List of all the cross connect router details.
    id string
    locationName string
    offeringType string
    cross_connect_routers Sequence[GetDlRoutersCrossConnectRouter]
    (List) List of all the cross connect router details.
    id str
    location_name str
    offering_type str
    crossConnectRouters List<Property Map>
    (List) List of all the cross connect router details.
    id String
    locationName String
    offeringType String

    Supporting Types

    GetDlRoutersCrossConnectRouter

    Capabilities List<string>
    (String) Macsec and non-macsec capabilities for the router.
    RouterName string
    (String) The name of the router.
    TotalConnections double
    (String) Count of existing Direct Link dedicated gateways on this router account.
    Capabilities []string
    (String) Macsec and non-macsec capabilities for the router.
    RouterName string
    (String) The name of the router.
    TotalConnections float64
    (String) Count of existing Direct Link dedicated gateways on this router account.
    capabilities List<String>
    (String) Macsec and non-macsec capabilities for the router.
    routerName String
    (String) The name of the router.
    totalConnections Double
    (String) Count of existing Direct Link dedicated gateways on this router account.
    capabilities string[]
    (String) Macsec and non-macsec capabilities for the router.
    routerName string
    (String) The name of the router.
    totalConnections number
    (String) Count of existing Direct Link dedicated gateways on this router account.
    capabilities Sequence[str]
    (String) Macsec and non-macsec capabilities for the router.
    router_name str
    (String) The name of the router.
    total_connections float
    (String) Count of existing Direct Link dedicated gateways on this router account.
    capabilities List<String>
    (String) Macsec and non-macsec capabilities for the router.
    routerName String
    (String) The name of the router.
    totalConnections Number
    (String) Count of existing Direct Link dedicated gateways on this router account.

    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