Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. NsxtEdgegateway
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.NsxtEdgegateway

Explore with Pulumi AI

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

Create NsxtEdgegateway Resource

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

Constructor syntax

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

@overload
def NsxtEdgegateway(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    external_network_id: Optional[str] = None,
                    non_distributed_routing_enabled: Optional[bool] = None,
                    org: Optional[str] = None,
                    edge_cluster_id: Optional[str] = None,
                    deployment_mode: Optional[str] = None,
                    external_networks: Optional[Sequence[NsxtEdgegatewayExternalNetworkArgs]] = None,
                    ip_count_read_limit: Optional[float] = None,
                    name: Optional[str] = None,
                    dedicate_external_network: Optional[bool] = None,
                    description: Optional[str] = None,
                    owner_id: Optional[str] = None,
                    nsxt_edgegateway_id: Optional[str] = None,
                    starting_vdc_id: Optional[str] = None,
                    subnet_with_ip_counts: Optional[Sequence[NsxtEdgegatewaySubnetWithIpCountArgs]] = None,
                    subnet_with_total_ip_counts: Optional[Sequence[NsxtEdgegatewaySubnetWithTotalIpCountArgs]] = None,
                    subnets: Optional[Sequence[NsxtEdgegatewaySubnetArgs]] = None,
                    total_allocated_ip_count: Optional[float] = None,
                    vdc: Optional[str] = None)
func NewNsxtEdgegateway(ctx *Context, name string, args NsxtEdgegatewayArgs, opts ...ResourceOption) (*NsxtEdgegateway, error)
public NsxtEdgegateway(string name, NsxtEdgegatewayArgs args, CustomResourceOptions? opts = null)
public NsxtEdgegateway(String name, NsxtEdgegatewayArgs args)
public NsxtEdgegateway(String name, NsxtEdgegatewayArgs args, CustomResourceOptions options)

type: vcd:NsxtEdgegateway
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. NsxtEdgegatewayArgs
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. NsxtEdgegatewayArgs
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. NsxtEdgegatewayArgs
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. NsxtEdgegatewayArgs
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. NsxtEdgegatewayArgs
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 nsxtEdgegatewayResource = new Vcd.NsxtEdgegateway("nsxtEdgegatewayResource", new()
{
    ExternalNetworkId = "string",
    NonDistributedRoutingEnabled = false,
    Org = "string",
    EdgeClusterId = "string",
    DeploymentMode = "string",
    ExternalNetworks = new[]
    {
        new Vcd.Inputs.NsxtEdgegatewayExternalNetworkArgs
        {
            AllocatedIpCount = 0,
            ExternalNetworkId = "string",
            Gateway = "string",
            PrefixLength = 0,
            PrimaryIp = "string",
        },
    },
    IpCountReadLimit = 0,
    Name = "string",
    DedicateExternalNetwork = false,
    Description = "string",
    OwnerId = "string",
    NsxtEdgegatewayId = "string",
    StartingVdcId = "string",
    SubnetWithIpCounts = new[]
    {
        new Vcd.Inputs.NsxtEdgegatewaySubnetWithIpCountArgs
        {
            AllocatedIpCount = 0,
            Gateway = "string",
            PrefixLength = 0,
            PrimaryIp = "string",
        },
    },
    SubnetWithTotalIpCounts = new[]
    {
        new Vcd.Inputs.NsxtEdgegatewaySubnetWithTotalIpCountArgs
        {
            Gateway = "string",
            PrefixLength = 0,
            PrimaryIp = "string",
        },
    },
    Subnets = new[]
    {
        new Vcd.Inputs.NsxtEdgegatewaySubnetArgs
        {
            Gateway = "string",
            PrefixLength = 0,
            AllocatedIps = new[]
            {
                new Vcd.Inputs.NsxtEdgegatewaySubnetAllocatedIpArgs
                {
                    EndAddress = "string",
                    StartAddress = "string",
                },
            },
            PrimaryIp = "string",
        },
    },
    TotalAllocatedIpCount = 0,
});
Copy
example, err := vcd.NewNsxtEdgegateway(ctx, "nsxtEdgegatewayResource", &vcd.NsxtEdgegatewayArgs{
ExternalNetworkId: pulumi.String("string"),
NonDistributedRoutingEnabled: pulumi.Bool(false),
Org: pulumi.String("string"),
EdgeClusterId: pulumi.String("string"),
DeploymentMode: pulumi.String("string"),
ExternalNetworks: .NsxtEdgegatewayExternalNetworkArray{
&.NsxtEdgegatewayExternalNetworkArgs{
AllocatedIpCount: pulumi.Float64(0),
ExternalNetworkId: pulumi.String("string"),
Gateway: pulumi.String("string"),
PrefixLength: pulumi.Float64(0),
PrimaryIp: pulumi.String("string"),
},
},
IpCountReadLimit: pulumi.Float64(0),
Name: pulumi.String("string"),
DedicateExternalNetwork: pulumi.Bool(false),
Description: pulumi.String("string"),
OwnerId: pulumi.String("string"),
NsxtEdgegatewayId: pulumi.String("string"),
StartingVdcId: pulumi.String("string"),
SubnetWithIpCounts: .NsxtEdgegatewaySubnetWithIpCountArray{
&.NsxtEdgegatewaySubnetWithIpCountArgs{
AllocatedIpCount: pulumi.Float64(0),
Gateway: pulumi.String("string"),
PrefixLength: pulumi.Float64(0),
PrimaryIp: pulumi.String("string"),
},
},
SubnetWithTotalIpCounts: .NsxtEdgegatewaySubnetWithTotalIpCountArray{
&.NsxtEdgegatewaySubnetWithTotalIpCountArgs{
Gateway: pulumi.String("string"),
PrefixLength: pulumi.Float64(0),
PrimaryIp: pulumi.String("string"),
},
},
Subnets: .NsxtEdgegatewaySubnetArray{
&.NsxtEdgegatewaySubnetArgs{
Gateway: pulumi.String("string"),
PrefixLength: pulumi.Float64(0),
AllocatedIps: .NsxtEdgegatewaySubnetAllocatedIpArray{
&.NsxtEdgegatewaySubnetAllocatedIpArgs{
EndAddress: pulumi.String("string"),
StartAddress: pulumi.String("string"),
},
},
PrimaryIp: pulumi.String("string"),
},
},
TotalAllocatedIpCount: pulumi.Float64(0),
})
Copy
var nsxtEdgegatewayResource = new NsxtEdgegateway("nsxtEdgegatewayResource", NsxtEdgegatewayArgs.builder()
    .externalNetworkId("string")
    .nonDistributedRoutingEnabled(false)
    .org("string")
    .edgeClusterId("string")
    .deploymentMode("string")
    .externalNetworks(NsxtEdgegatewayExternalNetworkArgs.builder()
        .allocatedIpCount(0)
        .externalNetworkId("string")
        .gateway("string")
        .prefixLength(0)
        .primaryIp("string")
        .build())
    .ipCountReadLimit(0)
    .name("string")
    .dedicateExternalNetwork(false)
    .description("string")
    .ownerId("string")
    .nsxtEdgegatewayId("string")
    .startingVdcId("string")
    .subnetWithIpCounts(NsxtEdgegatewaySubnetWithIpCountArgs.builder()
        .allocatedIpCount(0)
        .gateway("string")
        .prefixLength(0)
        .primaryIp("string")
        .build())
    .subnetWithTotalIpCounts(NsxtEdgegatewaySubnetWithTotalIpCountArgs.builder()
        .gateway("string")
        .prefixLength(0)
        .primaryIp("string")
        .build())
    .subnets(NsxtEdgegatewaySubnetArgs.builder()
        .gateway("string")
        .prefixLength(0)
        .allocatedIps(NsxtEdgegatewaySubnetAllocatedIpArgs.builder()
            .endAddress("string")
            .startAddress("string")
            .build())
        .primaryIp("string")
        .build())
    .totalAllocatedIpCount(0)
    .build());
Copy
nsxt_edgegateway_resource = vcd.NsxtEdgegateway("nsxtEdgegatewayResource",
    external_network_id="string",
    non_distributed_routing_enabled=False,
    org="string",
    edge_cluster_id="string",
    deployment_mode="string",
    external_networks=[{
        "allocated_ip_count": 0,
        "external_network_id": "string",
        "gateway": "string",
        "prefix_length": 0,
        "primary_ip": "string",
    }],
    ip_count_read_limit=0,
    name="string",
    dedicate_external_network=False,
    description="string",
    owner_id="string",
    nsxt_edgegateway_id="string",
    starting_vdc_id="string",
    subnet_with_ip_counts=[{
        "allocated_ip_count": 0,
        "gateway": "string",
        "prefix_length": 0,
        "primary_ip": "string",
    }],
    subnet_with_total_ip_counts=[{
        "gateway": "string",
        "prefix_length": 0,
        "primary_ip": "string",
    }],
    subnets=[{
        "gateway": "string",
        "prefix_length": 0,
        "allocated_ips": [{
            "end_address": "string",
            "start_address": "string",
        }],
        "primary_ip": "string",
    }],
    total_allocated_ip_count=0)
Copy
const nsxtEdgegatewayResource = new vcd.NsxtEdgegateway("nsxtEdgegatewayResource", {
    externalNetworkId: "string",
    nonDistributedRoutingEnabled: false,
    org: "string",
    edgeClusterId: "string",
    deploymentMode: "string",
    externalNetworks: [{
        allocatedIpCount: 0,
        externalNetworkId: "string",
        gateway: "string",
        prefixLength: 0,
        primaryIp: "string",
    }],
    ipCountReadLimit: 0,
    name: "string",
    dedicateExternalNetwork: false,
    description: "string",
    ownerId: "string",
    nsxtEdgegatewayId: "string",
    startingVdcId: "string",
    subnetWithIpCounts: [{
        allocatedIpCount: 0,
        gateway: "string",
        prefixLength: 0,
        primaryIp: "string",
    }],
    subnetWithTotalIpCounts: [{
        gateway: "string",
        prefixLength: 0,
        primaryIp: "string",
    }],
    subnets: [{
        gateway: "string",
        prefixLength: 0,
        allocatedIps: [{
            endAddress: "string",
            startAddress: "string",
        }],
        primaryIp: "string",
    }],
    totalAllocatedIpCount: 0,
});
Copy
type: vcd:NsxtEdgegateway
properties:
    dedicateExternalNetwork: false
    deploymentMode: string
    description: string
    edgeClusterId: string
    externalNetworkId: string
    externalNetworks:
        - allocatedIpCount: 0
          externalNetworkId: string
          gateway: string
          prefixLength: 0
          primaryIp: string
    ipCountReadLimit: 0
    name: string
    nonDistributedRoutingEnabled: false
    nsxtEdgegatewayId: string
    org: string
    ownerId: string
    startingVdcId: string
    subnetWithIpCounts:
        - allocatedIpCount: 0
          gateway: string
          prefixLength: 0
          primaryIp: string
    subnetWithTotalIpCounts:
        - gateway: string
          prefixLength: 0
          primaryIp: string
    subnets:
        - allocatedIps:
            - endAddress: string
              startAddress: string
          gateway: string
          prefixLength: 0
          primaryIp: string
    totalAllocatedIpCount: 0
Copy

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

ExternalNetworkId This property is required. string
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
DedicateExternalNetwork bool
Dedicating the external network will enable Route Advertisement for this Edge Gateway. Default false.
DeploymentMode string
ACTIVE_STANDBY (default) or DISTRIBUTED_ONLY (VCD 10.6+). Distributed-only does not provide services that run on service router such as firewalling, NAT, VPN, DNS forwarding or static routes, instead, the distributed nature guarantees high north-south data throughput.
Description string
A unique name for the edge gateway.
EdgeClusterId string
Specific Edge Cluster ID if required
ExternalNetworks List<NsxtEdgegatewayExternalNetwork>
attaches NSX-T Segment backed External Networks with a given configuration block. It does not support IP Spaces.
IpCountReadLimit double

Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000, update is a no-op, but will affect newly read data. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.

Name string
A unique name for the edge gateway.
NonDistributedRoutingEnabled bool
Non-Distributed routing will allow tenants the option of connecting Org Vdc networks to the Service Router. This would force all VM traffic through the service router for that network. Default false.
NsxtEdgegatewayId string
Org string
The name of organization to which the VDC belongs. Optional if defined at provider level.
OwnerId string

The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.

Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.

When a VDC Group ID is specified in owner_id field, the Edge Gateway will be created in VDC (random member of VDC Group or specified in starting_vdc_id). Main use case of starting_vdc_id is to pick egress traffic origin for multi datacenter VDC Groups.

StartingVdcId string
If owner_id is a VDC Group, by default Edge Gateway will be created in random member VDC and moved to destination VDC Group. This field allows to specify initial VDC for Edge Gateway (this can define Egress location of traffic in the VDC Group) Note: It can only be used when owner_id is a VDC Group.
SubnetWithIpCounts List<NsxtEdgegatewaySubnetWithIpCount>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
SubnetWithTotalIpCounts List<NsxtEdgegatewaySubnetWithTotalIpCount>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
Subnets List<NsxtEdgegatewaySubnet>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
TotalAllocatedIpCount double
Required with subnet_with_total_ip_count. It is read-only attribute with other other allocation models subnet and subnet_with_ip_count. Note. It sets or reports IP count only for NSX-T Tier 0 backed external network Uplink.
Vdc string
Deprecated in favor of owner_id. The name of VDC that owns the edge gateway. Can be inherited from provider configuration if not defined here.

Deprecated: Deprecated

ExternalNetworkId This property is required. string
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
DedicateExternalNetwork bool
Dedicating the external network will enable Route Advertisement for this Edge Gateway. Default false.
DeploymentMode string
ACTIVE_STANDBY (default) or DISTRIBUTED_ONLY (VCD 10.6+). Distributed-only does not provide services that run on service router such as firewalling, NAT, VPN, DNS forwarding or static routes, instead, the distributed nature guarantees high north-south data throughput.
Description string
A unique name for the edge gateway.
EdgeClusterId string
Specific Edge Cluster ID if required
ExternalNetworks []NsxtEdgegatewayExternalNetworkArgs
attaches NSX-T Segment backed External Networks with a given configuration block. It does not support IP Spaces.
IpCountReadLimit float64

Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000, update is a no-op, but will affect newly read data. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.

Name string
A unique name for the edge gateway.
NonDistributedRoutingEnabled bool
Non-Distributed routing will allow tenants the option of connecting Org Vdc networks to the Service Router. This would force all VM traffic through the service router for that network. Default false.
NsxtEdgegatewayId string
Org string
The name of organization to which the VDC belongs. Optional if defined at provider level.
OwnerId string

The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.

Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.

When a VDC Group ID is specified in owner_id field, the Edge Gateway will be created in VDC (random member of VDC Group or specified in starting_vdc_id). Main use case of starting_vdc_id is to pick egress traffic origin for multi datacenter VDC Groups.

StartingVdcId string
If owner_id is a VDC Group, by default Edge Gateway will be created in random member VDC and moved to destination VDC Group. This field allows to specify initial VDC for Edge Gateway (this can define Egress location of traffic in the VDC Group) Note: It can only be used when owner_id is a VDC Group.
SubnetWithIpCounts []NsxtEdgegatewaySubnetWithIpCountArgs
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
SubnetWithTotalIpCounts []NsxtEdgegatewaySubnetWithTotalIpCountArgs
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
Subnets []NsxtEdgegatewaySubnetArgs
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
TotalAllocatedIpCount float64
Required with subnet_with_total_ip_count. It is read-only attribute with other other allocation models subnet and subnet_with_ip_count. Note. It sets or reports IP count only for NSX-T Tier 0 backed external network Uplink.
Vdc string
Deprecated in favor of owner_id. The name of VDC that owns the edge gateway. Can be inherited from provider configuration if not defined here.

Deprecated: Deprecated

externalNetworkId This property is required. String
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
dedicateExternalNetwork Boolean
Dedicating the external network will enable Route Advertisement for this Edge Gateway. Default false.
deploymentMode String
ACTIVE_STANDBY (default) or DISTRIBUTED_ONLY (VCD 10.6+). Distributed-only does not provide services that run on service router such as firewalling, NAT, VPN, DNS forwarding or static routes, instead, the distributed nature guarantees high north-south data throughput.
description String
A unique name for the edge gateway.
edgeClusterId String
Specific Edge Cluster ID if required
externalNetworks List<NsxtEdgegatewayExternalNetwork>
attaches NSX-T Segment backed External Networks with a given configuration block. It does not support IP Spaces.
ipCountReadLimit Double

Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000, update is a no-op, but will affect newly read data. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.

name String
A unique name for the edge gateway.
nonDistributedRoutingEnabled Boolean
Non-Distributed routing will allow tenants the option of connecting Org Vdc networks to the Service Router. This would force all VM traffic through the service router for that network. Default false.
nsxtEdgegatewayId String
org String
The name of organization to which the VDC belongs. Optional if defined at provider level.
ownerId String

The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.

Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.

When a VDC Group ID is specified in owner_id field, the Edge Gateway will be created in VDC (random member of VDC Group or specified in starting_vdc_id). Main use case of starting_vdc_id is to pick egress traffic origin for multi datacenter VDC Groups.

startingVdcId String
If owner_id is a VDC Group, by default Edge Gateway will be created in random member VDC and moved to destination VDC Group. This field allows to specify initial VDC for Edge Gateway (this can define Egress location of traffic in the VDC Group) Note: It can only be used when owner_id is a VDC Group.
subnetWithIpCounts List<NsxtEdgegatewaySubnetWithIpCount>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnetWithTotalIpCounts List<NsxtEdgegatewaySubnetWithTotalIpCount>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnets List<NsxtEdgegatewaySubnet>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
totalAllocatedIpCount Double
Required with subnet_with_total_ip_count. It is read-only attribute with other other allocation models subnet and subnet_with_ip_count. Note. It sets or reports IP count only for NSX-T Tier 0 backed external network Uplink.
vdc String
Deprecated in favor of owner_id. The name of VDC that owns the edge gateway. Can be inherited from provider configuration if not defined here.

Deprecated: Deprecated

externalNetworkId This property is required. string
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
dedicateExternalNetwork boolean
Dedicating the external network will enable Route Advertisement for this Edge Gateway. Default false.
deploymentMode string
ACTIVE_STANDBY (default) or DISTRIBUTED_ONLY (VCD 10.6+). Distributed-only does not provide services that run on service router such as firewalling, NAT, VPN, DNS forwarding or static routes, instead, the distributed nature guarantees high north-south data throughput.
description string
A unique name for the edge gateway.
edgeClusterId string
Specific Edge Cluster ID if required
externalNetworks NsxtEdgegatewayExternalNetwork[]
attaches NSX-T Segment backed External Networks with a given configuration block. It does not support IP Spaces.
ipCountReadLimit number

Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000, update is a no-op, but will affect newly read data. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.

name string
A unique name for the edge gateway.
nonDistributedRoutingEnabled boolean
Non-Distributed routing will allow tenants the option of connecting Org Vdc networks to the Service Router. This would force all VM traffic through the service router for that network. Default false.
nsxtEdgegatewayId string
org string
The name of organization to which the VDC belongs. Optional if defined at provider level.
ownerId string

The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.

Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.

When a VDC Group ID is specified in owner_id field, the Edge Gateway will be created in VDC (random member of VDC Group or specified in starting_vdc_id). Main use case of starting_vdc_id is to pick egress traffic origin for multi datacenter VDC Groups.

startingVdcId string
If owner_id is a VDC Group, by default Edge Gateway will be created in random member VDC and moved to destination VDC Group. This field allows to specify initial VDC for Edge Gateway (this can define Egress location of traffic in the VDC Group) Note: It can only be used when owner_id is a VDC Group.
subnetWithIpCounts NsxtEdgegatewaySubnetWithIpCount[]
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnetWithTotalIpCounts NsxtEdgegatewaySubnetWithTotalIpCount[]
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnets NsxtEdgegatewaySubnet[]
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
totalAllocatedIpCount number
Required with subnet_with_total_ip_count. It is read-only attribute with other other allocation models subnet and subnet_with_ip_count. Note. It sets or reports IP count only for NSX-T Tier 0 backed external network Uplink.
vdc string
Deprecated in favor of owner_id. The name of VDC that owns the edge gateway. Can be inherited from provider configuration if not defined here.

Deprecated: Deprecated

external_network_id This property is required. str
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
dedicate_external_network bool
Dedicating the external network will enable Route Advertisement for this Edge Gateway. Default false.
deployment_mode str
ACTIVE_STANDBY (default) or DISTRIBUTED_ONLY (VCD 10.6+). Distributed-only does not provide services that run on service router such as firewalling, NAT, VPN, DNS forwarding or static routes, instead, the distributed nature guarantees high north-south data throughput.
description str
A unique name for the edge gateway.
edge_cluster_id str
Specific Edge Cluster ID if required
external_networks Sequence[NsxtEdgegatewayExternalNetworkArgs]
attaches NSX-T Segment backed External Networks with a given configuration block. It does not support IP Spaces.
ip_count_read_limit float

Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000, update is a no-op, but will affect newly read data. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.

name str
A unique name for the edge gateway.
non_distributed_routing_enabled bool
Non-Distributed routing will allow tenants the option of connecting Org Vdc networks to the Service Router. This would force all VM traffic through the service router for that network. Default false.
nsxt_edgegateway_id str
org str
The name of organization to which the VDC belongs. Optional if defined at provider level.
owner_id str

The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.

Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.

When a VDC Group ID is specified in owner_id field, the Edge Gateway will be created in VDC (random member of VDC Group or specified in starting_vdc_id). Main use case of starting_vdc_id is to pick egress traffic origin for multi datacenter VDC Groups.

starting_vdc_id str
If owner_id is a VDC Group, by default Edge Gateway will be created in random member VDC and moved to destination VDC Group. This field allows to specify initial VDC for Edge Gateway (this can define Egress location of traffic in the VDC Group) Note: It can only be used when owner_id is a VDC Group.
subnet_with_ip_counts Sequence[NsxtEdgegatewaySubnetWithIpCountArgs]
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnet_with_total_ip_counts Sequence[NsxtEdgegatewaySubnetWithTotalIpCountArgs]
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnets Sequence[NsxtEdgegatewaySubnetArgs]
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
total_allocated_ip_count float
Required with subnet_with_total_ip_count. It is read-only attribute with other other allocation models subnet and subnet_with_ip_count. Note. It sets or reports IP count only for NSX-T Tier 0 backed external network Uplink.
vdc str
Deprecated in favor of owner_id. The name of VDC that owns the edge gateway. Can be inherited from provider configuration if not defined here.

Deprecated: Deprecated

externalNetworkId This property is required. String
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
dedicateExternalNetwork Boolean
Dedicating the external network will enable Route Advertisement for this Edge Gateway. Default false.
deploymentMode String
ACTIVE_STANDBY (default) or DISTRIBUTED_ONLY (VCD 10.6+). Distributed-only does not provide services that run on service router such as firewalling, NAT, VPN, DNS forwarding or static routes, instead, the distributed nature guarantees high north-south data throughput.
description String
A unique name for the edge gateway.
edgeClusterId String
Specific Edge Cluster ID if required
externalNetworks List<Property Map>
attaches NSX-T Segment backed External Networks with a given configuration block. It does not support IP Spaces.
ipCountReadLimit Number

Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000, update is a no-op, but will affect newly read data. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.

name String
A unique name for the edge gateway.
nonDistributedRoutingEnabled Boolean
Non-Distributed routing will allow tenants the option of connecting Org Vdc networks to the Service Router. This would force all VM traffic through the service router for that network. Default false.
nsxtEdgegatewayId String
org String
The name of organization to which the VDC belongs. Optional if defined at provider level.
ownerId String

The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.

Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.

When a VDC Group ID is specified in owner_id field, the Edge Gateway will be created in VDC (random member of VDC Group or specified in starting_vdc_id). Main use case of starting_vdc_id is to pick egress traffic origin for multi datacenter VDC Groups.

startingVdcId String
If owner_id is a VDC Group, by default Edge Gateway will be created in random member VDC and moved to destination VDC Group. This field allows to specify initial VDC for Edge Gateway (this can define Egress location of traffic in the VDC Group) Note: It can only be used when owner_id is a VDC Group.
subnetWithIpCounts List<Property Map>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnetWithTotalIpCounts List<Property Map>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnets List<Property Map>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
totalAllocatedIpCount Number
Required with subnet_with_total_ip_count. It is read-only attribute with other other allocation models subnet and subnet_with_ip_count. Note. It sets or reports IP count only for NSX-T Tier 0 backed external network Uplink.
vdc String
Deprecated in favor of owner_id. The name of VDC that owns the edge gateway. Can be inherited from provider configuration if not defined here.

Deprecated: Deprecated

Outputs

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

ExternalNetworkAllocatedIpCount double
Total allocated IP count in attached NSX-T Segment backed external networks
Id string
The provider-assigned unique ID for this managed resource.
PrimaryIp string
Primary IP address exposed for an easy access without nesting.
UnusedIpCount double
Unused IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
UseIpSpaces bool
Boolean value that hints if the NSX-T Edge Gateway uses IP Spaces
UsedIpCount double
Used IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
ExternalNetworkAllocatedIpCount float64
Total allocated IP count in attached NSX-T Segment backed external networks
Id string
The provider-assigned unique ID for this managed resource.
PrimaryIp string
Primary IP address exposed for an easy access without nesting.
UnusedIpCount float64
Unused IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
UseIpSpaces bool
Boolean value that hints if the NSX-T Edge Gateway uses IP Spaces
UsedIpCount float64
Used IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
externalNetworkAllocatedIpCount Double
Total allocated IP count in attached NSX-T Segment backed external networks
id String
The provider-assigned unique ID for this managed resource.
primaryIp String
Primary IP address exposed for an easy access without nesting.
unusedIpCount Double
Unused IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
useIpSpaces Boolean
Boolean value that hints if the NSX-T Edge Gateway uses IP Spaces
usedIpCount Double
Used IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
externalNetworkAllocatedIpCount number
Total allocated IP count in attached NSX-T Segment backed external networks
id string
The provider-assigned unique ID for this managed resource.
primaryIp string
Primary IP address exposed for an easy access without nesting.
unusedIpCount number
Unused IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
useIpSpaces boolean
Boolean value that hints if the NSX-T Edge Gateway uses IP Spaces
usedIpCount number
Used IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
external_network_allocated_ip_count float
Total allocated IP count in attached NSX-T Segment backed external networks
id str
The provider-assigned unique ID for this managed resource.
primary_ip str
Primary IP address exposed for an easy access without nesting.
unused_ip_count float
Unused IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
use_ip_spaces bool
Boolean value that hints if the NSX-T Edge Gateway uses IP Spaces
used_ip_count float
Used IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
externalNetworkAllocatedIpCount Number
Total allocated IP count in attached NSX-T Segment backed external networks
id String
The provider-assigned unique ID for this managed resource.
primaryIp String
Primary IP address exposed for an easy access without nesting.
unusedIpCount Number
Unused IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
useIpSpaces Boolean
Boolean value that hints if the NSX-T Edge Gateway uses IP Spaces
usedIpCount Number
Used IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.

Look up Existing NsxtEdgegateway Resource

Get an existing NsxtEdgegateway 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?: NsxtEdgegatewayState, opts?: CustomResourceOptions): NsxtEdgegateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dedicate_external_network: Optional[bool] = None,
        deployment_mode: Optional[str] = None,
        description: Optional[str] = None,
        edge_cluster_id: Optional[str] = None,
        external_network_allocated_ip_count: Optional[float] = None,
        external_network_id: Optional[str] = None,
        external_networks: Optional[Sequence[NsxtEdgegatewayExternalNetworkArgs]] = None,
        ip_count_read_limit: Optional[float] = None,
        name: Optional[str] = None,
        non_distributed_routing_enabled: Optional[bool] = None,
        nsxt_edgegateway_id: Optional[str] = None,
        org: Optional[str] = None,
        owner_id: Optional[str] = None,
        primary_ip: Optional[str] = None,
        starting_vdc_id: Optional[str] = None,
        subnet_with_ip_counts: Optional[Sequence[NsxtEdgegatewaySubnetWithIpCountArgs]] = None,
        subnet_with_total_ip_counts: Optional[Sequence[NsxtEdgegatewaySubnetWithTotalIpCountArgs]] = None,
        subnets: Optional[Sequence[NsxtEdgegatewaySubnetArgs]] = None,
        total_allocated_ip_count: Optional[float] = None,
        unused_ip_count: Optional[float] = None,
        use_ip_spaces: Optional[bool] = None,
        used_ip_count: Optional[float] = None,
        vdc: Optional[str] = None) -> NsxtEdgegateway
func GetNsxtEdgegateway(ctx *Context, name string, id IDInput, state *NsxtEdgegatewayState, opts ...ResourceOption) (*NsxtEdgegateway, error)
public static NsxtEdgegateway Get(string name, Input<string> id, NsxtEdgegatewayState? state, CustomResourceOptions? opts = null)
public static NsxtEdgegateway get(String name, Output<String> id, NsxtEdgegatewayState state, CustomResourceOptions options)
resources:  _:    type: vcd:NsxtEdgegateway    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:
DedicateExternalNetwork bool
Dedicating the external network will enable Route Advertisement for this Edge Gateway. Default false.
DeploymentMode string
ACTIVE_STANDBY (default) or DISTRIBUTED_ONLY (VCD 10.6+). Distributed-only does not provide services that run on service router such as firewalling, NAT, VPN, DNS forwarding or static routes, instead, the distributed nature guarantees high north-south data throughput.
Description string
A unique name for the edge gateway.
EdgeClusterId string
Specific Edge Cluster ID if required
ExternalNetworkAllocatedIpCount double
Total allocated IP count in attached NSX-T Segment backed external networks
ExternalNetworkId string
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
ExternalNetworks List<NsxtEdgegatewayExternalNetwork>
attaches NSX-T Segment backed External Networks with a given configuration block. It does not support IP Spaces.
IpCountReadLimit double

Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000, update is a no-op, but will affect newly read data. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.

Name string
A unique name for the edge gateway.
NonDistributedRoutingEnabled bool
Non-Distributed routing will allow tenants the option of connecting Org Vdc networks to the Service Router. This would force all VM traffic through the service router for that network. Default false.
NsxtEdgegatewayId string
Org string
The name of organization to which the VDC belongs. Optional if defined at provider level.
OwnerId string

The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.

Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.

When a VDC Group ID is specified in owner_id field, the Edge Gateway will be created in VDC (random member of VDC Group or specified in starting_vdc_id). Main use case of starting_vdc_id is to pick egress traffic origin for multi datacenter VDC Groups.

PrimaryIp string
Primary IP address exposed for an easy access without nesting.
StartingVdcId string
If owner_id is a VDC Group, by default Edge Gateway will be created in random member VDC and moved to destination VDC Group. This field allows to specify initial VDC for Edge Gateway (this can define Egress location of traffic in the VDC Group) Note: It can only be used when owner_id is a VDC Group.
SubnetWithIpCounts List<NsxtEdgegatewaySubnetWithIpCount>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
SubnetWithTotalIpCounts List<NsxtEdgegatewaySubnetWithTotalIpCount>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
Subnets List<NsxtEdgegatewaySubnet>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
TotalAllocatedIpCount double
Required with subnet_with_total_ip_count. It is read-only attribute with other other allocation models subnet and subnet_with_ip_count. Note. It sets or reports IP count only for NSX-T Tier 0 backed external network Uplink.
UnusedIpCount double
Unused IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
UseIpSpaces bool
Boolean value that hints if the NSX-T Edge Gateway uses IP Spaces
UsedIpCount double
Used IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
Vdc string
Deprecated in favor of owner_id. The name of VDC that owns the edge gateway. Can be inherited from provider configuration if not defined here.

Deprecated: Deprecated

DedicateExternalNetwork bool
Dedicating the external network will enable Route Advertisement for this Edge Gateway. Default false.
DeploymentMode string
ACTIVE_STANDBY (default) or DISTRIBUTED_ONLY (VCD 10.6+). Distributed-only does not provide services that run on service router such as firewalling, NAT, VPN, DNS forwarding or static routes, instead, the distributed nature guarantees high north-south data throughput.
Description string
A unique name for the edge gateway.
EdgeClusterId string
Specific Edge Cluster ID if required
ExternalNetworkAllocatedIpCount float64
Total allocated IP count in attached NSX-T Segment backed external networks
ExternalNetworkId string
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
ExternalNetworks []NsxtEdgegatewayExternalNetworkArgs
attaches NSX-T Segment backed External Networks with a given configuration block. It does not support IP Spaces.
IpCountReadLimit float64

Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000, update is a no-op, but will affect newly read data. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.

Name string
A unique name for the edge gateway.
NonDistributedRoutingEnabled bool
Non-Distributed routing will allow tenants the option of connecting Org Vdc networks to the Service Router. This would force all VM traffic through the service router for that network. Default false.
NsxtEdgegatewayId string
Org string
The name of organization to which the VDC belongs. Optional if defined at provider level.
OwnerId string

The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.

Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.

When a VDC Group ID is specified in owner_id field, the Edge Gateway will be created in VDC (random member of VDC Group or specified in starting_vdc_id). Main use case of starting_vdc_id is to pick egress traffic origin for multi datacenter VDC Groups.

PrimaryIp string
Primary IP address exposed for an easy access without nesting.
StartingVdcId string
If owner_id is a VDC Group, by default Edge Gateway will be created in random member VDC and moved to destination VDC Group. This field allows to specify initial VDC for Edge Gateway (this can define Egress location of traffic in the VDC Group) Note: It can only be used when owner_id is a VDC Group.
SubnetWithIpCounts []NsxtEdgegatewaySubnetWithIpCountArgs
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
SubnetWithTotalIpCounts []NsxtEdgegatewaySubnetWithTotalIpCountArgs
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
Subnets []NsxtEdgegatewaySubnetArgs
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
TotalAllocatedIpCount float64
Required with subnet_with_total_ip_count. It is read-only attribute with other other allocation models subnet and subnet_with_ip_count. Note. It sets or reports IP count only for NSX-T Tier 0 backed external network Uplink.
UnusedIpCount float64
Unused IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
UseIpSpaces bool
Boolean value that hints if the NSX-T Edge Gateway uses IP Spaces
UsedIpCount float64
Used IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
Vdc string
Deprecated in favor of owner_id. The name of VDC that owns the edge gateway. Can be inherited from provider configuration if not defined here.

Deprecated: Deprecated

dedicateExternalNetwork Boolean
Dedicating the external network will enable Route Advertisement for this Edge Gateway. Default false.
deploymentMode String
ACTIVE_STANDBY (default) or DISTRIBUTED_ONLY (VCD 10.6+). Distributed-only does not provide services that run on service router such as firewalling, NAT, VPN, DNS forwarding or static routes, instead, the distributed nature guarantees high north-south data throughput.
description String
A unique name for the edge gateway.
edgeClusterId String
Specific Edge Cluster ID if required
externalNetworkAllocatedIpCount Double
Total allocated IP count in attached NSX-T Segment backed external networks
externalNetworkId String
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
externalNetworks List<NsxtEdgegatewayExternalNetwork>
attaches NSX-T Segment backed External Networks with a given configuration block. It does not support IP Spaces.
ipCountReadLimit Double

Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000, update is a no-op, but will affect newly read data. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.

name String
A unique name for the edge gateway.
nonDistributedRoutingEnabled Boolean
Non-Distributed routing will allow tenants the option of connecting Org Vdc networks to the Service Router. This would force all VM traffic through the service router for that network. Default false.
nsxtEdgegatewayId String
org String
The name of organization to which the VDC belongs. Optional if defined at provider level.
ownerId String

The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.

Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.

When a VDC Group ID is specified in owner_id field, the Edge Gateway will be created in VDC (random member of VDC Group or specified in starting_vdc_id). Main use case of starting_vdc_id is to pick egress traffic origin for multi datacenter VDC Groups.

primaryIp String
Primary IP address exposed for an easy access without nesting.
startingVdcId String
If owner_id is a VDC Group, by default Edge Gateway will be created in random member VDC and moved to destination VDC Group. This field allows to specify initial VDC for Edge Gateway (this can define Egress location of traffic in the VDC Group) Note: It can only be used when owner_id is a VDC Group.
subnetWithIpCounts List<NsxtEdgegatewaySubnetWithIpCount>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnetWithTotalIpCounts List<NsxtEdgegatewaySubnetWithTotalIpCount>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnets List<NsxtEdgegatewaySubnet>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
totalAllocatedIpCount Double
Required with subnet_with_total_ip_count. It is read-only attribute with other other allocation models subnet and subnet_with_ip_count. Note. It sets or reports IP count only for NSX-T Tier 0 backed external network Uplink.
unusedIpCount Double
Unused IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
useIpSpaces Boolean
Boolean value that hints if the NSX-T Edge Gateway uses IP Spaces
usedIpCount Double
Used IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
vdc String
Deprecated in favor of owner_id. The name of VDC that owns the edge gateway. Can be inherited from provider configuration if not defined here.

Deprecated: Deprecated

dedicateExternalNetwork boolean
Dedicating the external network will enable Route Advertisement for this Edge Gateway. Default false.
deploymentMode string
ACTIVE_STANDBY (default) or DISTRIBUTED_ONLY (VCD 10.6+). Distributed-only does not provide services that run on service router such as firewalling, NAT, VPN, DNS forwarding or static routes, instead, the distributed nature guarantees high north-south data throughput.
description string
A unique name for the edge gateway.
edgeClusterId string
Specific Edge Cluster ID if required
externalNetworkAllocatedIpCount number
Total allocated IP count in attached NSX-T Segment backed external networks
externalNetworkId string
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
externalNetworks NsxtEdgegatewayExternalNetwork[]
attaches NSX-T Segment backed External Networks with a given configuration block. It does not support IP Spaces.
ipCountReadLimit number

Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000, update is a no-op, but will affect newly read data. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.

name string
A unique name for the edge gateway.
nonDistributedRoutingEnabled boolean
Non-Distributed routing will allow tenants the option of connecting Org Vdc networks to the Service Router. This would force all VM traffic through the service router for that network. Default false.
nsxtEdgegatewayId string
org string
The name of organization to which the VDC belongs. Optional if defined at provider level.
ownerId string

The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.

Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.

When a VDC Group ID is specified in owner_id field, the Edge Gateway will be created in VDC (random member of VDC Group or specified in starting_vdc_id). Main use case of starting_vdc_id is to pick egress traffic origin for multi datacenter VDC Groups.

primaryIp string
Primary IP address exposed for an easy access without nesting.
startingVdcId string
If owner_id is a VDC Group, by default Edge Gateway will be created in random member VDC and moved to destination VDC Group. This field allows to specify initial VDC for Edge Gateway (this can define Egress location of traffic in the VDC Group) Note: It can only be used when owner_id is a VDC Group.
subnetWithIpCounts NsxtEdgegatewaySubnetWithIpCount[]
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnetWithTotalIpCounts NsxtEdgegatewaySubnetWithTotalIpCount[]
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnets NsxtEdgegatewaySubnet[]
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
totalAllocatedIpCount number
Required with subnet_with_total_ip_count. It is read-only attribute with other other allocation models subnet and subnet_with_ip_count. Note. It sets or reports IP count only for NSX-T Tier 0 backed external network Uplink.
unusedIpCount number
Unused IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
useIpSpaces boolean
Boolean value that hints if the NSX-T Edge Gateway uses IP Spaces
usedIpCount number
Used IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
vdc string
Deprecated in favor of owner_id. The name of VDC that owns the edge gateway. Can be inherited from provider configuration if not defined here.

Deprecated: Deprecated

dedicate_external_network bool
Dedicating the external network will enable Route Advertisement for this Edge Gateway. Default false.
deployment_mode str
ACTIVE_STANDBY (default) or DISTRIBUTED_ONLY (VCD 10.6+). Distributed-only does not provide services that run on service router such as firewalling, NAT, VPN, DNS forwarding or static routes, instead, the distributed nature guarantees high north-south data throughput.
description str
A unique name for the edge gateway.
edge_cluster_id str
Specific Edge Cluster ID if required
external_network_allocated_ip_count float
Total allocated IP count in attached NSX-T Segment backed external networks
external_network_id str
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
external_networks Sequence[NsxtEdgegatewayExternalNetworkArgs]
attaches NSX-T Segment backed External Networks with a given configuration block. It does not support IP Spaces.
ip_count_read_limit float

Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000, update is a no-op, but will affect newly read data. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.

name str
A unique name for the edge gateway.
non_distributed_routing_enabled bool
Non-Distributed routing will allow tenants the option of connecting Org Vdc networks to the Service Router. This would force all VM traffic through the service router for that network. Default false.
nsxt_edgegateway_id str
org str
The name of organization to which the VDC belongs. Optional if defined at provider level.
owner_id str

The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.

Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.

When a VDC Group ID is specified in owner_id field, the Edge Gateway will be created in VDC (random member of VDC Group or specified in starting_vdc_id). Main use case of starting_vdc_id is to pick egress traffic origin for multi datacenter VDC Groups.

primary_ip str
Primary IP address exposed for an easy access without nesting.
starting_vdc_id str
If owner_id is a VDC Group, by default Edge Gateway will be created in random member VDC and moved to destination VDC Group. This field allows to specify initial VDC for Edge Gateway (this can define Egress location of traffic in the VDC Group) Note: It can only be used when owner_id is a VDC Group.
subnet_with_ip_counts Sequence[NsxtEdgegatewaySubnetWithIpCountArgs]
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnet_with_total_ip_counts Sequence[NsxtEdgegatewaySubnetWithTotalIpCountArgs]
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnets Sequence[NsxtEdgegatewaySubnetArgs]
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
total_allocated_ip_count float
Required with subnet_with_total_ip_count. It is read-only attribute with other other allocation models subnet and subnet_with_ip_count. Note. It sets or reports IP count only for NSX-T Tier 0 backed external network Uplink.
unused_ip_count float
Unused IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
use_ip_spaces bool
Boolean value that hints if the NSX-T Edge Gateway uses IP Spaces
used_ip_count float
Used IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
vdc str
Deprecated in favor of owner_id. The name of VDC that owns the edge gateway. Can be inherited from provider configuration if not defined here.

Deprecated: Deprecated

dedicateExternalNetwork Boolean
Dedicating the external network will enable Route Advertisement for this Edge Gateway. Default false.
deploymentMode String
ACTIVE_STANDBY (default) or DISTRIBUTED_ONLY (VCD 10.6+). Distributed-only does not provide services that run on service router such as firewalling, NAT, VPN, DNS forwarding or static routes, instead, the distributed nature guarantees high north-south data throughput.
description String
A unique name for the edge gateway.
edgeClusterId String
Specific Edge Cluster ID if required
externalNetworkAllocatedIpCount Number
Total allocated IP count in attached NSX-T Segment backed external networks
externalNetworkId String
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
externalNetworks List<Property Map>
attaches NSX-T Segment backed External Networks with a given configuration block. It does not support IP Spaces.
ipCountReadLimit Number

Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000, update is a no-op, but will affect newly read data. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.

name String
A unique name for the edge gateway.
nonDistributedRoutingEnabled Boolean
Non-Distributed routing will allow tenants the option of connecting Org Vdc networks to the Service Router. This would force all VM traffic through the service router for that network. Default false.
nsxtEdgegatewayId String
org String
The name of organization to which the VDC belongs. Optional if defined at provider level.
ownerId String

The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.

Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.

When a VDC Group ID is specified in owner_id field, the Edge Gateway will be created in VDC (random member of VDC Group or specified in starting_vdc_id). Main use case of starting_vdc_id is to pick egress traffic origin for multi datacenter VDC Groups.

primaryIp String
Primary IP address exposed for an easy access without nesting.
startingVdcId String
If owner_id is a VDC Group, by default Edge Gateway will be created in random member VDC and moved to destination VDC Group. This field allows to specify initial VDC for Edge Gateway (this can define Egress location of traffic in the VDC Group) Note: It can only be used when owner_id is a VDC Group.
subnetWithIpCounts List<Property Map>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnetWithTotalIpCounts List<Property Map>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
subnets List<Property Map>
One or more subnets defined for Edge Gateway. One of subnet, subnet_with_total_ip_count or subnet_with_ip_count is required unless parent network is backed by IP Spaces. Read more in IP allocation modes section.
totalAllocatedIpCount Number
Required with subnet_with_total_ip_count. It is read-only attribute with other other allocation models subnet and subnet_with_ip_count. Note. It sets or reports IP count only for NSX-T Tier 0 backed external network Uplink.
unusedIpCount Number
Unused IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
useIpSpaces Boolean
Boolean value that hints if the NSX-T Edge Gateway uses IP Spaces
usedIpCount Number
Used IP count in this Edge Gateway (for all uplinks). Note: it is not exposed when using IP Spaces.
vdc String
Deprecated in favor of owner_id. The name of VDC that owns the edge gateway. Can be inherited from provider configuration if not defined here.

Deprecated: Deprecated

Supporting Types

NsxtEdgegatewayExternalNetwork
, NsxtEdgegatewayExternalNetworkArgs

AllocatedIpCount This property is required. double
Number of allocated IPs
ExternalNetworkId This property is required. string
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
Gateway This property is required. string
Gateway IP Address
PrefixLength This property is required. double
Prefix length for a subnet (e.g. 24)
PrimaryIp string
Primary IP address exposed for an easy access without nesting.
AllocatedIpCount This property is required. float64
Number of allocated IPs
ExternalNetworkId This property is required. string
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
Gateway This property is required. string
Gateway IP Address
PrefixLength This property is required. float64
Prefix length for a subnet (e.g. 24)
PrimaryIp string
Primary IP address exposed for an easy access without nesting.
allocatedIpCount This property is required. Double
Number of allocated IPs
externalNetworkId This property is required. String
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
gateway This property is required. String
Gateway IP Address
prefixLength This property is required. Double
Prefix length for a subnet (e.g. 24)
primaryIp String
Primary IP address exposed for an easy access without nesting.
allocatedIpCount This property is required. number
Number of allocated IPs
externalNetworkId This property is required. string
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
gateway This property is required. string
Gateway IP Address
prefixLength This property is required. number
Prefix length for a subnet (e.g. 24)
primaryIp string
Primary IP address exposed for an easy access without nesting.
allocated_ip_count This property is required. float
Number of allocated IPs
external_network_id This property is required. str
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
gateway This property is required. str
Gateway IP Address
prefix_length This property is required. float
Prefix length for a subnet (e.g. 24)
primary_ip str
Primary IP address exposed for an easy access without nesting.
allocatedIpCount This property is required. Number
Number of allocated IPs
externalNetworkId This property is required. String
An external network ID. Note: Data source vcd.ExternalNetworkV2 can be used to lookup ID by name.
gateway This property is required. String
Gateway IP Address
prefixLength This property is required. Number
Prefix length for a subnet (e.g. 24)
primaryIp String
Primary IP address exposed for an easy access without nesting.

NsxtEdgegatewaySubnet
, NsxtEdgegatewaySubnetArgs

Gateway This property is required. string
Gateway address for a subnet
PrefixLength This property is required. double
Prefix length for a subnet (e.g. 24)
AllocatedIps List<NsxtEdgegatewaySubnetAllocatedIp>
Define one or more blocks to sub-allocate pools on the edge gateway
PrimaryIp string
Primary IP address exposed for an easy access without nesting.
Gateway This property is required. string
Gateway address for a subnet
PrefixLength This property is required. float64
Prefix length for a subnet (e.g. 24)
AllocatedIps []NsxtEdgegatewaySubnetAllocatedIp
Define one or more blocks to sub-allocate pools on the edge gateway
PrimaryIp string
Primary IP address exposed for an easy access without nesting.
gateway This property is required. String
Gateway address for a subnet
prefixLength This property is required. Double
Prefix length for a subnet (e.g. 24)
allocatedIps List<NsxtEdgegatewaySubnetAllocatedIp>
Define one or more blocks to sub-allocate pools on the edge gateway
primaryIp String
Primary IP address exposed for an easy access without nesting.
gateway This property is required. string
Gateway address for a subnet
prefixLength This property is required. number
Prefix length for a subnet (e.g. 24)
allocatedIps NsxtEdgegatewaySubnetAllocatedIp[]
Define one or more blocks to sub-allocate pools on the edge gateway
primaryIp string
Primary IP address exposed for an easy access without nesting.
gateway This property is required. str
Gateway address for a subnet
prefix_length This property is required. float
Prefix length for a subnet (e.g. 24)
allocated_ips Sequence[NsxtEdgegatewaySubnetAllocatedIp]
Define one or more blocks to sub-allocate pools on the edge gateway
primary_ip str
Primary IP address exposed for an easy access without nesting.
gateway This property is required. String
Gateway address for a subnet
prefixLength This property is required. Number
Prefix length for a subnet (e.g. 24)
allocatedIps List<Property Map>
Define one or more blocks to sub-allocate pools on the edge gateway
primaryIp String
Primary IP address exposed for an easy access without nesting.

NsxtEdgegatewaySubnetAllocatedIp
, NsxtEdgegatewaySubnetAllocatedIpArgs

EndAddress This property is required. string
StartAddress This property is required. string
EndAddress This property is required. string
StartAddress This property is required. string
endAddress This property is required. String
startAddress This property is required. String
endAddress This property is required. string
startAddress This property is required. string
end_address This property is required. str
start_address This property is required. str
endAddress This property is required. String
startAddress This property is required. String

NsxtEdgegatewaySubnetWithIpCount
, NsxtEdgegatewaySubnetWithIpCountArgs

AllocatedIpCount This property is required. double
Number of IP addresses to allocate
Gateway This property is required. string
Gateway address for a subnet
PrefixLength This property is required. double
Prefix length for a subnet (e.g. 24)
PrimaryIp string
Primary IP address exposed for an easy access without nesting.
AllocatedIpCount This property is required. float64
Number of IP addresses to allocate
Gateway This property is required. string
Gateway address for a subnet
PrefixLength This property is required. float64
Prefix length for a subnet (e.g. 24)
PrimaryIp string
Primary IP address exposed for an easy access without nesting.
allocatedIpCount This property is required. Double
Number of IP addresses to allocate
gateway This property is required. String
Gateway address for a subnet
prefixLength This property is required. Double
Prefix length for a subnet (e.g. 24)
primaryIp String
Primary IP address exposed for an easy access without nesting.
allocatedIpCount This property is required. number
Number of IP addresses to allocate
gateway This property is required. string
Gateway address for a subnet
prefixLength This property is required. number
Prefix length for a subnet (e.g. 24)
primaryIp string
Primary IP address exposed for an easy access without nesting.
allocated_ip_count This property is required. float
Number of IP addresses to allocate
gateway This property is required. str
Gateway address for a subnet
prefix_length This property is required. float
Prefix length for a subnet (e.g. 24)
primary_ip str
Primary IP address exposed for an easy access without nesting.
allocatedIpCount This property is required. Number
Number of IP addresses to allocate
gateway This property is required. String
Gateway address for a subnet
prefixLength This property is required. Number
Prefix length for a subnet (e.g. 24)
primaryIp String
Primary IP address exposed for an easy access without nesting.

NsxtEdgegatewaySubnetWithTotalIpCount
, NsxtEdgegatewaySubnetWithTotalIpCountArgs

Gateway This property is required. string
Gateway address for a subnet
PrefixLength This property is required. double
Prefix length for a subnet (e.g. 24)
PrimaryIp string
Primary IP address exposed for an easy access without nesting.
Gateway This property is required. string
Gateway address for a subnet
PrefixLength This property is required. float64
Prefix length for a subnet (e.g. 24)
PrimaryIp string
Primary IP address exposed for an easy access without nesting.
gateway This property is required. String
Gateway address for a subnet
prefixLength This property is required. Double
Prefix length for a subnet (e.g. 24)
primaryIp String
Primary IP address exposed for an easy access without nesting.
gateway This property is required. string
Gateway address for a subnet
prefixLength This property is required. number
Prefix length for a subnet (e.g. 24)
primaryIp string
Primary IP address exposed for an easy access without nesting.
gateway This property is required. str
Gateway address for a subnet
prefix_length This property is required. float
Prefix length for a subnet (e.g. 24)
primary_ip str
Primary IP address exposed for an easy access without nesting.
gateway This property is required. String
Gateway address for a subnet
prefixLength This property is required. Number
Prefix length for a subnet (e.g. 24)
primaryIp String
Primary IP address exposed for an easy access without nesting.

Package Details

Repository
vcd vmware/terraform-provider-vcd
License
Notes
This Pulumi package is based on the vcd Terraform Provider.
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd