ibm.getDlGateways

Explore with Pulumi AI

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

Example Usage

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

const dsDlgateways = ibm.getDlGateways({});

import pulumi
import pulumi_ibm as ibm

ds_dlgateways = ibm.get_dl_gateways()

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.GetDlGateways(ctx, &ibm.GetDlGatewaysArgs{}, 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 dsDlgateways = Ibm.GetDlGateways.Invoke();

});

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.GetDlGatewaysArgs;
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 dsDlgateways = IbmFunctions.getDlGateways();

    }
}

variables:
  dsDlgateways:
    fn::invoke:
      function: ibm:getDlGateways
      arguments: {}

Using getDlGateways

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 getDlGateways(args: GetDlGatewaysArgs, opts?: InvokeOptions): Promise<GetDlGatewaysResult>
function getDlGatewaysOutput(args: GetDlGatewaysOutputArgs, opts?: InvokeOptions): Output<GetDlGatewaysResult>

def get_dl_gateways(id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDlGatewaysResult
def get_dl_gateways_output(id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDlGatewaysResult]

func GetDlGateways(ctx *Context, args *GetDlGatewaysArgs, opts ...InvokeOption) (*GetDlGatewaysResult, error)
func GetDlGatewaysOutput(ctx *Context, args *GetDlGatewaysOutputArgs, opts ...InvokeOption) GetDlGatewaysResultOutput

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

public static class GetDlGateways 
{
    public static Task<GetDlGatewaysResult> InvokeAsync(GetDlGatewaysArgs args, InvokeOptions? opts = null)
    public static Output<GetDlGatewaysResult> Invoke(GetDlGatewaysInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDlGatewaysResult> getDlGateways(GetDlGatewaysArgs args, InvokeOptions options)
public static Output<GetDlGatewaysResult> getDlGateways(GetDlGatewaysArgs args, InvokeOptions options)

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

The following arguments are supported:

Id string: (String) The unique identifier of the gateway.

Id string: (String) The unique identifier of the gateway.

id String: (String) The unique identifier of the gateway.

id string: (String) The unique identifier of the gateway.

id str: (String) The unique identifier of the gateway.

id String: (String) The unique identifier of the gateway.

getDlGateways Result

The following output properties are available:

Gateways List<GetDlGatewaysGateway>: (String) List of all the Direct Link Gateways in the IBM Cloud infrastructure.
Id string: (String) The unique identifier of the gateway.

Gateways []GetDlGatewaysGateway: (String) List of all the Direct Link Gateways in the IBM Cloud infrastructure.
Id string: (String) The unique identifier of the gateway.

gateways List<GetDlGatewaysGateway>: (String) List of all the Direct Link Gateways in the IBM Cloud infrastructure.
id String: (String) The unique identifier of the gateway.

gateways GetDlGatewaysGateway[]: (String) List of all the Direct Link Gateways in the IBM Cloud infrastructure.
id string: (String) The unique identifier of the gateway.

gateways Sequence[GetDlGatewaysGateway]: (String) List of all the Direct Link Gateways in the IBM Cloud infrastructure.
id str: (String) The unique identifier of the gateway.

gateways List<Property Map>: (String) List of all the Direct Link Gateways in the IBM Cloud infrastructure.
id String: (String) The unique identifier of the gateway.

Supporting Types

GetDlGatewaysGateway

AsPrepends List<GetDlGatewaysGatewayAsPrepend>: (List) List of AS Prepend configuration information Nested scheme for as_prepend:
AuthenticationKey string: (String) BGP MD5 authentication key.
BfdInterval double: (String) Minimum interval in milliseconds at which the local routing device transmits hello packets and then expects to receive a reply from a neighbor with which it has established a BFD session.
BfdMultiplier double: (String) The number of hello packets not received by a neighbor that causes the originating interface to be declared down.
BfdStatus string: (String) Gateway BFD status.
BfdStatusUpdatedAt string: (String) Date and time bfd status was updated.
BgpAsn double: (String) Customer BGP ASN.
BgpBaseCidr string: (String) The BGP base CIDR.
BgpCerCidr string: (String) The BGP customer edge router CIDR.
BgpIbmAsn double: (String) The IBM BGP ASN.
BgpIbmCidr string: (String) The IBM BGP CIDR.
BgpStatus string: (String) The gateway BGP status.
BgpStatusUpdatedAt string: (String) Date and time bgp status was updated.
ChangeRequest string
CompletionNoticeRejectReason string: (String) The reason for completion notice rejection. Only included on a dedicated gateways type with a rejected completion notice.
ConnectionMode string: (String) Type of network connection that you want to bind to your direct link.
CreatedAt string: (String) The date and time resource is created.
Crn string: (String) The CRN of the gateway.
CrossConnectRouter string: (String) The cross connect router. Only included on a dedicated gateways type..
DefaultExportRouteFilter string: (String) The default directional route filter action that applies to routes that do not match any directional route filters.
DefaultImportRouteFilter string: (String) The default directional route filter action that applies to routes that do not match any directional route filters.
Global bool: (Bool) Gateway with global routing as true can connect networks outside your associated region.
Id string: (String) The unique identifier of the gateway.
LinkStatus string: (String) The gateway link status. Only included on a dedicated gateways type.
LinkStatusUpdatedAt string: (String) Date and time link status was updated.
LocationDisplayName string: (String) Long name of the gateway location.
LocationName string: (String) The location name of the gateway.
MacsecConfigs List<GetDlGatewaysGatewayMacsecConfig>
Metered bool: (String) Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
Name string: (String) The unique user defined name of the gateway.
OperationalStatus string: (String) The gateway operational status.
Port string: (Integer) The port identifier.
ProviderApiManaged bool: (Bool) Indicates the gateway is created through a provider portal. If set true, gateway can only be changed. If set false, gateway is deleted through the corresponding provider portal.
ResourceGroup string: (String) The resource group identifier.
SpeedMbps double: (String) The gateway speed in MBPS.
Type string: (String) The gateway type.
Vlan double: (String) The VLAN allocated for the gateway.

AsPrepends []GetDlGatewaysGatewayAsPrepend: (List) List of AS Prepend configuration information Nested scheme for as_prepend:
AuthenticationKey string: (String) BGP MD5 authentication key.
BfdInterval float64: (String) Minimum interval in milliseconds at which the local routing device transmits hello packets and then expects to receive a reply from a neighbor with which it has established a BFD session.
BfdMultiplier float64: (String) The number of hello packets not received by a neighbor that causes the originating interface to be declared down.
BfdStatus string: (String) Gateway BFD status.
BfdStatusUpdatedAt string: (String) Date and time bfd status was updated.
BgpAsn float64: (String) Customer BGP ASN.
BgpBaseCidr string: (String) The BGP base CIDR.
BgpCerCidr string: (String) The BGP customer edge router CIDR.
BgpIbmAsn float64: (String) The IBM BGP ASN.
BgpIbmCidr string: (String) The IBM BGP CIDR.
BgpStatus string: (String) The gateway BGP status.
BgpStatusUpdatedAt string: (String) Date and time bgp status was updated.
ChangeRequest string
CompletionNoticeRejectReason string: (String) The reason for completion notice rejection. Only included on a dedicated gateways type with a rejected completion notice.
ConnectionMode string: (String) Type of network connection that you want to bind to your direct link.
CreatedAt string: (String) The date and time resource is created.
Crn string: (String) The CRN of the gateway.
CrossConnectRouter string: (String) The cross connect router. Only included on a dedicated gateways type..
DefaultExportRouteFilter string: (String) The default directional route filter action that applies to routes that do not match any directional route filters.
DefaultImportRouteFilter string: (String) The default directional route filter action that applies to routes that do not match any directional route filters.
Global bool: (Bool) Gateway with global routing as true can connect networks outside your associated region.
Id string: (String) The unique identifier of the gateway.
LinkStatus string: (String) The gateway link status. Only included on a dedicated gateways type.
LinkStatusUpdatedAt string: (String) Date and time link status was updated.
LocationDisplayName string: (String) Long name of the gateway location.
LocationName string: (String) The location name of the gateway.
MacsecConfigs []GetDlGatewaysGatewayMacsecConfig
Metered bool: (String) Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
Name string: (String) The unique user defined name of the gateway.
OperationalStatus string: (String) The gateway operational status.
Port string: (Integer) The port identifier.
ProviderApiManaged bool: (Bool) Indicates the gateway is created through a provider portal. If set true, gateway can only be changed. If set false, gateway is deleted through the corresponding provider portal.
ResourceGroup string: (String) The resource group identifier.
SpeedMbps float64: (String) The gateway speed in MBPS.
Type string: (String) The gateway type.
Vlan float64: (String) The VLAN allocated for the gateway.

asPrepends List<GetDlGatewaysGatewayAsPrepend>: (List) List of AS Prepend configuration information Nested scheme for as_prepend:
authenticationKey String: (String) BGP MD5 authentication key.
bfdInterval Double: (String) Minimum interval in milliseconds at which the local routing device transmits hello packets and then expects to receive a reply from a neighbor with which it has established a BFD session.
bfdMultiplier Double: (String) The number of hello packets not received by a neighbor that causes the originating interface to be declared down.
bfdStatus String: (String) Gateway BFD status.
bfdStatusUpdatedAt String: (String) Date and time bfd status was updated.
bgpAsn Double: (String) Customer BGP ASN.
bgpBaseCidr String: (String) The BGP base CIDR.
bgpCerCidr String: (String) The BGP customer edge router CIDR.
bgpIbmAsn Double: (String) The IBM BGP ASN.
bgpIbmCidr String: (String) The IBM BGP CIDR.
bgpStatus String: (String) The gateway BGP status.
bgpStatusUpdatedAt String: (String) Date and time bgp status was updated.
changeRequest String
completionNoticeRejectReason String: (String) The reason for completion notice rejection. Only included on a dedicated gateways type with a rejected completion notice.
connectionMode String: (String) Type of network connection that you want to bind to your direct link.
createdAt String: (String) The date and time resource is created.
crn String: (String) The CRN of the gateway.
crossConnectRouter String: (String) The cross connect router. Only included on a dedicated gateways type..
defaultExportRouteFilter String: (String) The default directional route filter action that applies to routes that do not match any directional route filters.
defaultImportRouteFilter String: (String) The default directional route filter action that applies to routes that do not match any directional route filters.
global Boolean: (Bool) Gateway with global routing as true can connect networks outside your associated region.
id String: (String) The unique identifier of the gateway.
linkStatus String: (String) The gateway link status. Only included on a dedicated gateways type.
linkStatusUpdatedAt String: (String) Date and time link status was updated.
locationDisplayName String: (String) Long name of the gateway location.
locationName String: (String) The location name of the gateway.
macsecConfigs List<GetDlGatewaysGatewayMacsecConfig>
metered Boolean: (String) Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
name String: (String) The unique user defined name of the gateway.
operationalStatus String: (String) The gateway operational status.
port String: (Integer) The port identifier.
providerApiManaged Boolean: (Bool) Indicates the gateway is created through a provider portal. If set true, gateway can only be changed. If set false, gateway is deleted through the corresponding provider portal.
resourceGroup String: (String) The resource group identifier.
speedMbps Double: (String) The gateway speed in MBPS.
type String: (String) The gateway type.
vlan Double: (String) The VLAN allocated for the gateway.

asPrepends GetDlGatewaysGatewayAsPrepend[]: (List) List of AS Prepend configuration information Nested scheme for as_prepend:
authenticationKey string: (String) BGP MD5 authentication key.
bfdInterval number: (String) Minimum interval in milliseconds at which the local routing device transmits hello packets and then expects to receive a reply from a neighbor with which it has established a BFD session.
bfdMultiplier number: (String) The number of hello packets not received by a neighbor that causes the originating interface to be declared down.
bfdStatus string: (String) Gateway BFD status.
bfdStatusUpdatedAt string: (String) Date and time bfd status was updated.
bgpAsn number: (String) Customer BGP ASN.
bgpBaseCidr string: (String) The BGP base CIDR.
bgpCerCidr string: (String) The BGP customer edge router CIDR.
bgpIbmAsn number: (String) The IBM BGP ASN.
bgpIbmCidr string: (String) The IBM BGP CIDR.
bgpStatus string: (String) The gateway BGP status.
bgpStatusUpdatedAt string: (String) Date and time bgp status was updated.
changeRequest string
completionNoticeRejectReason string: (String) The reason for completion notice rejection. Only included on a dedicated gateways type with a rejected completion notice.
connectionMode string: (String) Type of network connection that you want to bind to your direct link.
createdAt string: (String) The date and time resource is created.
crn string: (String) The CRN of the gateway.
crossConnectRouter string: (String) The cross connect router. Only included on a dedicated gateways type..
defaultExportRouteFilter string: (String) The default directional route filter action that applies to routes that do not match any directional route filters.
defaultImportRouteFilter string: (String) The default directional route filter action that applies to routes that do not match any directional route filters.
global boolean: (Bool) Gateway with global routing as true can connect networks outside your associated region.
id string: (String) The unique identifier of the gateway.
linkStatus string: (String) The gateway link status. Only included on a dedicated gateways type.
linkStatusUpdatedAt string: (String) Date and time link status was updated.
locationDisplayName string: (String) Long name of the gateway location.
locationName string: (String) The location name of the gateway.
macsecConfigs GetDlGatewaysGatewayMacsecConfig[]
metered boolean: (String) Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
name string: (String) The unique user defined name of the gateway.
operationalStatus string: (String) The gateway operational status.
port string: (Integer) The port identifier.
providerApiManaged boolean: (Bool) Indicates the gateway is created through a provider portal. If set true, gateway can only be changed. If set false, gateway is deleted through the corresponding provider portal.
resourceGroup string: (String) The resource group identifier.
speedMbps number: (String) The gateway speed in MBPS.
type string: (String) The gateway type.
vlan number: (String) The VLAN allocated for the gateway.

as_prepends Sequence[GetDlGatewaysGatewayAsPrepend]: (List) List of AS Prepend configuration information Nested scheme for as_prepend:
authentication_key str: (String) BGP MD5 authentication key.
bfd_interval float: (String) Minimum interval in milliseconds at which the local routing device transmits hello packets and then expects to receive a reply from a neighbor with which it has established a BFD session.
bfd_multiplier float: (String) The number of hello packets not received by a neighbor that causes the originating interface to be declared down.
bfd_status str: (String) Gateway BFD status.
bfd_status_updated_at str: (String) Date and time bfd status was updated.
bgp_asn float: (String) Customer BGP ASN.
bgp_base_cidr str: (String) The BGP base CIDR.
bgp_cer_cidr str: (String) The BGP customer edge router CIDR.
bgp_ibm_asn float: (String) The IBM BGP ASN.
bgp_ibm_cidr str: (String) The IBM BGP CIDR.
bgp_status str: (String) The gateway BGP status.
bgp_status_updated_at str: (String) Date and time bgp status was updated.
change_request str
completion_notice_reject_reason str: (String) The reason for completion notice rejection. Only included on a dedicated gateways type with a rejected completion notice.
connection_mode str: (String) Type of network connection that you want to bind to your direct link.
created_at str: (String) The date and time resource is created.
crn str: (String) The CRN of the gateway.
cross_connect_router str: (String) The cross connect router. Only included on a dedicated gateways type..
default_export_route_filter str: (String) The default directional route filter action that applies to routes that do not match any directional route filters.
default_import_route_filter str: (String) The default directional route filter action that applies to routes that do not match any directional route filters.
global_ bool: (Bool) Gateway with global routing as true can connect networks outside your associated region.
id str: (String) The unique identifier of the gateway.
link_status str: (String) The gateway link status. Only included on a dedicated gateways type.
link_status_updated_at str: (String) Date and time link status was updated.
location_display_name str: (String) Long name of the gateway location.
location_name str: (String) The location name of the gateway.
macsec_configs Sequence[GetDlGatewaysGatewayMacsecConfig]
metered bool: (String) Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
name str: (String) The unique user defined name of the gateway.
operational_status str: (String) The gateway operational status.
port str: (Integer) The port identifier.
provider_api_managed bool: (Bool) Indicates the gateway is created through a provider portal. If set true, gateway can only be changed. If set false, gateway is deleted through the corresponding provider portal.
resource_group str: (String) The resource group identifier.
speed_mbps float: (String) The gateway speed in MBPS.
type str: (String) The gateway type.
vlan float: (String) The VLAN allocated for the gateway.

asPrepends List<Property Map>: (List) List of AS Prepend configuration information Nested scheme for as_prepend:
authenticationKey String: (String) BGP MD5 authentication key.
bfdInterval Number: (String) Minimum interval in milliseconds at which the local routing device transmits hello packets and then expects to receive a reply from a neighbor with which it has established a BFD session.
bfdMultiplier Number: (String) The number of hello packets not received by a neighbor that causes the originating interface to be declared down.
bfdStatus String: (String) Gateway BFD status.
bfdStatusUpdatedAt String: (String) Date and time bfd status was updated.
bgpAsn Number: (String) Customer BGP ASN.
bgpBaseCidr String: (String) The BGP base CIDR.
bgpCerCidr String: (String) The BGP customer edge router CIDR.
bgpIbmAsn Number: (String) The IBM BGP ASN.
bgpIbmCidr String: (String) The IBM BGP CIDR.
bgpStatus String: (String) The gateway BGP status.
bgpStatusUpdatedAt String: (String) Date and time bgp status was updated.
changeRequest String
completionNoticeRejectReason String: (String) The reason for completion notice rejection. Only included on a dedicated gateways type with a rejected completion notice.
connectionMode String: (String) Type of network connection that you want to bind to your direct link.
createdAt String: (String) The date and time resource is created.
crn String: (String) The CRN of the gateway.
crossConnectRouter String: (String) The cross connect router. Only included on a dedicated gateways type..
defaultExportRouteFilter String: (String) The default directional route filter action that applies to routes that do not match any directional route filters.
defaultImportRouteFilter String: (String) The default directional route filter action that applies to routes that do not match any directional route filters.
global Boolean: (Bool) Gateway with global routing as true can connect networks outside your associated region.
id String: (String) The unique identifier of the gateway.
linkStatus String: (String) The gateway link status. Only included on a dedicated gateways type.
linkStatusUpdatedAt String: (String) Date and time link status was updated.
locationDisplayName String: (String) Long name of the gateway location.
locationName String: (String) The location name of the gateway.
macsecConfigs List<Property Map>
metered Boolean: (String) Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
name String: (String) The unique user defined name of the gateway.
operationalStatus String: (String) The gateway operational status.
port String: (Integer) The port identifier.
providerApiManaged Boolean: (Bool) Indicates the gateway is created through a provider portal. If set true, gateway can only be changed. If set false, gateway is deleted through the corresponding provider portal.
resourceGroup String: (String) The resource group identifier.
speedMbps Number: (String) The gateway speed in MBPS.
type String: (String) The gateway type.
vlan Number: (String) The VLAN allocated for the gateway.

GetDlGatewaysGatewayAsPrepend

CreatedAt string: (String) The date and time resource is created.
Id string: (String) The unique identifier of the gateway.
Length double: (Integer) Number of times the ASN to appended to the AS Path.
Policy string: (String) Route type this AS Prepend applies to. Possible values are import and export.
Prefix string: (Deprecated, String) Comma separated list of prefixes this AS Prepend applies to. Maximum of 10 prefixes. If not specified, this AS Prepend applies to all prefixes.
SpecificPrefixes List<string>: (Array of Strings) Array of prefixes this AS Prepend applies to.
UpdatedAt string: (String) The date and time AS Prepend was updated

CreatedAt string: (String) The date and time resource is created.
Id string: (String) The unique identifier of the gateway.
Length float64: (Integer) Number of times the ASN to appended to the AS Path.
Policy string: (String) Route type this AS Prepend applies to. Possible values are import and export.
Prefix string: (Deprecated, String) Comma separated list of prefixes this AS Prepend applies to. Maximum of 10 prefixes. If not specified, this AS Prepend applies to all prefixes.
SpecificPrefixes []string: (Array of Strings) Array of prefixes this AS Prepend applies to.
UpdatedAt string: (String) The date and time AS Prepend was updated

createdAt String: (String) The date and time resource is created.
id String: (String) The unique identifier of the gateway.
length Double: (Integer) Number of times the ASN to appended to the AS Path.
policy String: (String) Route type this AS Prepend applies to. Possible values are import and export.
prefix String: (Deprecated, String) Comma separated list of prefixes this AS Prepend applies to. Maximum of 10 prefixes. If not specified, this AS Prepend applies to all prefixes.
specificPrefixes List<String>: (Array of Strings) Array of prefixes this AS Prepend applies to.
updatedAt String: (String) The date and time AS Prepend was updated

createdAt string: (String) The date and time resource is created.
id string: (String) The unique identifier of the gateway.
length number: (Integer) Number of times the ASN to appended to the AS Path.
policy string: (String) Route type this AS Prepend applies to. Possible values are import and export.
prefix string: (Deprecated, String) Comma separated list of prefixes this AS Prepend applies to. Maximum of 10 prefixes. If not specified, this AS Prepend applies to all prefixes.
specificPrefixes string[]: (Array of Strings) Array of prefixes this AS Prepend applies to.
updatedAt string: (String) The date and time AS Prepend was updated

created_at str: (String) The date and time resource is created.
id str: (String) The unique identifier of the gateway.
length float: (Integer) Number of times the ASN to appended to the AS Path.
policy str: (String) Route type this AS Prepend applies to. Possible values are import and export.
prefix str: (Deprecated, String) Comma separated list of prefixes this AS Prepend applies to. Maximum of 10 prefixes. If not specified, this AS Prepend applies to all prefixes.
specific_prefixes Sequence[str]: (Array of Strings) Array of prefixes this AS Prepend applies to.
updated_at str: (String) The date and time AS Prepend was updated

createdAt String: (String) The date and time resource is created.
id String: (String) The unique identifier of the gateway.
length Number: (Integer) Number of times the ASN to appended to the AS Path.
policy String: (String) Route type this AS Prepend applies to. Possible values are import and export.
prefix String: (Deprecated, String) Comma separated list of prefixes this AS Prepend applies to. Maximum of 10 prefixes. If not specified, this AS Prepend applies to all prefixes.
specificPrefixes List<String>: (Array of Strings) Array of prefixes this AS Prepend applies to.
updatedAt String: (String) The date and time AS Prepend was updated