published on Monday, May 18, 2026 by vmware
published on Monday, May 18, 2026 by vmware
Create PolicyDistributedVlanConnection Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PolicyDistributedVlanConnection(name: string, args: PolicyDistributedVlanConnectionArgs, opts?: CustomResourceOptions);@overload
def PolicyDistributedVlanConnection(resource_name: str,
args: PolicyDistributedVlanConnectionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PolicyDistributedVlanConnection(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
vlan_id: Optional[float] = None,
associated_ip_block_paths: Optional[Sequence[str]] = None,
description: Optional[str] = None,
gateway_addresses: Optional[Sequence[str]] = None,
nsx_id: Optional[str] = None,
policy_distributed_vlan_connection_id: Optional[str] = None,
subnet_extension_connection: Optional[str] = None,
tags: Optional[Sequence[PolicyDistributedVlanConnectionTagArgs]] = None)func NewPolicyDistributedVlanConnection(ctx *Context, name string, args PolicyDistributedVlanConnectionArgs, opts ...ResourceOption) (*PolicyDistributedVlanConnection, error)public PolicyDistributedVlanConnection(string name, PolicyDistributedVlanConnectionArgs args, CustomResourceOptions? opts = null)
public PolicyDistributedVlanConnection(String name, PolicyDistributedVlanConnectionArgs args)
public PolicyDistributedVlanConnection(String name, PolicyDistributedVlanConnectionArgs args, CustomResourceOptions options)
type: nsxt:PolicyDistributedVlanConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "nsxt_policydistributedvlanconnection" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args PolicyDistributedVlanConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PolicyDistributedVlanConnectionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PolicyDistributedVlanConnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PolicyDistributedVlanConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PolicyDistributedVlanConnectionArgs
- 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 policyDistributedVlanConnectionResource = new Nsxt.PolicyDistributedVlanConnection("policyDistributedVlanConnectionResource", new()
{
DisplayName = "string",
VlanId = 0,
AssociatedIpBlockPaths = new[]
{
"string",
},
Description = "string",
GatewayAddresses = new[]
{
"string",
},
NsxId = "string",
PolicyDistributedVlanConnectionId = "string",
SubnetExtensionConnection = "string",
Tags = new[]
{
new Nsxt.Inputs.PolicyDistributedVlanConnectionTagArgs
{
Scope = "string",
Tag = "string",
},
},
});
example, err := nsxt.NewPolicyDistributedVlanConnection(ctx, "policyDistributedVlanConnectionResource", &nsxt.PolicyDistributedVlanConnectionArgs{
DisplayName: pulumi.String("string"),
VlanId: pulumi.Float64(0),
AssociatedIpBlockPaths: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
GatewayAddresses: pulumi.StringArray{
pulumi.String("string"),
},
NsxId: pulumi.String("string"),
PolicyDistributedVlanConnectionId: pulumi.String("string"),
SubnetExtensionConnection: pulumi.String("string"),
Tags: nsxt.PolicyDistributedVlanConnectionTagArray{
&nsxt.PolicyDistributedVlanConnectionTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
})
resource "nsxt_policydistributedvlanconnection" "policyDistributedVlanConnectionResource" {
display_name = "string"
vlan_id = 0
associated_ip_block_paths = ["string"]
description = "string"
gateway_addresses = ["string"]
nsx_id = "string"
policy_distributed_vlan_connection_id = "string"
subnet_extension_connection = "string"
tags {
scope = "string"
tag = "string"
}
}
var policyDistributedVlanConnectionResource = new PolicyDistributedVlanConnection("policyDistributedVlanConnectionResource", PolicyDistributedVlanConnectionArgs.builder()
.displayName("string")
.vlanId(0.0)
.associatedIpBlockPaths("string")
.description("string")
.gatewayAddresses("string")
.nsxId("string")
.policyDistributedVlanConnectionId("string")
.subnetExtensionConnection("string")
.tags(PolicyDistributedVlanConnectionTagArgs.builder()
.scope("string")
.tag("string")
.build())
.build());
policy_distributed_vlan_connection_resource = nsxt.PolicyDistributedVlanConnection("policyDistributedVlanConnectionResource",
display_name="string",
vlan_id=float(0),
associated_ip_block_paths=["string"],
description="string",
gateway_addresses=["string"],
nsx_id="string",
policy_distributed_vlan_connection_id="string",
subnet_extension_connection="string",
tags=[{
"scope": "string",
"tag": "string",
}])
const policyDistributedVlanConnectionResource = new nsxt.PolicyDistributedVlanConnection("policyDistributedVlanConnectionResource", {
displayName: "string",
vlanId: 0,
associatedIpBlockPaths: ["string"],
description: "string",
gatewayAddresses: ["string"],
nsxId: "string",
policyDistributedVlanConnectionId: "string",
subnetExtensionConnection: "string",
tags: [{
scope: "string",
tag: "string",
}],
});
type: nsxt:PolicyDistributedVlanConnection
properties:
associatedIpBlockPaths:
- string
description: string
displayName: string
gatewayAddresses:
- string
nsxId: string
policyDistributedVlanConnectionId: string
subnetExtensionConnection: string
tags:
- scope: string
tag: string
vlanId: 0
PolicyDistributedVlanConnection 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 PolicyDistributedVlanConnection resource accepts the following input properties:
- Display
Name string - Display name of the resource.
- Vlan
Id double - Vlan id for external gateway traffic.
- Associated
Ip List<string>Block Paths - List of IP address block(s) that are associated with the distributed vlan connection. This attribute is supported with NSX 9.1.0 onwards.
- Description string
- Description of the resource.
- Gateway
Addresses List<string> - List of gateway addresses in CIDR format. Only one gateway IP CIDR is allowed for subnet exclusive configuration.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Policy
Distributed stringVlan Connection Id - ID of the resource.
- Subnet
Extension stringConnection - Controls the connectivity mode for VPC Subnets referencing this distributed VLAN connection. This can be one of
DISABLED,ENABLED_L2, orENABLED_L2_AND_L3. Default isDISABLED. This attribute is supported with NSX 9.1.0 onwards. -
List<Policy
Distributed Vlan Connection Tag> - A list of scope + tag pairs to associate with this resource.
- Display
Name string - Display name of the resource.
- Vlan
Id float64 - Vlan id for external gateway traffic.
- Associated
Ip []stringBlock Paths - List of IP address block(s) that are associated with the distributed vlan connection. This attribute is supported with NSX 9.1.0 onwards.
- Description string
- Description of the resource.
- Gateway
Addresses []string - List of gateway addresses in CIDR format. Only one gateway IP CIDR is allowed for subnet exclusive configuration.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Policy
Distributed stringVlan Connection Id - ID of the resource.
- Subnet
Extension stringConnection - Controls the connectivity mode for VPC Subnets referencing this distributed VLAN connection. This can be one of
DISABLED,ENABLED_L2, orENABLED_L2_AND_L3. Default isDISABLED. This attribute is supported with NSX 9.1.0 onwards. -
[]Policy
Distributed Vlan Connection Tag Args - A list of scope + tag pairs to associate with this resource.
- display_
name string - Display name of the resource.
- vlan_
id number - Vlan id for external gateway traffic.
- associated_
ip_ list(string)block_ paths - List of IP address block(s) that are associated with the distributed vlan connection. This attribute is supported with NSX 9.1.0 onwards.
- description string
- Description of the resource.
- gateway_
addresses list(string) - List of gateway addresses in CIDR format. Only one gateway IP CIDR is allowed for subnet exclusive configuration.
- nsx_
id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy_
distributed_ stringvlan_ connection_ id - ID of the resource.
- subnet_
extension_ stringconnection - Controls the connectivity mode for VPC Subnets referencing this distributed VLAN connection. This can be one of
DISABLED,ENABLED_L2, orENABLED_L2_AND_L3. Default isDISABLED. This attribute is supported with NSX 9.1.0 onwards. - list(object)
- A list of scope + tag pairs to associate with this resource.
- display
Name String - Display name of the resource.
- vlan
Id Double - Vlan id for external gateway traffic.
- associated
Ip List<String>Block Paths - List of IP address block(s) that are associated with the distributed vlan connection. This attribute is supported with NSX 9.1.0 onwards.
- description String
- Description of the resource.
- gateway
Addresses List<String> - List of gateway addresses in CIDR format. Only one gateway IP CIDR is allowed for subnet exclusive configuration.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy
Distributed StringVlan Connection Id - ID of the resource.
- subnet
Extension StringConnection - Controls the connectivity mode for VPC Subnets referencing this distributed VLAN connection. This can be one of
DISABLED,ENABLED_L2, orENABLED_L2_AND_L3. Default isDISABLED. This attribute is supported with NSX 9.1.0 onwards. -
List<Policy
Distributed Vlan Connection Tag> - A list of scope + tag pairs to associate with this resource.
- display
Name string - Display name of the resource.
- vlan
Id number - Vlan id for external gateway traffic.
- associated
Ip string[]Block Paths - List of IP address block(s) that are associated with the distributed vlan connection. This attribute is supported with NSX 9.1.0 onwards.
- description string
- Description of the resource.
- gateway
Addresses string[] - List of gateway addresses in CIDR format. Only one gateway IP CIDR is allowed for subnet exclusive configuration.
- nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy
Distributed stringVlan Connection Id - ID of the resource.
- subnet
Extension stringConnection - Controls the connectivity mode for VPC Subnets referencing this distributed VLAN connection. This can be one of
DISABLED,ENABLED_L2, orENABLED_L2_AND_L3. Default isDISABLED. This attribute is supported with NSX 9.1.0 onwards. -
Policy
Distributed Vlan Connection Tag[] - A list of scope + tag pairs to associate with this resource.
- display_
name str - Display name of the resource.
- vlan_
id float - Vlan id for external gateway traffic.
- associated_
ip_ Sequence[str]block_ paths - List of IP address block(s) that are associated with the distributed vlan connection. This attribute is supported with NSX 9.1.0 onwards.
- description str
- Description of the resource.
- gateway_
addresses Sequence[str] - List of gateway addresses in CIDR format. Only one gateway IP CIDR is allowed for subnet exclusive configuration.
- nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy_
distributed_ strvlan_ connection_ id - ID of the resource.
- subnet_
extension_ strconnection - Controls the connectivity mode for VPC Subnets referencing this distributed VLAN connection. This can be one of
DISABLED,ENABLED_L2, orENABLED_L2_AND_L3. Default isDISABLED. This attribute is supported with NSX 9.1.0 onwards. -
Sequence[Policy
Distributed Vlan Connection Tag Args] - A list of scope + tag pairs to associate with this resource.
- display
Name String - Display name of the resource.
- vlan
Id Number - Vlan id for external gateway traffic.
- associated
Ip List<String>Block Paths - List of IP address block(s) that are associated with the distributed vlan connection. This attribute is supported with NSX 9.1.0 onwards.
- description String
- Description of the resource.
- gateway
Addresses List<String> - List of gateway addresses in CIDR format. Only one gateway IP CIDR is allowed for subnet exclusive configuration.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy
Distributed StringVlan Connection Id - ID of the resource.
- subnet
Extension StringConnection - Controls the connectivity mode for VPC Subnets referencing this distributed VLAN connection. This can be one of
DISABLED,ENABLED_L2, orENABLED_L2_AND_L3. Default isDISABLED. This attribute is supported with NSX 9.1.0 onwards. - List<Property Map>
- A list of scope + tag pairs to associate with this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the PolicyDistributedVlanConnection resource produces the following output properties:
Look up Existing PolicyDistributedVlanConnection Resource
Get an existing PolicyDistributedVlanConnection 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?: PolicyDistributedVlanConnectionState, opts?: CustomResourceOptions): PolicyDistributedVlanConnection@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
associated_ip_block_paths: Optional[Sequence[str]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
gateway_addresses: Optional[Sequence[str]] = None,
nsx_id: Optional[str] = None,
path: Optional[str] = None,
policy_distributed_vlan_connection_id: Optional[str] = None,
revision: Optional[float] = None,
subnet_extension_connection: Optional[str] = None,
tags: Optional[Sequence[PolicyDistributedVlanConnectionTagArgs]] = None,
vlan_id: Optional[float] = None) -> PolicyDistributedVlanConnectionfunc GetPolicyDistributedVlanConnection(ctx *Context, name string, id IDInput, state *PolicyDistributedVlanConnectionState, opts ...ResourceOption) (*PolicyDistributedVlanConnection, error)public static PolicyDistributedVlanConnection Get(string name, Input<string> id, PolicyDistributedVlanConnectionState? state, CustomResourceOptions? opts = null)public static PolicyDistributedVlanConnection get(String name, Output<String> id, PolicyDistributedVlanConnectionState state, CustomResourceOptions options)resources: _: type: nsxt:PolicyDistributedVlanConnection get: id: ${id}import {
to = nsxt_policydistributedvlanconnection.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Associated
Ip List<string>Block Paths - List of IP address block(s) that are associated with the distributed vlan connection. This attribute is supported with NSX 9.1.0 onwards.
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Gateway
Addresses List<string> - List of gateway addresses in CIDR format. Only one gateway IP CIDR is allowed for subnet exclusive configuration.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Path string
- The NSX path of the policy resource.
- Policy
Distributed stringVlan Connection Id - ID of the resource.
- Revision double
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- Subnet
Extension stringConnection - Controls the connectivity mode for VPC Subnets referencing this distributed VLAN connection. This can be one of
DISABLED,ENABLED_L2, orENABLED_L2_AND_L3. Default isDISABLED. This attribute is supported with NSX 9.1.0 onwards. -
List<Policy
Distributed Vlan Connection Tag> - A list of scope + tag pairs to associate with this resource.
- Vlan
Id double - Vlan id for external gateway traffic.
- Associated
Ip []stringBlock Paths - List of IP address block(s) that are associated with the distributed vlan connection. This attribute is supported with NSX 9.1.0 onwards.
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Gateway
Addresses []string - List of gateway addresses in CIDR format. Only one gateway IP CIDR is allowed for subnet exclusive configuration.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Path string
- The NSX path of the policy resource.
- Policy
Distributed stringVlan Connection Id - ID of the resource.
- Revision float64
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- Subnet
Extension stringConnection - Controls the connectivity mode for VPC Subnets referencing this distributed VLAN connection. This can be one of
DISABLED,ENABLED_L2, orENABLED_L2_AND_L3. Default isDISABLED. This attribute is supported with NSX 9.1.0 onwards. -
[]Policy
Distributed Vlan Connection Tag Args - A list of scope + tag pairs to associate with this resource.
- Vlan
Id float64 - Vlan id for external gateway traffic.
- associated_
ip_ list(string)block_ paths - List of IP address block(s) that are associated with the distributed vlan connection. This attribute is supported with NSX 9.1.0 onwards.
- description string
- Description of the resource.
- display_
name string - Display name of the resource.
- gateway_
addresses list(string) - List of gateway addresses in CIDR format. Only one gateway IP CIDR is allowed for subnet exclusive configuration.
- nsx_
id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path string
- The NSX path of the policy resource.
- policy_
distributed_ stringvlan_ connection_ id - ID of the resource.
- revision number
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- subnet_
extension_ stringconnection - Controls the connectivity mode for VPC Subnets referencing this distributed VLAN connection. This can be one of
DISABLED,ENABLED_L2, orENABLED_L2_AND_L3. Default isDISABLED. This attribute is supported with NSX 9.1.0 onwards. - list(object)
- A list of scope + tag pairs to associate with this resource.
- vlan_
id number - Vlan id for external gateway traffic.
- associated
Ip List<String>Block Paths - List of IP address block(s) that are associated with the distributed vlan connection. This attribute is supported with NSX 9.1.0 onwards.
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- gateway
Addresses List<String> - List of gateway addresses in CIDR format. Only one gateway IP CIDR is allowed for subnet exclusive configuration.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path String
- The NSX path of the policy resource.
- policy
Distributed StringVlan Connection Id - ID of the resource.
- revision Double
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- subnet
Extension StringConnection - Controls the connectivity mode for VPC Subnets referencing this distributed VLAN connection. This can be one of
DISABLED,ENABLED_L2, orENABLED_L2_AND_L3. Default isDISABLED. This attribute is supported with NSX 9.1.0 onwards. -
List<Policy
Distributed Vlan Connection Tag> - A list of scope + tag pairs to associate with this resource.
- vlan
Id Double - Vlan id for external gateway traffic.
- associated
Ip string[]Block Paths - List of IP address block(s) that are associated with the distributed vlan connection. This attribute is supported with NSX 9.1.0 onwards.
- description string
- Description of the resource.
- display
Name string - Display name of the resource.
- gateway
Addresses string[] - List of gateway addresses in CIDR format. Only one gateway IP CIDR is allowed for subnet exclusive configuration.
- nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path string
- The NSX path of the policy resource.
- policy
Distributed stringVlan Connection Id - ID of the resource.
- revision number
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- subnet
Extension stringConnection - Controls the connectivity mode for VPC Subnets referencing this distributed VLAN connection. This can be one of
DISABLED,ENABLED_L2, orENABLED_L2_AND_L3. Default isDISABLED. This attribute is supported with NSX 9.1.0 onwards. -
Policy
Distributed Vlan Connection Tag[] - A list of scope + tag pairs to associate with this resource.
- vlan
Id number - Vlan id for external gateway traffic.
- associated_
ip_ Sequence[str]block_ paths - List of IP address block(s) that are associated with the distributed vlan connection. This attribute is supported with NSX 9.1.0 onwards.
- description str
- Description of the resource.
- display_
name str - Display name of the resource.
- gateway_
addresses Sequence[str] - List of gateway addresses in CIDR format. Only one gateway IP CIDR is allowed for subnet exclusive configuration.
- nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path str
- The NSX path of the policy resource.
- policy_
distributed_ strvlan_ connection_ id - ID of the resource.
- revision float
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- subnet_
extension_ strconnection - Controls the connectivity mode for VPC Subnets referencing this distributed VLAN connection. This can be one of
DISABLED,ENABLED_L2, orENABLED_L2_AND_L3. Default isDISABLED. This attribute is supported with NSX 9.1.0 onwards. -
Sequence[Policy
Distributed Vlan Connection Tag Args] - A list of scope + tag pairs to associate with this resource.
- vlan_
id float - Vlan id for external gateway traffic.
- associated
Ip List<String>Block Paths - List of IP address block(s) that are associated with the distributed vlan connection. This attribute is supported with NSX 9.1.0 onwards.
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- gateway
Addresses List<String> - List of gateway addresses in CIDR format. Only one gateway IP CIDR is allowed for subnet exclusive configuration.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path String
- The NSX path of the policy resource.
- policy
Distributed StringVlan Connection Id - ID of the resource.
- revision Number
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- subnet
Extension StringConnection - Controls the connectivity mode for VPC Subnets referencing this distributed VLAN connection. This can be one of
DISABLED,ENABLED_L2, orENABLED_L2_AND_L3. Default isDISABLED. This attribute is supported with NSX 9.1.0 onwards. - List<Property Map>
- A list of scope + tag pairs to associate with this resource.
- vlan
Id Number - Vlan id for external gateway traffic.
Supporting Types
PolicyDistributedVlanConnectionTag, PolicyDistributedVlanConnectionTagArgs
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxtTerraform Provider.
published on Monday, May 18, 2026 by vmware