1. Packages
  2. Ibm Provider
  3. API Docs
  4. DlGateway
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.DlGateway

Explore with Pulumi AI

Create, update, or delete a Direct Link Gateway by using the Direct Link Gateway resource. For more information, see about Direct Link.

Example Usage

In the following example, you can create Direct Link of dedicated type:


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", {
    exportRouteFilters: [{
        action: "deny",
        prefix: "150.167.10.0/12",
        ge: 19,
        le: 29,
    }],
    importRouteFilters: [{
        action: "permit",
        prefix: "140.167.10.0/12",
        ge: 17,
        le: 30,
    }],
    defaultExportRouteFilter: "permit",
    defaultImportRouteFilter: "deny",
    bgpAsn: 64999,
    global: true,
    metered: false,
    resourceGroup: "bf823d4f45b64ceaa4671bee0479346e",
    speedMbps: 1000,
    type: "dedicated",
    crossConnectRouter: testDlRouters.then(testDlRouters => testDlRouters.crossConnectRouters?.[0]?.routerName),
    locationName: testDlRouters.then(testDlRouters => testDlRouters.locationName),
    customerName: "Customer1",
    carrierName: "Carrier1",
    vlan: 3965,
});
Copy
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",
    export_route_filters=[{
        "action": "deny",
        "prefix": "150.167.10.0/12",
        "ge": 19,
        "le": 29,
    }],
    import_route_filters=[{
        "action": "permit",
        "prefix": "140.167.10.0/12",
        "ge": 17,
        "le": 30,
    }],
    default_export_route_filter="permit",
    default_import_route_filter="deny",
    bgp_asn=64999,
    global_=True,
    metered=False,
    resource_group="bf823d4f45b64ceaa4671bee0479346e",
    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",
    vlan=3965)
Copy
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
		}
		_, err = ibm.NewDlGateway(ctx, "testDlGateway", &ibm.DlGatewayArgs{
			ExportRouteFilters: ibm.DlGatewayExportRouteFilterArray{
				&ibm.DlGatewayExportRouteFilterArgs{
					Action: pulumi.String("deny"),
					Prefix: pulumi.String("150.167.10.0/12"),
					Ge:     pulumi.Float64(19),
					Le:     pulumi.Float64(29),
				},
			},
			ImportRouteFilters: ibm.DlGatewayImportRouteFilterArray{
				&ibm.DlGatewayImportRouteFilterArgs{
					Action: pulumi.String("permit"),
					Prefix: pulumi.String("140.167.10.0/12"),
					Ge:     pulumi.Float64(17),
					Le:     pulumi.Float64(30),
				},
			},
			DefaultExportRouteFilter: pulumi.String("permit"),
			DefaultImportRouteFilter: pulumi.String("deny"),
			BgpAsn:                   pulumi.Float64(64999),
			Global:                   pulumi.Bool(true),
			Metered:                  pulumi.Bool(false),
			ResourceGroup:            pulumi.String("bf823d4f45b64ceaa4671bee0479346e"),
			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"),
			Vlan:                     pulumi.Float64(3965),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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()
    {
        ExportRouteFilters = new[]
        {
            new Ibm.Inputs.DlGatewayExportRouteFilterArgs
            {
                Action = "deny",
                Prefix = "150.167.10.0/12",
                Ge = 19,
                Le = 29,
            },
        },
        ImportRouteFilters = new[]
        {
            new Ibm.Inputs.DlGatewayImportRouteFilterArgs
            {
                Action = "permit",
                Prefix = "140.167.10.0/12",
                Ge = 17,
                Le = 30,
            },
        },
        DefaultExportRouteFilter = "permit",
        DefaultImportRouteFilter = "deny",
        BgpAsn = 64999,
        Global = true,
        Metered = false,
        ResourceGroup = "bf823d4f45b64ceaa4671bee0479346e",
        SpeedMbps = 1000,
        Type = "dedicated",
        CrossConnectRouter = testDlRouters.Apply(getDlRoutersResult => getDlRoutersResult.CrossConnectRouters[0]?.RouterName),
        LocationName = testDlRouters.Apply(getDlRoutersResult => getDlRoutersResult.LocationName),
        CustomerName = "Customer1",
        CarrierName = "Carrier1",
        Vlan = 3965,
    });

});
Copy
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.inputs.DlGatewayExportRouteFilterArgs;
import com.pulumi.ibm.inputs.DlGatewayImportRouteFilterArgs;
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()
            .exportRouteFilters(DlGatewayExportRouteFilterArgs.builder()
                .action("deny")
                .prefix("150.167.10.0/12")
                .ge(19)
                .le(29)
                .build())
            .importRouteFilters(DlGatewayImportRouteFilterArgs.builder()
                .action("permit")
                .prefix("140.167.10.0/12")
                .ge(17)
                .le(30)
                .build())
            .defaultExportRouteFilter("permit")
            .defaultImportRouteFilter("deny")
            .bgpAsn(64999)
            .global(true)
            .metered(false)
            .resourceGroup("bf823d4f45b64ceaa4671bee0479346e")
            .speedMbps(1000)
            .type("dedicated")
            .crossConnectRouter(testDlRouters.applyValue(getDlRoutersResult -> getDlRoutersResult.crossConnectRouters()[0].routerName()))
            .locationName(testDlRouters.applyValue(getDlRoutersResult -> getDlRoutersResult.locationName()))
            .customerName("Customer1")
            .carrierName("Carrier1")
            .vlan(3965)
            .build());

    }
}
Copy
resources:
  testDlGateway:
    type: ibm:DlGateway
    properties:
      exportRouteFilters:
        - action: deny
          prefix: 150.167.10.0/12
          ge: 19
          le: 29
      importRouteFilters:
        - action: permit
          prefix: 140.167.10.0/12
          ge: 17
          le: 30
      defaultExportRouteFilter: permit
      defaultImportRouteFilter: deny
      bgpAsn: 64999
      global: true
      metered: false
      resourceGroup: bf823d4f45b64ceaa4671bee0479346e
      speedMbps: 1000
      type: dedicated
      crossConnectRouter: ${testDlRouters.crossConnectRouters[0].routerName}
      locationName: ${testDlRouters.locationName}
      customerName: Customer1
      carrierName: Carrier1
      vlan: 3965 #remove_vlan=false
variables:
  testDlRouters:
    fn::invoke:
      function: ibm:getDlRouters
      arguments:
        offeringType: dedicated
        locationName: dal10
Copy

In the following example, you can create Direct Link of connect type:


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

const testDsDlPorts = ibm.getDlPorts({});
const testDlConnect = new ibm.DlGateway("testDlConnect", {
    asPrepends: [
        {
            length: 3,
            policy: "import",
            specificPrefixes: ["10.10.9.0/24"],
        },
        {
            length: 3,
            policy: "export",
            specificPrefixes: [
                "10.10.9.0/24",
                "10.10.10.0/24",
            ],
        },
    ],
    exportRouteFilters: [{
        action: "deny",
        prefix: "150.167.10.0/12",
        ge: 19,
        le: 29,
    }],
    importRouteFilters: [{
        action: "permit",
        prefix: "140.167.10.0/12",
        ge: 17,
        le: 30,
    }],
    defaultExportRouteFilter: "permit",
    defaultImportRouteFilter: "deny",
    bgpAsn: 64999,
    global: true,
    metered: false,
    speedMbps: 1000,
    type: "connect",
    port: testDsDlPorts.then(testDsDlPorts => testDsDlPorts.ports?.[0]?.portId),
});
Copy
import pulumi
import pulumi_ibm as ibm

test_ds_dl_ports = ibm.get_dl_ports()
test_dl_connect = ibm.DlGateway("testDlConnect",
    as_prepends=[
        {
            "length": 3,
            "policy": "import",
            "specific_prefixes": ["10.10.9.0/24"],
        },
        {
            "length": 3,
            "policy": "export",
            "specific_prefixes": [
                "10.10.9.0/24",
                "10.10.10.0/24",
            ],
        },
    ],
    export_route_filters=[{
        "action": "deny",
        "prefix": "150.167.10.0/12",
        "ge": 19,
        "le": 29,
    }],
    import_route_filters=[{
        "action": "permit",
        "prefix": "140.167.10.0/12",
        "ge": 17,
        "le": 30,
    }],
    default_export_route_filter="permit",
    default_import_route_filter="deny",
    bgp_asn=64999,
    global_=True,
    metered=False,
    speed_mbps=1000,
    type="connect",
    port=test_ds_dl_ports.ports[0].port_id)
Copy
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{
			AsPrepends: ibm.DlGatewayAsPrependArray{
				&ibm.DlGatewayAsPrependArgs{
					Length: pulumi.Float64(3),
					Policy: pulumi.String("import"),
					SpecificPrefixes: pulumi.StringArray{
						pulumi.String("10.10.9.0/24"),
					},
				},
				&ibm.DlGatewayAsPrependArgs{
					Length: pulumi.Float64(3),
					Policy: pulumi.String("export"),
					SpecificPrefixes: pulumi.StringArray{
						pulumi.String("10.10.9.0/24"),
						pulumi.String("10.10.10.0/24"),
					},
				},
			},
			ExportRouteFilters: ibm.DlGatewayExportRouteFilterArray{
				&ibm.DlGatewayExportRouteFilterArgs{
					Action: pulumi.String("deny"),
					Prefix: pulumi.String("150.167.10.0/12"),
					Ge:     pulumi.Float64(19),
					Le:     pulumi.Float64(29),
				},
			},
			ImportRouteFilters: ibm.DlGatewayImportRouteFilterArray{
				&ibm.DlGatewayImportRouteFilterArgs{
					Action: pulumi.String("permit"),
					Prefix: pulumi.String("140.167.10.0/12"),
					Ge:     pulumi.Float64(17),
					Le:     pulumi.Float64(30),
				},
			},
			DefaultExportRouteFilter: pulumi.String("permit"),
			DefaultImportRouteFilter: pulumi.String("deny"),
			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
		}
		return nil
	})
}
Copy
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()
    {
        AsPrepends = new[]
        {
            new Ibm.Inputs.DlGatewayAsPrependArgs
            {
                Length = 3,
                Policy = "import",
                SpecificPrefixes = new[]
                {
                    "10.10.9.0/24",
                },
            },
            new Ibm.Inputs.DlGatewayAsPrependArgs
            {
                Length = 3,
                Policy = "export",
                SpecificPrefixes = new[]
                {
                    "10.10.9.0/24",
                    "10.10.10.0/24",
                },
            },
        },
        ExportRouteFilters = new[]
        {
            new Ibm.Inputs.DlGatewayExportRouteFilterArgs
            {
                Action = "deny",
                Prefix = "150.167.10.0/12",
                Ge = 19,
                Le = 29,
            },
        },
        ImportRouteFilters = new[]
        {
            new Ibm.Inputs.DlGatewayImportRouteFilterArgs
            {
                Action = "permit",
                Prefix = "140.167.10.0/12",
                Ge = 17,
                Le = 30,
            },
        },
        DefaultExportRouteFilter = "permit",
        DefaultImportRouteFilter = "deny",
        BgpAsn = 64999,
        Global = true,
        Metered = false,
        SpeedMbps = 1000,
        Type = "connect",
        Port = testDsDlPorts.Apply(getDlPortsResult => getDlPortsResult.Ports[0]?.PortId),
    });

});
Copy
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.inputs.DlGatewayAsPrependArgs;
import com.pulumi.ibm.inputs.DlGatewayExportRouteFilterArgs;
import com.pulumi.ibm.inputs.DlGatewayImportRouteFilterArgs;
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()
            .asPrepends(            
                DlGatewayAsPrependArgs.builder()
                    .length(3)
                    .policy("import")
                    .specificPrefixes("10.10.9.0/24")
                    .build(),
                DlGatewayAsPrependArgs.builder()
                    .length(3)
                    .policy("export")
                    .specificPrefixes(                    
                        "10.10.9.0/24",
                        "10.10.10.0/24")
                    .build())
            .exportRouteFilters(DlGatewayExportRouteFilterArgs.builder()
                .action("deny")
                .prefix("150.167.10.0/12")
                .ge(19)
                .le(29)
                .build())
            .importRouteFilters(DlGatewayImportRouteFilterArgs.builder()
                .action("permit")
                .prefix("140.167.10.0/12")
                .ge(17)
                .le(30)
                .build())
            .defaultExportRouteFilter("permit")
            .defaultImportRouteFilter("deny")
            .bgpAsn(64999)
            .global(true)
            .metered(false)
            .speedMbps(1000)
            .type("connect")
            .port(testDsDlPorts.applyValue(getDlPortsResult -> getDlPortsResult.ports()[0].portId()))
            .build());

    }
}
Copy
resources:
  testDlConnect:
    type: ibm:DlGateway
    properties:
      asPrepends:
        - length: 3
          policy: import
          specificPrefixes:
            - 10.10.9.0/24
        - length: 3
          policy: export
          specificPrefixes:
            - 10.10.9.0/24
            - 10.10.10.0/24
      exportRouteFilters:
        - action: deny
          prefix: 150.167.10.0/12
          ge: 19
          le: 29
      importRouteFilters:
        - action: permit
          prefix: 140.167.10.0/12
          ge: 17
          le: 30
      defaultExportRouteFilter: permit
      defaultImportRouteFilter: deny
      bgpAsn: 64999
      global: true
      metered: false
      speedMbps: 1000
      type: connect
      port: ${testDsDlPorts.ports[0].portId}
variables:
  testDsDlPorts:
    fn::invoke:
      function: ibm:getDlPorts
      arguments: {}
Copy

Create DlGateway Resource

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

Constructor syntax

new DlGateway(name: string, args: DlGatewayArgs, opts?: CustomResourceOptions);
@overload
def DlGateway(resource_name: str,
              args: DlGatewayArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def DlGateway(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              bgp_asn: Optional[float] = None,
              type: Optional[str] = None,
              speed_mbps: Optional[float] = None,
              metered: Optional[bool] = None,
              global_: Optional[bool] = None,
              dl_gateway_id: Optional[str] = None,
              bfd_status: Optional[str] = None,
              bgp_base_cidr: Optional[str] = None,
              bgp_cer_cidr: Optional[str] = None,
              bgp_ibm_cidr: Optional[str] = None,
              carrier_name: Optional[str] = None,
              connection_mode: Optional[str] = None,
              cross_connect_router: Optional[str] = None,
              customer_name: Optional[str] = None,
              default_export_route_filter: Optional[str] = None,
              default_import_route_filter: Optional[str] = None,
              as_prepends: Optional[Sequence[DlGatewayAsPrependArgs]] = None,
              export_route_filters: Optional[Sequence[DlGatewayExportRouteFilterArgs]] = None,
              bfd_status_updated_at: Optional[str] = None,
              import_route_filters: Optional[Sequence[DlGatewayImportRouteFilterArgs]] = None,
              loa_reject_reason: Optional[str] = None,
              location_name: Optional[str] = None,
              macsec_config: Optional[DlGatewayMacsecConfigArgs] = None,
              bfd_multiplier: Optional[float] = None,
              name: Optional[str] = None,
              port: Optional[str] = None,
              remove_vlan: Optional[bool] = None,
              resource_group: Optional[str] = None,
              bfd_interval: Optional[float] = None,
              tags: Optional[Sequence[str]] = None,
              timeouts: Optional[DlGatewayTimeoutsArgs] = None,
              authentication_key: Optional[str] = None,
              vlan: Optional[float] = None)
func NewDlGateway(ctx *Context, name string, args DlGatewayArgs, opts ...ResourceOption) (*DlGateway, error)
public DlGateway(string name, DlGatewayArgs args, CustomResourceOptions? opts = null)
public DlGateway(String name, DlGatewayArgs args)
public DlGateway(String name, DlGatewayArgs args, CustomResourceOptions options)
type: ibm:DlGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DlGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DlGatewayArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DlGatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DlGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DlGatewayArgs
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 dlGatewayResource = new Ibm.DlGateway("dlGatewayResource", new()
{
    BgpAsn = 0,
    Type = "string",
    SpeedMbps = 0,
    Metered = false,
    Global = false,
    DlGatewayId = "string",
    BfdStatus = "string",
    BgpBaseCidr = "string",
    BgpCerCidr = "string",
    BgpIbmCidr = "string",
    CarrierName = "string",
    ConnectionMode = "string",
    CrossConnectRouter = "string",
    CustomerName = "string",
    DefaultExportRouteFilter = "string",
    DefaultImportRouteFilter = "string",
    AsPrepends = new[]
    {
        new Ibm.Inputs.DlGatewayAsPrependArgs
        {
            Length = 0,
            Policy = "string",
            CreatedAt = "string",
            Id = "string",
            SpecificPrefixes = new[]
            {
                "string",
            },
            UpdatedAt = "string",
        },
    },
    ExportRouteFilters = new[]
    {
        new Ibm.Inputs.DlGatewayExportRouteFilterArgs
        {
            Action = "string",
            Prefix = "string",
            Before = "string",
            CreatedAt = "string",
            ExFilterId = "string",
            Ge = 0,
            Le = 0,
            UpdatedAt = "string",
        },
    },
    BfdStatusUpdatedAt = "string",
    ImportRouteFilters = new[]
    {
        new Ibm.Inputs.DlGatewayImportRouteFilterArgs
        {
            Action = "string",
            Prefix = "string",
            Before = "string",
            CreatedAt = "string",
            Ge = 0,
            ImFilterId = "string",
            Le = 0,
            UpdatedAt = "string",
        },
    },
    LoaRejectReason = "string",
    LocationName = "string",
    MacsecConfig = new Ibm.Inputs.DlGatewayMacsecConfigArgs
    {
        Active = false,
        PrimaryCak = "string",
        ActiveCak = "string",
        CipherSuite = "string",
        ConfidentialityOffset = 0,
        CryptographicAlgorithm = "string",
        FallbackCak = "string",
        KeyServerPriority = 0,
        SakExpiryTime = 0,
        SecurityPolicy = "string",
        Status = "string",
        WindowSize = 0,
    },
    BfdMultiplier = 0,
    Name = "string",
    Port = "string",
    RemoveVlan = false,
    ResourceGroup = "string",
    BfdInterval = 0,
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.DlGatewayTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    AuthenticationKey = "string",
    Vlan = 0,
});
Copy
example, err := ibm.NewDlGateway(ctx, "dlGatewayResource", &ibm.DlGatewayArgs{
BgpAsn: pulumi.Float64(0),
Type: pulumi.String("string"),
SpeedMbps: pulumi.Float64(0),
Metered: pulumi.Bool(false),
Global: pulumi.Bool(false),
DlGatewayId: pulumi.String("string"),
BfdStatus: pulumi.String("string"),
BgpBaseCidr: pulumi.String("string"),
BgpCerCidr: pulumi.String("string"),
BgpIbmCidr: pulumi.String("string"),
CarrierName: pulumi.String("string"),
ConnectionMode: pulumi.String("string"),
CrossConnectRouter: pulumi.String("string"),
CustomerName: pulumi.String("string"),
DefaultExportRouteFilter: pulumi.String("string"),
DefaultImportRouteFilter: pulumi.String("string"),
AsPrepends: .DlGatewayAsPrependArray{
&.DlGatewayAsPrependArgs{
Length: pulumi.Float64(0),
Policy: pulumi.String("string"),
CreatedAt: pulumi.String("string"),
Id: pulumi.String("string"),
SpecificPrefixes: pulumi.StringArray{
pulumi.String("string"),
},
UpdatedAt: pulumi.String("string"),
},
},
ExportRouteFilters: .DlGatewayExportRouteFilterArray{
&.DlGatewayExportRouteFilterArgs{
Action: pulumi.String("string"),
Prefix: pulumi.String("string"),
Before: pulumi.String("string"),
CreatedAt: pulumi.String("string"),
ExFilterId: pulumi.String("string"),
Ge: pulumi.Float64(0),
Le: pulumi.Float64(0),
UpdatedAt: pulumi.String("string"),
},
},
BfdStatusUpdatedAt: pulumi.String("string"),
ImportRouteFilters: .DlGatewayImportRouteFilterArray{
&.DlGatewayImportRouteFilterArgs{
Action: pulumi.String("string"),
Prefix: pulumi.String("string"),
Before: pulumi.String("string"),
CreatedAt: pulumi.String("string"),
Ge: pulumi.Float64(0),
ImFilterId: pulumi.String("string"),
Le: pulumi.Float64(0),
UpdatedAt: pulumi.String("string"),
},
},
LoaRejectReason: pulumi.String("string"),
LocationName: pulumi.String("string"),
MacsecConfig: &.DlGatewayMacsecConfigArgs{
Active: pulumi.Bool(false),
PrimaryCak: pulumi.String("string"),
ActiveCak: pulumi.String("string"),
CipherSuite: pulumi.String("string"),
ConfidentialityOffset: pulumi.Float64(0),
CryptographicAlgorithm: pulumi.String("string"),
FallbackCak: pulumi.String("string"),
KeyServerPriority: pulumi.Float64(0),
SakExpiryTime: pulumi.Float64(0),
SecurityPolicy: pulumi.String("string"),
Status: pulumi.String("string"),
WindowSize: pulumi.Float64(0),
},
BfdMultiplier: pulumi.Float64(0),
Name: pulumi.String("string"),
Port: pulumi.String("string"),
RemoveVlan: pulumi.Bool(false),
ResourceGroup: pulumi.String("string"),
BfdInterval: pulumi.Float64(0),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Timeouts: &.DlGatewayTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
AuthenticationKey: pulumi.String("string"),
Vlan: pulumi.Float64(0),
})
Copy
var dlGatewayResource = new DlGateway("dlGatewayResource", DlGatewayArgs.builder()
    .bgpAsn(0)
    .type("string")
    .speedMbps(0)
    .metered(false)
    .global(false)
    .dlGatewayId("string")
    .bfdStatus("string")
    .bgpBaseCidr("string")
    .bgpCerCidr("string")
    .bgpIbmCidr("string")
    .carrierName("string")
    .connectionMode("string")
    .crossConnectRouter("string")
    .customerName("string")
    .defaultExportRouteFilter("string")
    .defaultImportRouteFilter("string")
    .asPrepends(DlGatewayAsPrependArgs.builder()
        .length(0)
        .policy("string")
        .createdAt("string")
        .id("string")
        .specificPrefixes("string")
        .updatedAt("string")
        .build())
    .exportRouteFilters(DlGatewayExportRouteFilterArgs.builder()
        .action("string")
        .prefix("string")
        .before("string")
        .createdAt("string")
        .exFilterId("string")
        .ge(0)
        .le(0)
        .updatedAt("string")
        .build())
    .bfdStatusUpdatedAt("string")
    .importRouteFilters(DlGatewayImportRouteFilterArgs.builder()
        .action("string")
        .prefix("string")
        .before("string")
        .createdAt("string")
        .ge(0)
        .imFilterId("string")
        .le(0)
        .updatedAt("string")
        .build())
    .loaRejectReason("string")
    .locationName("string")
    .macsecConfig(DlGatewayMacsecConfigArgs.builder()
        .active(false)
        .primaryCak("string")
        .activeCak("string")
        .cipherSuite("string")
        .confidentialityOffset(0)
        .cryptographicAlgorithm("string")
        .fallbackCak("string")
        .keyServerPriority(0)
        .sakExpiryTime(0)
        .securityPolicy("string")
        .status("string")
        .windowSize(0)
        .build())
    .bfdMultiplier(0)
    .name("string")
    .port("string")
    .removeVlan(false)
    .resourceGroup("string")
    .bfdInterval(0)
    .tags("string")
    .timeouts(DlGatewayTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .authenticationKey("string")
    .vlan(0)
    .build());
Copy
dl_gateway_resource = ibm.DlGateway("dlGatewayResource",
    bgp_asn=0,
    type="string",
    speed_mbps=0,
    metered=False,
    global_=False,
    dl_gateway_id="string",
    bfd_status="string",
    bgp_base_cidr="string",
    bgp_cer_cidr="string",
    bgp_ibm_cidr="string",
    carrier_name="string",
    connection_mode="string",
    cross_connect_router="string",
    customer_name="string",
    default_export_route_filter="string",
    default_import_route_filter="string",
    as_prepends=[{
        "length": 0,
        "policy": "string",
        "created_at": "string",
        "id": "string",
        "specific_prefixes": ["string"],
        "updated_at": "string",
    }],
    export_route_filters=[{
        "action": "string",
        "prefix": "string",
        "before": "string",
        "created_at": "string",
        "ex_filter_id": "string",
        "ge": 0,
        "le": 0,
        "updated_at": "string",
    }],
    bfd_status_updated_at="string",
    import_route_filters=[{
        "action": "string",
        "prefix": "string",
        "before": "string",
        "created_at": "string",
        "ge": 0,
        "im_filter_id": "string",
        "le": 0,
        "updated_at": "string",
    }],
    loa_reject_reason="string",
    location_name="string",
    macsec_config={
        "active": False,
        "primary_cak": "string",
        "active_cak": "string",
        "cipher_suite": "string",
        "confidentiality_offset": 0,
        "cryptographic_algorithm": "string",
        "fallback_cak": "string",
        "key_server_priority": 0,
        "sak_expiry_time": 0,
        "security_policy": "string",
        "status": "string",
        "window_size": 0,
    },
    bfd_multiplier=0,
    name="string",
    port="string",
    remove_vlan=False,
    resource_group="string",
    bfd_interval=0,
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    authentication_key="string",
    vlan=0)
Copy
const dlGatewayResource = new ibm.DlGateway("dlGatewayResource", {
    bgpAsn: 0,
    type: "string",
    speedMbps: 0,
    metered: false,
    global: false,
    dlGatewayId: "string",
    bfdStatus: "string",
    bgpBaseCidr: "string",
    bgpCerCidr: "string",
    bgpIbmCidr: "string",
    carrierName: "string",
    connectionMode: "string",
    crossConnectRouter: "string",
    customerName: "string",
    defaultExportRouteFilter: "string",
    defaultImportRouteFilter: "string",
    asPrepends: [{
        length: 0,
        policy: "string",
        createdAt: "string",
        id: "string",
        specificPrefixes: ["string"],
        updatedAt: "string",
    }],
    exportRouteFilters: [{
        action: "string",
        prefix: "string",
        before: "string",
        createdAt: "string",
        exFilterId: "string",
        ge: 0,
        le: 0,
        updatedAt: "string",
    }],
    bfdStatusUpdatedAt: "string",
    importRouteFilters: [{
        action: "string",
        prefix: "string",
        before: "string",
        createdAt: "string",
        ge: 0,
        imFilterId: "string",
        le: 0,
        updatedAt: "string",
    }],
    loaRejectReason: "string",
    locationName: "string",
    macsecConfig: {
        active: false,
        primaryCak: "string",
        activeCak: "string",
        cipherSuite: "string",
        confidentialityOffset: 0,
        cryptographicAlgorithm: "string",
        fallbackCak: "string",
        keyServerPriority: 0,
        sakExpiryTime: 0,
        securityPolicy: "string",
        status: "string",
        windowSize: 0,
    },
    bfdMultiplier: 0,
    name: "string",
    port: "string",
    removeVlan: false,
    resourceGroup: "string",
    bfdInterval: 0,
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    authenticationKey: "string",
    vlan: 0,
});
Copy
type: ibm:DlGateway
properties:
    asPrepends:
        - createdAt: string
          id: string
          length: 0
          policy: string
          specificPrefixes:
            - string
          updatedAt: string
    authenticationKey: string
    bfdInterval: 0
    bfdMultiplier: 0
    bfdStatus: string
    bfdStatusUpdatedAt: string
    bgpAsn: 0
    bgpBaseCidr: string
    bgpCerCidr: string
    bgpIbmCidr: string
    carrierName: string
    connectionMode: string
    crossConnectRouter: string
    customerName: string
    defaultExportRouteFilter: string
    defaultImportRouteFilter: string
    dlGatewayId: string
    exportRouteFilters:
        - action: string
          before: string
          createdAt: string
          exFilterId: string
          ge: 0
          le: 0
          prefix: string
          updatedAt: string
    global: false
    importRouteFilters:
        - action: string
          before: string
          createdAt: string
          ge: 0
          imFilterId: string
          le: 0
          prefix: string
          updatedAt: string
    loaRejectReason: string
    locationName: string
    macsecConfig:
        active: false
        activeCak: string
        cipherSuite: string
        confidentialityOffset: 0
        cryptographicAlgorithm: string
        fallbackCak: string
        keyServerPriority: 0
        primaryCak: string
        sakExpiryTime: 0
        securityPolicy: string
        status: string
        windowSize: 0
    metered: false
    name: string
    port: string
    removeVlan: false
    resourceGroup: string
    speedMbps: 0
    tags:
        - string
    timeouts:
        create: string
        delete: string
        update: string
    type: string
    vlan: 0
Copy

DlGateway 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 DlGateway resource accepts the following input properties:

BgpAsn This property is required. double
The BGP ASN of the gateway to be created. For example, 64999.
Global This property is required. bool
Required-Gateway with global routing as true can connect networks outside your associated region.
Metered This property is required. bool
Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
SpeedMbps This property is required. double
The gateway speed in MBPS. For example, 10.254.30.78/30.
Type This property is required. string
The gateway type, allowed values are dedicated and connect.
AsPrepends List<DlGatewayAsPrepend>

List of AS Prepend configuration information

Nested scheme for as_prepend:

AuthenticationKey string
BGP MD5 authentication key.
BfdInterval double
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
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 at
BgpBaseCidr string
(Deprecated) The BGP base CIDR of the gateway to be created. See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway by using automatic or explicit IP assignment. Any bgp_base_cidr value set will be ignored.
BgpCerCidr string
The BGP customer edge router CIDR. Specify a value within bgp_base_cidr. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
BgpIbmCidr string
The BGP IBM CIDR. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
CarrierName string
The carrier name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, myCarrierName.
ConnectionMode string
Type of network connection that you want to bind to your direct link. Allowed values are direct and transit.
CrossConnectRouter string
The cross connect router required for dedicated type. For example, xcr01.dal03.
CustomerName string
The customer name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, newCustomerName.
DefaultExportRouteFilter string
The default directional route filter action that applies to routes that do not match any directional route filters.
DefaultImportRouteFilter string
The default directional route filter action that applies to routes that do not match any directional route filters.
DlGatewayId string
(String) The unique ID of the gateway.
ExportRouteFilters List<DlGatewayExportRouteFilter>

List of Export Route Filter configuration information.

Nested scheme for export_route_filter:

ImportRouteFilters List<DlGatewayImportRouteFilter>
List of Import Route Filter configuration information. Nested scheme for import_route_filter:
LoaRejectReason string
Loa reject reason
LocationName string
The gateway location is required for dedicated type. For example, dal03.
MacsecConfig DlGatewayMacsecConfig
MACsec configuration information
Name string
The unique user-defined name for the gateway. For example, myGateway.No.
Port string
The gateway port for type is connect gateways. This parameter is required for Direct Link connect type.
RemoveVlan bool
The default value for this attribute is false. Set the value to true, if you want to remove the vlan value set earlier. You can remove vlan only for type=dedicated gateways. This attribute value conflicts with vlan attribute. You cannot set a vlan as well as remove_vlan at the same time.
ResourceGroup string
The resource group. If unspecified, the account's default resource group is used.
Tags List<string>
Tags for the direct link gateway
Timeouts DlGatewayTimeouts
Vlan double
The VLAN allocated for the gateway. You can set only for type=dedicated gateways. Allowed vlan range is 2-3967.
BgpAsn This property is required. float64
The BGP ASN of the gateway to be created. For example, 64999.
Global This property is required. bool
Required-Gateway with global routing as true can connect networks outside your associated region.
Metered This property is required. bool
Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
SpeedMbps This property is required. float64
The gateway speed in MBPS. For example, 10.254.30.78/30.
Type This property is required. string
The gateway type, allowed values are dedicated and connect.
AsPrepends []DlGatewayAsPrependArgs

List of AS Prepend configuration information

Nested scheme for as_prepend:

AuthenticationKey string
BGP MD5 authentication key.
BfdInterval float64
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
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 at
BgpBaseCidr string
(Deprecated) The BGP base CIDR of the gateway to be created. See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway by using automatic or explicit IP assignment. Any bgp_base_cidr value set will be ignored.
BgpCerCidr string
The BGP customer edge router CIDR. Specify a value within bgp_base_cidr. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
BgpIbmCidr string
The BGP IBM CIDR. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
CarrierName string
The carrier name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, myCarrierName.
ConnectionMode string
Type of network connection that you want to bind to your direct link. Allowed values are direct and transit.
CrossConnectRouter string
The cross connect router required for dedicated type. For example, xcr01.dal03.
CustomerName string
The customer name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, newCustomerName.
DefaultExportRouteFilter string
The default directional route filter action that applies to routes that do not match any directional route filters.
DefaultImportRouteFilter string
The default directional route filter action that applies to routes that do not match any directional route filters.
DlGatewayId string
(String) The unique ID of the gateway.
ExportRouteFilters []DlGatewayExportRouteFilterArgs

List of Export Route Filter configuration information.

Nested scheme for export_route_filter:

ImportRouteFilters []DlGatewayImportRouteFilterArgs
List of Import Route Filter configuration information. Nested scheme for import_route_filter:
LoaRejectReason string
Loa reject reason
LocationName string
The gateway location is required for dedicated type. For example, dal03.
MacsecConfig DlGatewayMacsecConfigArgs
MACsec configuration information
Name string
The unique user-defined name for the gateway. For example, myGateway.No.
Port string
The gateway port for type is connect gateways. This parameter is required for Direct Link connect type.
RemoveVlan bool
The default value for this attribute is false. Set the value to true, if you want to remove the vlan value set earlier. You can remove vlan only for type=dedicated gateways. This attribute value conflicts with vlan attribute. You cannot set a vlan as well as remove_vlan at the same time.
ResourceGroup string
The resource group. If unspecified, the account's default resource group is used.
Tags []string
Tags for the direct link gateway
Timeouts DlGatewayTimeoutsArgs
Vlan float64
The VLAN allocated for the gateway. You can set only for type=dedicated gateways. Allowed vlan range is 2-3967.
bgpAsn This property is required. Double
The BGP ASN of the gateway to be created. For example, 64999.
global This property is required. Boolean
Required-Gateway with global routing as true can connect networks outside your associated region.
metered This property is required. Boolean
Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
speedMbps This property is required. Double
The gateway speed in MBPS. For example, 10.254.30.78/30.
type This property is required. String
The gateway type, allowed values are dedicated and connect.
asPrepends List<DlGatewayAsPrepend>

List of AS Prepend configuration information

Nested scheme for as_prepend:

authenticationKey String
BGP MD5 authentication key.
bfdInterval Double
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
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 at
bgpBaseCidr String
(Deprecated) The BGP base CIDR of the gateway to be created. See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway by using automatic or explicit IP assignment. Any bgp_base_cidr value set will be ignored.
bgpCerCidr String
The BGP customer edge router CIDR. Specify a value within bgp_base_cidr. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
bgpIbmCidr String
The BGP IBM CIDR. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
carrierName String
The carrier name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, myCarrierName.
connectionMode String
Type of network connection that you want to bind to your direct link. Allowed values are direct and transit.
crossConnectRouter String
The cross connect router required for dedicated type. For example, xcr01.dal03.
customerName String
The customer name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, newCustomerName.
defaultExportRouteFilter String
The default directional route filter action that applies to routes that do not match any directional route filters.
defaultImportRouteFilter String
The default directional route filter action that applies to routes that do not match any directional route filters.
dlGatewayId String
(String) The unique ID of the gateway.
exportRouteFilters List<DlGatewayExportRouteFilter>

List of Export Route Filter configuration information.

Nested scheme for export_route_filter:

importRouteFilters List<DlGatewayImportRouteFilter>
List of Import Route Filter configuration information. Nested scheme for import_route_filter:
loaRejectReason String
Loa reject reason
locationName String
The gateway location is required for dedicated type. For example, dal03.
macsecConfig DlGatewayMacsecConfig
MACsec configuration information
name String
The unique user-defined name for the gateway. For example, myGateway.No.
port String
The gateway port for type is connect gateways. This parameter is required for Direct Link connect type.
removeVlan Boolean
The default value for this attribute is false. Set the value to true, if you want to remove the vlan value set earlier. You can remove vlan only for type=dedicated gateways. This attribute value conflicts with vlan attribute. You cannot set a vlan as well as remove_vlan at the same time.
resourceGroup String
The resource group. If unspecified, the account's default resource group is used.
tags List<String>
Tags for the direct link gateway
timeouts DlGatewayTimeouts
vlan Double
The VLAN allocated for the gateway. You can set only for type=dedicated gateways. Allowed vlan range is 2-3967.
bgpAsn This property is required. number
The BGP ASN of the gateway to be created. For example, 64999.
global This property is required. boolean
Required-Gateway with global routing as true can connect networks outside your associated region.
metered This property is required. boolean
Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
speedMbps This property is required. number
The gateway speed in MBPS. For example, 10.254.30.78/30.
type This property is required. string
The gateway type, allowed values are dedicated and connect.
asPrepends DlGatewayAsPrepend[]

List of AS Prepend configuration information

Nested scheme for as_prepend:

authenticationKey string
BGP MD5 authentication key.
bfdInterval number
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
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 at
bgpBaseCidr string
(Deprecated) The BGP base CIDR of the gateway to be created. See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway by using automatic or explicit IP assignment. Any bgp_base_cidr value set will be ignored.
bgpCerCidr string
The BGP customer edge router CIDR. Specify a value within bgp_base_cidr. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
bgpIbmCidr string
The BGP IBM CIDR. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
carrierName string
The carrier name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, myCarrierName.
connectionMode string
Type of network connection that you want to bind to your direct link. Allowed values are direct and transit.
crossConnectRouter string
The cross connect router required for dedicated type. For example, xcr01.dal03.
customerName string
The customer name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, newCustomerName.
defaultExportRouteFilter string
The default directional route filter action that applies to routes that do not match any directional route filters.
defaultImportRouteFilter string
The default directional route filter action that applies to routes that do not match any directional route filters.
dlGatewayId string
(String) The unique ID of the gateway.
exportRouteFilters DlGatewayExportRouteFilter[]

List of Export Route Filter configuration information.

Nested scheme for export_route_filter:

importRouteFilters DlGatewayImportRouteFilter[]
List of Import Route Filter configuration information. Nested scheme for import_route_filter:
loaRejectReason string
Loa reject reason
locationName string
The gateway location is required for dedicated type. For example, dal03.
macsecConfig DlGatewayMacsecConfig
MACsec configuration information
name string
The unique user-defined name for the gateway. For example, myGateway.No.
port string
The gateway port for type is connect gateways. This parameter is required for Direct Link connect type.
removeVlan boolean
The default value for this attribute is false. Set the value to true, if you want to remove the vlan value set earlier. You can remove vlan only for type=dedicated gateways. This attribute value conflicts with vlan attribute. You cannot set a vlan as well as remove_vlan at the same time.
resourceGroup string
The resource group. If unspecified, the account's default resource group is used.
tags string[]
Tags for the direct link gateway
timeouts DlGatewayTimeouts
vlan number
The VLAN allocated for the gateway. You can set only for type=dedicated gateways. Allowed vlan range is 2-3967.
bgp_asn This property is required. float
The BGP ASN of the gateway to be created. For example, 64999.
global_ This property is required. bool
Required-Gateway with global routing as true can connect networks outside your associated region.
metered This property is required. bool
Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
speed_mbps This property is required. float
The gateway speed in MBPS. For example, 10.254.30.78/30.
type This property is required. str
The gateway type, allowed values are dedicated and connect.
as_prepends Sequence[DlGatewayAsPrependArgs]

List of AS Prepend configuration information

Nested scheme for as_prepend:

authentication_key str
BGP MD5 authentication key.
bfd_interval float
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
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 at
bgp_base_cidr str
(Deprecated) The BGP base CIDR of the gateway to be created. See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway by using automatic or explicit IP assignment. Any bgp_base_cidr value set will be ignored.
bgp_cer_cidr str
The BGP customer edge router CIDR. Specify a value within bgp_base_cidr. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
bgp_ibm_cidr str
The BGP IBM CIDR. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
carrier_name str
The carrier name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, myCarrierName.
connection_mode str
Type of network connection that you want to bind to your direct link. Allowed values are direct and transit.
cross_connect_router str
The cross connect router required for dedicated type. For example, xcr01.dal03.
customer_name str
The customer name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, newCustomerName.
default_export_route_filter str
The default directional route filter action that applies to routes that do not match any directional route filters.
default_import_route_filter str
The default directional route filter action that applies to routes that do not match any directional route filters.
dl_gateway_id str
(String) The unique ID of the gateway.
export_route_filters Sequence[DlGatewayExportRouteFilterArgs]

List of Export Route Filter configuration information.

Nested scheme for export_route_filter:

import_route_filters Sequence[DlGatewayImportRouteFilterArgs]
List of Import Route Filter configuration information. Nested scheme for import_route_filter:
loa_reject_reason str
Loa reject reason
location_name str
The gateway location is required for dedicated type. For example, dal03.
macsec_config DlGatewayMacsecConfigArgs
MACsec configuration information
name str
The unique user-defined name for the gateway. For example, myGateway.No.
port str
The gateway port for type is connect gateways. This parameter is required for Direct Link connect type.
remove_vlan bool
The default value for this attribute is false. Set the value to true, if you want to remove the vlan value set earlier. You can remove vlan only for type=dedicated gateways. This attribute value conflicts with vlan attribute. You cannot set a vlan as well as remove_vlan at the same time.
resource_group str
The resource group. If unspecified, the account's default resource group is used.
tags Sequence[str]
Tags for the direct link gateway
timeouts DlGatewayTimeoutsArgs
vlan float
The VLAN allocated for the gateway. You can set only for type=dedicated gateways. Allowed vlan range is 2-3967.
bgpAsn This property is required. Number
The BGP ASN of the gateway to be created. For example, 64999.
global This property is required. Boolean
Required-Gateway with global routing as true can connect networks outside your associated region.
metered This property is required. Boolean
Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
speedMbps This property is required. Number
The gateway speed in MBPS. For example, 10.254.30.78/30.
type This property is required. String
The gateway type, allowed values are dedicated and connect.
asPrepends List<Property Map>

List of AS Prepend configuration information

Nested scheme for as_prepend:

authenticationKey String
BGP MD5 authentication key.
bfdInterval Number
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
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 at
bgpBaseCidr String
(Deprecated) The BGP base CIDR of the gateway to be created. See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway by using automatic or explicit IP assignment. Any bgp_base_cidr value set will be ignored.
bgpCerCidr String
The BGP customer edge router CIDR. Specify a value within bgp_base_cidr. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
bgpIbmCidr String
The BGP IBM CIDR. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
carrierName String
The carrier name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, myCarrierName.
connectionMode String
Type of network connection that you want to bind to your direct link. Allowed values are direct and transit.
crossConnectRouter String
The cross connect router required for dedicated type. For example, xcr01.dal03.
customerName String
The customer name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, newCustomerName.
defaultExportRouteFilter String
The default directional route filter action that applies to routes that do not match any directional route filters.
defaultImportRouteFilter String
The default directional route filter action that applies to routes that do not match any directional route filters.
dlGatewayId String
(String) The unique ID of the gateway.
exportRouteFilters List<Property Map>

List of Export Route Filter configuration information.

Nested scheme for export_route_filter:

importRouteFilters List<Property Map>
List of Import Route Filter configuration information. Nested scheme for import_route_filter:
loaRejectReason String
Loa reject reason
locationName String
The gateway location is required for dedicated type. For example, dal03.
macsecConfig Property Map
MACsec configuration information
name String
The unique user-defined name for the gateway. For example, myGateway.No.
port String
The gateway port for type is connect gateways. This parameter is required for Direct Link connect type.
removeVlan Boolean
The default value for this attribute is false. Set the value to true, if you want to remove the vlan value set earlier. You can remove vlan only for type=dedicated gateways. This attribute value conflicts with vlan attribute. You cannot set a vlan as well as remove_vlan at the same time.
resourceGroup String
The resource group. If unspecified, the account's default resource group is used.
tags List<String>
Tags for the direct link gateway
timeouts Property Map
vlan Number
The VLAN allocated for the gateway. You can set only for type=dedicated gateways. Allowed vlan range is 2-3967.

Outputs

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

BgpIbmAsn double
IBM BGP ASN
BgpStatus string
(String) The gateway BGP status.
BgpStatusUpdatedAt string
(String) Date and time bgp status was updated.
ChangeRequest string
Changes pending approval for provider managed Direct Link Connect gateways
CompletionNoticeRejectReason string
(String) The reason for completion notice rejection.
CreatedAt string
(String) The date and time resource created.
Crn string
(String) The CRN of the gateway.
Id string
The provider-assigned unique ID for this managed resource.
LinkStatus string
(String) The gateway link status. You can include only on type=dedicated gateways. For example, down, up.
LinkStatusUpdatedAt string
(String) Date and time link status was updated.
LocationDisplayName string
(String) The gateway location long name.
OperationalStatus string
(String) The Gateway operational status. For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA. For example, loa_accepted.
ProviderApiManaged bool
(String) Indicates whether gateway changes need to be made via a provider portal.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
BgpIbmAsn float64
IBM BGP ASN
BgpStatus string
(String) The gateway BGP status.
BgpStatusUpdatedAt string
(String) Date and time bgp status was updated.
ChangeRequest string
Changes pending approval for provider managed Direct Link Connect gateways
CompletionNoticeRejectReason string
(String) The reason for completion notice rejection.
CreatedAt string
(String) The date and time resource created.
Crn string
(String) The CRN of the gateway.
Id string
The provider-assigned unique ID for this managed resource.
LinkStatus string
(String) The gateway link status. You can include only on type=dedicated gateways. For example, down, up.
LinkStatusUpdatedAt string
(String) Date and time link status was updated.
LocationDisplayName string
(String) The gateway location long name.
OperationalStatus string
(String) The Gateway operational status. For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA. For example, loa_accepted.
ProviderApiManaged bool
(String) Indicates whether gateway changes need to be made via a provider portal.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
bgpIbmAsn Double
IBM BGP ASN
bgpStatus String
(String) The gateway BGP status.
bgpStatusUpdatedAt String
(String) Date and time bgp status was updated.
changeRequest String
Changes pending approval for provider managed Direct Link Connect gateways
completionNoticeRejectReason String
(String) The reason for completion notice rejection.
createdAt String
(String) The date and time resource created.
crn String
(String) The CRN of the gateway.
id String
The provider-assigned unique ID for this managed resource.
linkStatus String
(String) The gateway link status. You can include only on type=dedicated gateways. For example, down, up.
linkStatusUpdatedAt String
(String) Date and time link status was updated.
locationDisplayName String
(String) The gateway location long name.
operationalStatus String
(String) The Gateway operational status. For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA. For example, loa_accepted.
providerApiManaged Boolean
(String) Indicates whether gateway changes need to be made via a provider portal.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource
bgpIbmAsn number
IBM BGP ASN
bgpStatus string
(String) The gateway BGP status.
bgpStatusUpdatedAt string
(String) Date and time bgp status was updated.
changeRequest string
Changes pending approval for provider managed Direct Link Connect gateways
completionNoticeRejectReason string
(String) The reason for completion notice rejection.
createdAt string
(String) The date and time resource created.
crn string
(String) The CRN of the gateway.
id string
The provider-assigned unique ID for this managed resource.
linkStatus string
(String) The gateway link status. You can include only on type=dedicated gateways. For example, down, up.
linkStatusUpdatedAt string
(String) Date and time link status was updated.
locationDisplayName string
(String) The gateway location long name.
operationalStatus string
(String) The Gateway operational status. For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA. For example, loa_accepted.
providerApiManaged boolean
(String) Indicates whether gateway changes need to be made via a provider portal.
resourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn string
The crn of the resource
resourceGroupName string
The resource group name in which resource is provisioned
resourceName string
The name of the resource
resourceStatus string
The status of the resource
bgp_ibm_asn float
IBM BGP ASN
bgp_status str
(String) The gateway BGP status.
bgp_status_updated_at str
(String) Date and time bgp status was updated.
change_request str
Changes pending approval for provider managed Direct Link Connect gateways
completion_notice_reject_reason str
(String) The reason for completion notice rejection.
created_at str
(String) The date and time resource created.
crn str
(String) The CRN of the gateway.
id str
The provider-assigned unique ID for this managed resource.
link_status str
(String) The gateway link status. You can include only on type=dedicated gateways. For example, down, up.
link_status_updated_at str
(String) Date and time link status was updated.
location_display_name str
(String) The gateway location long name.
operational_status str
(String) The Gateway operational status. For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA. For example, loa_accepted.
provider_api_managed bool
(String) Indicates whether gateway changes need to be made via a provider portal.
resource_controller_url str
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resource_crn str
The crn of the resource
resource_group_name str
The resource group name in which resource is provisioned
resource_name str
The name of the resource
resource_status str
The status of the resource
bgpIbmAsn Number
IBM BGP ASN
bgpStatus String
(String) The gateway BGP status.
bgpStatusUpdatedAt String
(String) Date and time bgp status was updated.
changeRequest String
Changes pending approval for provider managed Direct Link Connect gateways
completionNoticeRejectReason String
(String) The reason for completion notice rejection.
createdAt String
(String) The date and time resource created.
crn String
(String) The CRN of the gateway.
id String
The provider-assigned unique ID for this managed resource.
linkStatus String
(String) The gateway link status. You can include only on type=dedicated gateways. For example, down, up.
linkStatusUpdatedAt String
(String) Date and time link status was updated.
locationDisplayName String
(String) The gateway location long name.
operationalStatus String
(String) The Gateway operational status. For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA. For example, loa_accepted.
providerApiManaged Boolean
(String) Indicates whether gateway changes need to be made via a provider portal.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource

Look up Existing DlGateway Resource

Get an existing DlGateway 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?: DlGatewayState, opts?: CustomResourceOptions): DlGateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        as_prepends: Optional[Sequence[DlGatewayAsPrependArgs]] = None,
        authentication_key: Optional[str] = None,
        bfd_interval: Optional[float] = None,
        bfd_multiplier: Optional[float] = None,
        bfd_status: Optional[str] = None,
        bfd_status_updated_at: Optional[str] = None,
        bgp_asn: Optional[float] = None,
        bgp_base_cidr: Optional[str] = None,
        bgp_cer_cidr: Optional[str] = None,
        bgp_ibm_asn: Optional[float] = None,
        bgp_ibm_cidr: Optional[str] = None,
        bgp_status: Optional[str] = None,
        bgp_status_updated_at: Optional[str] = None,
        carrier_name: Optional[str] = None,
        change_request: Optional[str] = None,
        completion_notice_reject_reason: Optional[str] = None,
        connection_mode: Optional[str] = None,
        created_at: Optional[str] = None,
        crn: Optional[str] = None,
        cross_connect_router: Optional[str] = None,
        customer_name: Optional[str] = None,
        default_export_route_filter: Optional[str] = None,
        default_import_route_filter: Optional[str] = None,
        dl_gateway_id: Optional[str] = None,
        export_route_filters: Optional[Sequence[DlGatewayExportRouteFilterArgs]] = None,
        global_: Optional[bool] = None,
        import_route_filters: Optional[Sequence[DlGatewayImportRouteFilterArgs]] = None,
        link_status: Optional[str] = None,
        link_status_updated_at: Optional[str] = None,
        loa_reject_reason: Optional[str] = None,
        location_display_name: Optional[str] = None,
        location_name: Optional[str] = None,
        macsec_config: Optional[DlGatewayMacsecConfigArgs] = None,
        metered: Optional[bool] = None,
        name: Optional[str] = None,
        operational_status: Optional[str] = None,
        port: Optional[str] = None,
        provider_api_managed: Optional[bool] = None,
        remove_vlan: Optional[bool] = None,
        resource_controller_url: Optional[str] = None,
        resource_crn: Optional[str] = None,
        resource_group: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        resource_name: Optional[str] = None,
        resource_status: Optional[str] = None,
        speed_mbps: Optional[float] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[DlGatewayTimeoutsArgs] = None,
        type: Optional[str] = None,
        vlan: Optional[float] = None) -> DlGateway
func GetDlGateway(ctx *Context, name string, id IDInput, state *DlGatewayState, opts ...ResourceOption) (*DlGateway, error)
public static DlGateway Get(string name, Input<string> id, DlGatewayState? state, CustomResourceOptions? opts = null)
public static DlGateway get(String name, Output<String> id, DlGatewayState state, CustomResourceOptions options)
resources:  _:    type: ibm:DlGateway    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AsPrepends List<DlGatewayAsPrepend>

List of AS Prepend configuration information

Nested scheme for as_prepend:

AuthenticationKey string
BGP MD5 authentication key.
BfdInterval double
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
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 at
BgpAsn double
The BGP ASN of the gateway to be created. For example, 64999.
BgpBaseCidr string
(Deprecated) The BGP base CIDR of the gateway to be created. See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway by using automatic or explicit IP assignment. Any bgp_base_cidr value set will be ignored.
BgpCerCidr string
The BGP customer edge router CIDR. Specify a value within bgp_base_cidr. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
BgpIbmAsn double
IBM BGP ASN
BgpIbmCidr string
The BGP IBM CIDR. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
BgpStatus string
(String) The gateway BGP status.
BgpStatusUpdatedAt string
(String) Date and time bgp status was updated.
CarrierName string
The carrier name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, myCarrierName.
ChangeRequest string
Changes pending approval for provider managed Direct Link Connect gateways
CompletionNoticeRejectReason string
(String) The reason for completion notice rejection.
ConnectionMode string
Type of network connection that you want to bind to your direct link. Allowed values are direct and transit.
CreatedAt string
(String) The date and time resource created.
Crn string
(String) The CRN of the gateway.
CrossConnectRouter string
The cross connect router required for dedicated type. For example, xcr01.dal03.
CustomerName string
The customer name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, newCustomerName.
DefaultExportRouteFilter string
The default directional route filter action that applies to routes that do not match any directional route filters.
DefaultImportRouteFilter string
The default directional route filter action that applies to routes that do not match any directional route filters.
DlGatewayId string
(String) The unique ID of the gateway.
ExportRouteFilters List<DlGatewayExportRouteFilter>

List of Export Route Filter configuration information.

Nested scheme for export_route_filter:

Global bool
Required-Gateway with global routing as true can connect networks outside your associated region.
ImportRouteFilters List<DlGatewayImportRouteFilter>
List of Import Route Filter configuration information. Nested scheme for import_route_filter:
LinkStatus string
(String) The gateway link status. You can include only on type=dedicated gateways. For example, down, up.
LinkStatusUpdatedAt string
(String) Date and time link status was updated.
LoaRejectReason string
Loa reject reason
LocationDisplayName string
(String) The gateway location long name.
LocationName string
The gateway location is required for dedicated type. For example, dal03.
MacsecConfig DlGatewayMacsecConfig
MACsec configuration information
Metered bool
Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
Name string
The unique user-defined name for the gateway. For example, myGateway.No.
OperationalStatus string
(String) The Gateway operational status. For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA. For example, loa_accepted.
Port string
The gateway port for type is connect gateways. This parameter is required for Direct Link connect type.
ProviderApiManaged bool
(String) Indicates whether gateway changes need to be made via a provider portal.
RemoveVlan bool
The default value for this attribute is false. Set the value to true, if you want to remove the vlan value set earlier. You can remove vlan only for type=dedicated gateways. This attribute value conflicts with vlan attribute. You cannot set a vlan as well as remove_vlan at the same time.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroup string
The resource group. If unspecified, the account's default resource group is used.
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
SpeedMbps double
The gateway speed in MBPS. For example, 10.254.30.78/30.
Tags List<string>
Tags for the direct link gateway
Timeouts DlGatewayTimeouts
Type string
The gateway type, allowed values are dedicated and connect.
Vlan double
The VLAN allocated for the gateway. You can set only for type=dedicated gateways. Allowed vlan range is 2-3967.
AsPrepends []DlGatewayAsPrependArgs

List of AS Prepend configuration information

Nested scheme for as_prepend:

AuthenticationKey string
BGP MD5 authentication key.
BfdInterval float64
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
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 at
BgpAsn float64
The BGP ASN of the gateway to be created. For example, 64999.
BgpBaseCidr string
(Deprecated) The BGP base CIDR of the gateway to be created. See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway by using automatic or explicit IP assignment. Any bgp_base_cidr value set will be ignored.
BgpCerCidr string
The BGP customer edge router CIDR. Specify a value within bgp_base_cidr. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
BgpIbmAsn float64
IBM BGP ASN
BgpIbmCidr string
The BGP IBM CIDR. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
BgpStatus string
(String) The gateway BGP status.
BgpStatusUpdatedAt string
(String) Date and time bgp status was updated.
CarrierName string
The carrier name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, myCarrierName.
ChangeRequest string
Changes pending approval for provider managed Direct Link Connect gateways
CompletionNoticeRejectReason string
(String) The reason for completion notice rejection.
ConnectionMode string
Type of network connection that you want to bind to your direct link. Allowed values are direct and transit.
CreatedAt string
(String) The date and time resource created.
Crn string
(String) The CRN of the gateway.
CrossConnectRouter string
The cross connect router required for dedicated type. For example, xcr01.dal03.
CustomerName string
The customer name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, newCustomerName.
DefaultExportRouteFilter string
The default directional route filter action that applies to routes that do not match any directional route filters.
DefaultImportRouteFilter string
The default directional route filter action that applies to routes that do not match any directional route filters.
DlGatewayId string
(String) The unique ID of the gateway.
ExportRouteFilters []DlGatewayExportRouteFilterArgs

List of Export Route Filter configuration information.

Nested scheme for export_route_filter:

Global bool
Required-Gateway with global routing as true can connect networks outside your associated region.
ImportRouteFilters []DlGatewayImportRouteFilterArgs
List of Import Route Filter configuration information. Nested scheme for import_route_filter:
LinkStatus string
(String) The gateway link status. You can include only on type=dedicated gateways. For example, down, up.
LinkStatusUpdatedAt string
(String) Date and time link status was updated.
LoaRejectReason string
Loa reject reason
LocationDisplayName string
(String) The gateway location long name.
LocationName string
The gateway location is required for dedicated type. For example, dal03.
MacsecConfig DlGatewayMacsecConfigArgs
MACsec configuration information
Metered bool
Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
Name string
The unique user-defined name for the gateway. For example, myGateway.No.
OperationalStatus string
(String) The Gateway operational status. For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA. For example, loa_accepted.
Port string
The gateway port for type is connect gateways. This parameter is required for Direct Link connect type.
ProviderApiManaged bool
(String) Indicates whether gateway changes need to be made via a provider portal.
RemoveVlan bool
The default value for this attribute is false. Set the value to true, if you want to remove the vlan value set earlier. You can remove vlan only for type=dedicated gateways. This attribute value conflicts with vlan attribute. You cannot set a vlan as well as remove_vlan at the same time.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroup string
The resource group. If unspecified, the account's default resource group is used.
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
SpeedMbps float64
The gateway speed in MBPS. For example, 10.254.30.78/30.
Tags []string
Tags for the direct link gateway
Timeouts DlGatewayTimeoutsArgs
Type string
The gateway type, allowed values are dedicated and connect.
Vlan float64
The VLAN allocated for the gateway. You can set only for type=dedicated gateways. Allowed vlan range is 2-3967.
asPrepends List<DlGatewayAsPrepend>

List of AS Prepend configuration information

Nested scheme for as_prepend:

authenticationKey String
BGP MD5 authentication key.
bfdInterval Double
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
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 at
bgpAsn Double
The BGP ASN of the gateway to be created. For example, 64999.
bgpBaseCidr String
(Deprecated) The BGP base CIDR of the gateway to be created. See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway by using automatic or explicit IP assignment. Any bgp_base_cidr value set will be ignored.
bgpCerCidr String
The BGP customer edge router CIDR. Specify a value within bgp_base_cidr. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
bgpIbmAsn Double
IBM BGP ASN
bgpIbmCidr String
The BGP IBM CIDR. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
bgpStatus String
(String) The gateway BGP status.
bgpStatusUpdatedAt String
(String) Date and time bgp status was updated.
carrierName String
The carrier name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, myCarrierName.
changeRequest String
Changes pending approval for provider managed Direct Link Connect gateways
completionNoticeRejectReason String
(String) The reason for completion notice rejection.
connectionMode String
Type of network connection that you want to bind to your direct link. Allowed values are direct and transit.
createdAt String
(String) The date and time resource created.
crn String
(String) The CRN of the gateway.
crossConnectRouter String
The cross connect router required for dedicated type. For example, xcr01.dal03.
customerName String
The customer name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, newCustomerName.
defaultExportRouteFilter String
The default directional route filter action that applies to routes that do not match any directional route filters.
defaultImportRouteFilter String
The default directional route filter action that applies to routes that do not match any directional route filters.
dlGatewayId String
(String) The unique ID of the gateway.
exportRouteFilters List<DlGatewayExportRouteFilter>

List of Export Route Filter configuration information.

Nested scheme for export_route_filter:

global Boolean
Required-Gateway with global routing as true can connect networks outside your associated region.
importRouteFilters List<DlGatewayImportRouteFilter>
List of Import Route Filter configuration information. Nested scheme for import_route_filter:
linkStatus String
(String) The gateway link status. You can include only on type=dedicated gateways. For example, down, up.
linkStatusUpdatedAt String
(String) Date and time link status was updated.
loaRejectReason String
Loa reject reason
locationDisplayName String
(String) The gateway location long name.
locationName String
The gateway location is required for dedicated type. For example, dal03.
macsecConfig DlGatewayMacsecConfig
MACsec configuration information
metered Boolean
Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
name String
The unique user-defined name for the gateway. For example, myGateway.No.
operationalStatus String
(String) The Gateway operational status. For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA. For example, loa_accepted.
port String
The gateway port for type is connect gateways. This parameter is required for Direct Link connect type.
providerApiManaged Boolean
(String) Indicates whether gateway changes need to be made via a provider portal.
removeVlan Boolean
The default value for this attribute is false. Set the value to true, if you want to remove the vlan value set earlier. You can remove vlan only for type=dedicated gateways. This attribute value conflicts with vlan attribute. You cannot set a vlan as well as remove_vlan at the same time.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroup String
The resource group. If unspecified, the account's default resource group is used.
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource
speedMbps Double
The gateway speed in MBPS. For example, 10.254.30.78/30.
tags List<String>
Tags for the direct link gateway
timeouts DlGatewayTimeouts
type String
The gateway type, allowed values are dedicated and connect.
vlan Double
The VLAN allocated for the gateway. You can set only for type=dedicated gateways. Allowed vlan range is 2-3967.
asPrepends DlGatewayAsPrepend[]

List of AS Prepend configuration information

Nested scheme for as_prepend:

authenticationKey string
BGP MD5 authentication key.
bfdInterval number
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
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 at
bgpAsn number
The BGP ASN of the gateway to be created. For example, 64999.
bgpBaseCidr string
(Deprecated) The BGP base CIDR of the gateway to be created. See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway by using automatic or explicit IP assignment. Any bgp_base_cidr value set will be ignored.
bgpCerCidr string
The BGP customer edge router CIDR. Specify a value within bgp_base_cidr. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
bgpIbmAsn number
IBM BGP ASN
bgpIbmCidr string
The BGP IBM CIDR. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
bgpStatus string
(String) The gateway BGP status.
bgpStatusUpdatedAt string
(String) Date and time bgp status was updated.
carrierName string
The carrier name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, myCarrierName.
changeRequest string
Changes pending approval for provider managed Direct Link Connect gateways
completionNoticeRejectReason string
(String) The reason for completion notice rejection.
connectionMode string
Type of network connection that you want to bind to your direct link. Allowed values are direct and transit.
createdAt string
(String) The date and time resource created.
crn string
(String) The CRN of the gateway.
crossConnectRouter string
The cross connect router required for dedicated type. For example, xcr01.dal03.
customerName string
The customer name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, newCustomerName.
defaultExportRouteFilter string
The default directional route filter action that applies to routes that do not match any directional route filters.
defaultImportRouteFilter string
The default directional route filter action that applies to routes that do not match any directional route filters.
dlGatewayId string
(String) The unique ID of the gateway.
exportRouteFilters DlGatewayExportRouteFilter[]

List of Export Route Filter configuration information.

Nested scheme for export_route_filter:

global boolean
Required-Gateway with global routing as true can connect networks outside your associated region.
importRouteFilters DlGatewayImportRouteFilter[]
List of Import Route Filter configuration information. Nested scheme for import_route_filter:
linkStatus string
(String) The gateway link status. You can include only on type=dedicated gateways. For example, down, up.
linkStatusUpdatedAt string
(String) Date and time link status was updated.
loaRejectReason string
Loa reject reason
locationDisplayName string
(String) The gateway location long name.
locationName string
The gateway location is required for dedicated type. For example, dal03.
macsecConfig DlGatewayMacsecConfig
MACsec configuration information
metered boolean
Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
name string
The unique user-defined name for the gateway. For example, myGateway.No.
operationalStatus string
(String) The Gateway operational status. For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA. For example, loa_accepted.
port string
The gateway port for type is connect gateways. This parameter is required for Direct Link connect type.
providerApiManaged boolean
(String) Indicates whether gateway changes need to be made via a provider portal.
removeVlan boolean
The default value for this attribute is false. Set the value to true, if you want to remove the vlan value set earlier. You can remove vlan only for type=dedicated gateways. This attribute value conflicts with vlan attribute. You cannot set a vlan as well as remove_vlan at the same time.
resourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn string
The crn of the resource
resourceGroup string
The resource group. If unspecified, the account's default resource group is used.
resourceGroupName string
The resource group name in which resource is provisioned
resourceName string
The name of the resource
resourceStatus string
The status of the resource
speedMbps number
The gateway speed in MBPS. For example, 10.254.30.78/30.
tags string[]
Tags for the direct link gateway
timeouts DlGatewayTimeouts
type string
The gateway type, allowed values are dedicated and connect.
vlan number
The VLAN allocated for the gateway. You can set only for type=dedicated gateways. Allowed vlan range is 2-3967.
as_prepends Sequence[DlGatewayAsPrependArgs]

List of AS Prepend configuration information

Nested scheme for as_prepend:

authentication_key str
BGP MD5 authentication key.
bfd_interval float
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
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 at
bgp_asn float
The BGP ASN of the gateway to be created. For example, 64999.
bgp_base_cidr str
(Deprecated) The BGP base CIDR of the gateway to be created. See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway by using automatic or explicit IP assignment. Any bgp_base_cidr value set will be ignored.
bgp_cer_cidr str
The BGP customer edge router CIDR. Specify a value within bgp_base_cidr. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
bgp_ibm_asn float
IBM BGP ASN
bgp_ibm_cidr str
The BGP IBM CIDR. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
bgp_status str
(String) The gateway BGP status.
bgp_status_updated_at str
(String) Date and time bgp status was updated.
carrier_name str
The carrier name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, myCarrierName.
change_request str
Changes pending approval for provider managed Direct Link Connect gateways
completion_notice_reject_reason str
(String) The reason for completion notice rejection.
connection_mode str
Type of network connection that you want to bind to your direct link. Allowed values are direct and transit.
created_at str
(String) The date and time resource created.
crn str
(String) The CRN of the gateway.
cross_connect_router str
The cross connect router required for dedicated type. For example, xcr01.dal03.
customer_name str
The customer name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, newCustomerName.
default_export_route_filter str
The default directional route filter action that applies to routes that do not match any directional route filters.
default_import_route_filter str
The default directional route filter action that applies to routes that do not match any directional route filters.
dl_gateway_id str
(String) The unique ID of the gateway.
export_route_filters Sequence[DlGatewayExportRouteFilterArgs]

List of Export Route Filter configuration information.

Nested scheme for export_route_filter:

global_ bool
Required-Gateway with global routing as true can connect networks outside your associated region.
import_route_filters Sequence[DlGatewayImportRouteFilterArgs]
List of Import Route Filter configuration information. Nested scheme for import_route_filter:
link_status str
(String) The gateway link status. You can include only on type=dedicated gateways. For example, down, up.
link_status_updated_at str
(String) Date and time link status was updated.
loa_reject_reason str
Loa reject reason
location_display_name str
(String) The gateway location long name.
location_name str
The gateway location is required for dedicated type. For example, dal03.
macsec_config DlGatewayMacsecConfigArgs
MACsec configuration information
metered bool
Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
name str
The unique user-defined name for the gateway. For example, myGateway.No.
operational_status str
(String) The Gateway operational status. For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA. For example, loa_accepted.
port str
The gateway port for type is connect gateways. This parameter is required for Direct Link connect type.
provider_api_managed bool
(String) Indicates whether gateway changes need to be made via a provider portal.
remove_vlan bool
The default value for this attribute is false. Set the value to true, if you want to remove the vlan value set earlier. You can remove vlan only for type=dedicated gateways. This attribute value conflicts with vlan attribute. You cannot set a vlan as well as remove_vlan at the same time.
resource_controller_url str
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resource_crn str
The crn of the resource
resource_group str
The resource group. If unspecified, the account's default resource group is used.
resource_group_name str
The resource group name in which resource is provisioned
resource_name str
The name of the resource
resource_status str
The status of the resource
speed_mbps float
The gateway speed in MBPS. For example, 10.254.30.78/30.
tags Sequence[str]
Tags for the direct link gateway
timeouts DlGatewayTimeoutsArgs
type str
The gateway type, allowed values are dedicated and connect.
vlan float
The VLAN allocated for the gateway. You can set only for type=dedicated gateways. Allowed vlan range is 2-3967.
asPrepends List<Property Map>

List of AS Prepend configuration information

Nested scheme for as_prepend:

authenticationKey String
BGP MD5 authentication key.
bfdInterval Number
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
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 at
bgpAsn Number
The BGP ASN of the gateway to be created. For example, 64999.
bgpBaseCidr String
(Deprecated) The BGP base CIDR of the gateway to be created. See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway by using automatic or explicit IP assignment. Any bgp_base_cidr value set will be ignored.
bgpCerCidr String
The BGP customer edge router CIDR. Specify a value within bgp_base_cidr. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
bgpIbmAsn Number
IBM BGP ASN
bgpIbmCidr String
The BGP IBM CIDR. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr.
bgpStatus String
(String) The gateway BGP status.
bgpStatusUpdatedAt String
(String) Date and time bgp status was updated.
carrierName String
The carrier name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, myCarrierName.
changeRequest String
Changes pending approval for provider managed Direct Link Connect gateways
completionNoticeRejectReason String
(String) The reason for completion notice rejection.
connectionMode String
Type of network connection that you want to bind to your direct link. Allowed values are direct and transit.
createdAt String
(String) The date and time resource created.
crn String
(String) The CRN of the gateway.
crossConnectRouter String
The cross connect router required for dedicated type. For example, xcr01.dal03.
customerName String
The customer name is required for dedicated type. Constraints are 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][A-Z][0-9][ -_]$. For example, newCustomerName.
defaultExportRouteFilter String
The default directional route filter action that applies to routes that do not match any directional route filters.
defaultImportRouteFilter String
The default directional route filter action that applies to routes that do not match any directional route filters.
dlGatewayId String
(String) The unique ID of the gateway.
exportRouteFilters List<Property Map>

List of Export Route Filter configuration information.

Nested scheme for export_route_filter:

global Boolean
Required-Gateway with global routing as true can connect networks outside your associated region.
importRouteFilters List<Property Map>
List of Import Route Filter configuration information. Nested scheme for import_route_filter:
linkStatus String
(String) The gateway link status. You can include only on type=dedicated gateways. For example, down, up.
linkStatusUpdatedAt String
(String) Date and time link status was updated.
loaRejectReason String
Loa reject reason
locationDisplayName String
(String) The gateway location long name.
locationName String
The gateway location is required for dedicated type. For example, dal03.
macsecConfig Property Map
MACsec configuration information
metered Boolean
Metered billing option. If set true gateway usage is billed per GB. Otherwise, flat rate is charged for the gateway.
name String
The unique user-defined name for the gateway. For example, myGateway.No.
operationalStatus String
(String) The Gateway operational status. For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA. For example, loa_accepted.
port String
The gateway port for type is connect gateways. This parameter is required for Direct Link connect type.
providerApiManaged Boolean
(String) Indicates whether gateway changes need to be made via a provider portal.
removeVlan Boolean
The default value for this attribute is false. Set the value to true, if you want to remove the vlan value set earlier. You can remove vlan only for type=dedicated gateways. This attribute value conflicts with vlan attribute. You cannot set a vlan as well as remove_vlan at the same time.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroup String
The resource group. If unspecified, the account's default resource group is used.
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource
speedMbps Number
The gateway speed in MBPS. For example, 10.254.30.78/30.
tags List<String>
Tags for the direct link gateway
timeouts Property Map
type String
The gateway type, allowed values are dedicated and connect.
vlan Number
The VLAN allocated for the gateway. You can set only for type=dedicated gateways. Allowed vlan range is 2-3967.

Supporting Types

DlGatewayAsPrepend
, DlGatewayAsPrependArgs

Length This property is required. double
Number of times the ASN to appended to the AS Path.
Policy This property is required. string
Route type this AS Prepend applies to. Possible values are import and export.
CreatedAt string
(String) The date and time resource created.
Id string
(String) The unique ID of the gateway.
Prefix 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. prefix will be deprecated and support will be removed. Use specific_prefixes instead

Deprecated: Deprecated

SpecificPrefixes List<string>
Array of prefixes this AS Prepend applies to. If this property is absent, the AS Prepend applies to all prefixes.
UpdatedAt string
(String) The date and time AS Prepend was updated.
Length This property is required. float64
Number of times the ASN to appended to the AS Path.
Policy This property is required. string
Route type this AS Prepend applies to. Possible values are import and export.
CreatedAt string
(String) The date and time resource created.
Id string
(String) The unique ID of the gateway.
Prefix 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. prefix will be deprecated and support will be removed. Use specific_prefixes instead

Deprecated: Deprecated

SpecificPrefixes []string
Array of prefixes this AS Prepend applies to. If this property is absent, the AS Prepend applies to all prefixes.
UpdatedAt string
(String) The date and time AS Prepend was updated.
length This property is required. Double
Number of times the ASN to appended to the AS Path.
policy This property is required. String
Route type this AS Prepend applies to. Possible values are import and export.
createdAt String
(String) The date and time resource created.
id String
(String) The unique ID of the gateway.
prefix 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. prefix will be deprecated and support will be removed. Use specific_prefixes instead

Deprecated: Deprecated

specificPrefixes List<String>
Array of prefixes this AS Prepend applies to. If this property is absent, the AS Prepend applies to all prefixes.
updatedAt String
(String) The date and time AS Prepend was updated.
length This property is required. number
Number of times the ASN to appended to the AS Path.
policy This property is required. string
Route type this AS Prepend applies to. Possible values are import and export.
createdAt string
(String) The date and time resource created.
id string
(String) The unique ID of the gateway.
prefix 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. prefix will be deprecated and support will be removed. Use specific_prefixes instead

Deprecated: Deprecated

specificPrefixes string[]
Array of prefixes this AS Prepend applies to. If this property is absent, the AS Prepend applies to all prefixes.
updatedAt string
(String) The date and time AS Prepend was updated.
length This property is required. float
Number of times the ASN to appended to the AS Path.
policy This property is required. str
Route type this AS Prepend applies to. Possible values are import and export.
created_at str
(String) The date and time resource created.
id str
(String) The unique ID of the gateway.
prefix str
Comma separated list of prefixes this AS Prepend applies to. Maximum of 10 prefixes. If not specified, this AS Prepend applies to all prefixes. prefix will be deprecated and support will be removed. Use specific_prefixes instead

Deprecated: Deprecated

specific_prefixes Sequence[str]
Array of prefixes this AS Prepend applies to. If this property is absent, the AS Prepend applies to all prefixes.
updated_at str
(String) The date and time AS Prepend was updated.
length This property is required. Number
Number of times the ASN to appended to the AS Path.
policy This property is required. String
Route type this AS Prepend applies to. Possible values are import and export.
createdAt String
(String) The date and time resource created.
id String
(String) The unique ID of the gateway.
prefix 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. prefix will be deprecated and support will be removed. Use specific_prefixes instead

Deprecated: Deprecated

specificPrefixes List<String>
Array of prefixes this AS Prepend applies to. If this property is absent, the AS Prepend applies to all prefixes.
updatedAt String
(String) The date and time AS Prepend was updated.

DlGatewayExportRouteFilter
, DlGatewayExportRouteFilterArgs

Action This property is required. string
Determines whether the routes that match the prefix-set will be permit or deny
Prefix This property is required. string
IP prefix representing an address and mask length of the prefix-set
Before string
Identifier of the next route filter to be considered
CreatedAt string
(String) The date and time resource created.
ExFilterId string
Export route Filter identifier
Ge double
The minimum matching length of the prefix-set
Le double
The maximum matching length of the prefix-set
UpdatedAt string
(String) The date and time AS Prepend was updated.
Action This property is required. string
Determines whether the routes that match the prefix-set will be permit or deny
Prefix This property is required. string
IP prefix representing an address and mask length of the prefix-set
Before string
Identifier of the next route filter to be considered
CreatedAt string
(String) The date and time resource created.
ExFilterId string
Export route Filter identifier
Ge float64
The minimum matching length of the prefix-set
Le float64
The maximum matching length of the prefix-set
UpdatedAt string
(String) The date and time AS Prepend was updated.
action This property is required. String
Determines whether the routes that match the prefix-set will be permit or deny
prefix This property is required. String
IP prefix representing an address and mask length of the prefix-set
before String
Identifier of the next route filter to be considered
createdAt String
(String) The date and time resource created.
exFilterId String
Export route Filter identifier
ge Double
The minimum matching length of the prefix-set
le Double
The maximum matching length of the prefix-set
updatedAt String
(String) The date and time AS Prepend was updated.
action This property is required. string
Determines whether the routes that match the prefix-set will be permit or deny
prefix This property is required. string
IP prefix representing an address and mask length of the prefix-set
before string
Identifier of the next route filter to be considered
createdAt string
(String) The date and time resource created.
exFilterId string
Export route Filter identifier
ge number
The minimum matching length of the prefix-set
le number
The maximum matching length of the prefix-set
updatedAt string
(String) The date and time AS Prepend was updated.
action This property is required. str
Determines whether the routes that match the prefix-set will be permit or deny
prefix This property is required. str
IP prefix representing an address and mask length of the prefix-set
before str
Identifier of the next route filter to be considered
created_at str
(String) The date and time resource created.
ex_filter_id str
Export route Filter identifier
ge float
The minimum matching length of the prefix-set
le float
The maximum matching length of the prefix-set
updated_at str
(String) The date and time AS Prepend was updated.
action This property is required. String
Determines whether the routes that match the prefix-set will be permit or deny
prefix This property is required. String
IP prefix representing an address and mask length of the prefix-set
before String
Identifier of the next route filter to be considered
createdAt String
(String) The date and time resource created.
exFilterId String
Export route Filter identifier
ge Number
The minimum matching length of the prefix-set
le Number
The maximum matching length of the prefix-set
updatedAt String
(String) The date and time AS Prepend was updated.

DlGatewayImportRouteFilter
, DlGatewayImportRouteFilterArgs

Action This property is required. string
Determines whether the routes that match the prefix-set will be permit or deny
Prefix This property is required. string
IP prefix representing an address and mask length of the prefix-set
Before string
Identifier of the next route filter to be considered
CreatedAt string
(String) The date and time resource created.
Ge double
The minimum matching length of the prefix-set
ImFilterId string
Import route Filter identifier
Le double
The maximum matching length of the prefix-set
UpdatedAt string
(String) The date and time AS Prepend was updated.
Action This property is required. string
Determines whether the routes that match the prefix-set will be permit or deny
Prefix This property is required. string
IP prefix representing an address and mask length of the prefix-set
Before string
Identifier of the next route filter to be considered
CreatedAt string
(String) The date and time resource created.
Ge float64
The minimum matching length of the prefix-set
ImFilterId string
Import route Filter identifier
Le float64
The maximum matching length of the prefix-set
UpdatedAt string
(String) The date and time AS Prepend was updated.
action This property is required. String
Determines whether the routes that match the prefix-set will be permit or deny
prefix This property is required. String
IP prefix representing an address and mask length of the prefix-set
before String
Identifier of the next route filter to be considered
createdAt String
(String) The date and time resource created.
ge Double
The minimum matching length of the prefix-set
imFilterId String
Import route Filter identifier
le Double
The maximum matching length of the prefix-set
updatedAt String
(String) The date and time AS Prepend was updated.
action This property is required. string
Determines whether the routes that match the prefix-set will be permit or deny
prefix This property is required. string
IP prefix representing an address and mask length of the prefix-set
before string
Identifier of the next route filter to be considered
createdAt string
(String) The date and time resource created.
ge number
The minimum matching length of the prefix-set
imFilterId string
Import route Filter identifier
le number
The maximum matching length of the prefix-set
updatedAt string
(String) The date and time AS Prepend was updated.
action This property is required. str
Determines whether the routes that match the prefix-set will be permit or deny
prefix This property is required. str
IP prefix representing an address and mask length of the prefix-set
before str
Identifier of the next route filter to be considered
created_at str
(String) The date and time resource created.
ge float
The minimum matching length of the prefix-set
im_filter_id str
Import route Filter identifier
le float
The maximum matching length of the prefix-set
updated_at str
(String) The date and time AS Prepend was updated.
action This property is required. String
Determines whether the routes that match the prefix-set will be permit or deny
prefix This property is required. String
IP prefix representing an address and mask length of the prefix-set
before String
Identifier of the next route filter to be considered
createdAt String
(String) The date and time resource created.
ge Number
The minimum matching length of the prefix-set
imFilterId String
Import route Filter identifier
le Number
The maximum matching length of the prefix-set
updatedAt String
(String) The date and time AS Prepend was updated.

DlGatewayMacsecConfig
, DlGatewayMacsecConfigArgs

Active This property is required. bool
Indicate whether MACsec protection should be active (true) or inactive (false) for this MACsec enabled gateway
PrimaryCak This property is required. string
Desired primary connectivity association key. Keys for a MACsec configuration must have names with an even number of characters from [0-9a-fA-F]
ActiveCak string
Active connectivity association key.
CipherSuite string
SAK cipher suite
ConfidentialityOffset double
Confidentiality Offset
CryptographicAlgorithm string
Cryptographic Algorithm
FallbackCak string
Fallback connectivity association key. Keys used for MACsec configuration must have names with an even number of characters from [0-9a-fA-F]
KeyServerPriority double
Key Server Priority
SakExpiryTime double
Secure Association Key (SAK) expiry time in seconds
SecurityPolicy string
Packets without MACsec headers are not dropped when security_policy is should_secure.
Status string
The current status of MACsec on the device for this gateway
WindowSize double
Replay protection window size
Active This property is required. bool
Indicate whether MACsec protection should be active (true) or inactive (false) for this MACsec enabled gateway
PrimaryCak This property is required. string
Desired primary connectivity association key. Keys for a MACsec configuration must have names with an even number of characters from [0-9a-fA-F]
ActiveCak string
Active connectivity association key.
CipherSuite string
SAK cipher suite
ConfidentialityOffset float64
Confidentiality Offset
CryptographicAlgorithm string
Cryptographic Algorithm
FallbackCak string
Fallback connectivity association key. Keys used for MACsec configuration must have names with an even number of characters from [0-9a-fA-F]
KeyServerPriority float64
Key Server Priority
SakExpiryTime float64
Secure Association Key (SAK) expiry time in seconds
SecurityPolicy string
Packets without MACsec headers are not dropped when security_policy is should_secure.
Status string
The current status of MACsec on the device for this gateway
WindowSize float64
Replay protection window size
active This property is required. Boolean
Indicate whether MACsec protection should be active (true) or inactive (false) for this MACsec enabled gateway
primaryCak This property is required. String
Desired primary connectivity association key. Keys for a MACsec configuration must have names with an even number of characters from [0-9a-fA-F]
activeCak String
Active connectivity association key.
cipherSuite String
SAK cipher suite
confidentialityOffset Double
Confidentiality Offset
cryptographicAlgorithm String
Cryptographic Algorithm
fallbackCak String
Fallback connectivity association key. Keys used for MACsec configuration must have names with an even number of characters from [0-9a-fA-F]
keyServerPriority Double
Key Server Priority
sakExpiryTime Double
Secure Association Key (SAK) expiry time in seconds
securityPolicy String
Packets without MACsec headers are not dropped when security_policy is should_secure.
status String
The current status of MACsec on the device for this gateway
windowSize Double
Replay protection window size
active This property is required. boolean
Indicate whether MACsec protection should be active (true) or inactive (false) for this MACsec enabled gateway
primaryCak This property is required. string
Desired primary connectivity association key. Keys for a MACsec configuration must have names with an even number of characters from [0-9a-fA-F]
activeCak string
Active connectivity association key.
cipherSuite string
SAK cipher suite
confidentialityOffset number
Confidentiality Offset
cryptographicAlgorithm string
Cryptographic Algorithm
fallbackCak string
Fallback connectivity association key. Keys used for MACsec configuration must have names with an even number of characters from [0-9a-fA-F]
keyServerPriority number
Key Server Priority
sakExpiryTime number
Secure Association Key (SAK) expiry time in seconds
securityPolicy string
Packets without MACsec headers are not dropped when security_policy is should_secure.
status string
The current status of MACsec on the device for this gateway
windowSize number
Replay protection window size
active This property is required. bool
Indicate whether MACsec protection should be active (true) or inactive (false) for this MACsec enabled gateway
primary_cak This property is required. str
Desired primary connectivity association key. Keys for a MACsec configuration must have names with an even number of characters from [0-9a-fA-F]
active_cak str
Active connectivity association key.
cipher_suite str
SAK cipher suite
confidentiality_offset float
Confidentiality Offset
cryptographic_algorithm str
Cryptographic Algorithm
fallback_cak str
Fallback connectivity association key. Keys used for MACsec configuration must have names with an even number of characters from [0-9a-fA-F]
key_server_priority float
Key Server Priority
sak_expiry_time float
Secure Association Key (SAK) expiry time in seconds
security_policy str
Packets without MACsec headers are not dropped when security_policy is should_secure.
status str
The current status of MACsec on the device for this gateway
window_size float
Replay protection window size
active This property is required. Boolean
Indicate whether MACsec protection should be active (true) or inactive (false) for this MACsec enabled gateway
primaryCak This property is required. String
Desired primary connectivity association key. Keys for a MACsec configuration must have names with an even number of characters from [0-9a-fA-F]
activeCak String
Active connectivity association key.
cipherSuite String
SAK cipher suite
confidentialityOffset Number
Confidentiality Offset
cryptographicAlgorithm String
Cryptographic Algorithm
fallbackCak String
Fallback connectivity association key. Keys used for MACsec configuration must have names with an even number of characters from [0-9a-fA-F]
keyServerPriority Number
Key Server Priority
sakExpiryTime Number
Secure Association Key (SAK) expiry time in seconds
securityPolicy String
Packets without MACsec headers are not dropped when security_policy is should_secure.
status String
The current status of MACsec on the device for this gateway
windowSize Number
Replay protection window size

DlGatewayTimeouts
, DlGatewayTimeoutsArgs

Create string
Delete string
Update string
Create string
Delete string
Update string
create String
delete String
update String
create string
delete string
update string
create str
delete str
update str
create String
delete String
update String

Import

The ibm_dl_gateway resource can be imported by using gateway ID.

Syntax


$ pulumi import ibm:index/dlGateway:DlGateway example <gateway_ID>
Copy

Example


$ pulumi import ibm:index/dlGateway:DlGateway example 5ffda12064634723b079acdb018ef308
Copy

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.