published on Friday, Sep 11, 2026 by vmware
published on Friday, Sep 11, 2026 by vmware
Create PolicyDistributedVxlanConnection Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PolicyDistributedVxlanConnection(name: string, args: PolicyDistributedVxlanConnectionArgs, opts?: CustomResourceOptions);@overload
def PolicyDistributedVxlanConnection(resource_name: str,
args: PolicyDistributedVxlanConnectionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PolicyDistributedVxlanConnection(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
l3_vni: Optional[float] = None,
route_controller_path: Optional[str] = None,
route_distinguisher: Optional[str] = None,
route_target: Optional[PolicyDistributedVxlanConnectionRouteTargetArgs] = None,
connectivity_type: Optional[str] = None,
description: Optional[str] = None,
nsx_id: Optional[str] = None,
policy_distributed_vxlan_connection_id: Optional[str] = None,
tags: Optional[Sequence[PolicyDistributedVxlanConnectionTagArgs]] = None)func NewPolicyDistributedVxlanConnection(ctx *Context, name string, args PolicyDistributedVxlanConnectionArgs, opts ...ResourceOption) (*PolicyDistributedVxlanConnection, error)public PolicyDistributedVxlanConnection(string name, PolicyDistributedVxlanConnectionArgs args, CustomResourceOptions? opts = null)
public PolicyDistributedVxlanConnection(String name, PolicyDistributedVxlanConnectionArgs args)
public PolicyDistributedVxlanConnection(String name, PolicyDistributedVxlanConnectionArgs args, CustomResourceOptions options)
type: nsxt:PolicyDistributedVxlanConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "nsxt_policy_distributed_vxlan_connection" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args PolicyDistributedVxlanConnectionArgs
- 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 PolicyDistributedVxlanConnectionArgs
- 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 PolicyDistributedVxlanConnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PolicyDistributedVxlanConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PolicyDistributedVxlanConnectionArgs
- 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 policyDistributedVxlanConnectionResource = new Nsxt.PolicyDistributedVxlanConnection("policyDistributedVxlanConnectionResource", new()
{
DisplayName = "string",
L3Vni = 0.0,
RouteControllerPath = "string",
RouteDistinguisher = "string",
RouteTarget = new Nsxt.Inputs.PolicyDistributedVxlanConnectionRouteTargetArgs
{
AddressFamily = "string",
ExportTargets = new[]
{
"string",
},
ImportTargets = new[]
{
"string",
},
},
ConnectivityType = "string",
Description = "string",
NsxId = "string",
PolicyDistributedVxlanConnectionId = "string",
Tags = new[]
{
new Nsxt.Inputs.PolicyDistributedVxlanConnectionTagArgs
{
Scope = "string",
Tag = "string",
},
},
});
example, err := nsxt.NewPolicyDistributedVxlanConnection(ctx, "policyDistributedVxlanConnectionResource", &nsxt.PolicyDistributedVxlanConnectionArgs{
DisplayName: pulumi.String("string"),
L3Vni: pulumi.Float64(0),
RouteControllerPath: pulumi.String("string"),
RouteDistinguisher: pulumi.String("string"),
RouteTarget: &nsxt.PolicyDistributedVxlanConnectionRouteTargetArgs{
AddressFamily: pulumi.String("string"),
ExportTargets: pulumi.StringArray{
pulumi.String("string"),
},
ImportTargets: pulumi.StringArray{
pulumi.String("string"),
},
},
ConnectivityType: pulumi.String("string"),
Description: pulumi.String("string"),
NsxId: pulumi.String("string"),
PolicyDistributedVxlanConnectionId: pulumi.String("string"),
Tags: nsxt.PolicyDistributedVxlanConnectionTagArray{
&nsxt.PolicyDistributedVxlanConnectionTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
})
resource "nsxt_policy_distributed_vxlan_connection" "policyDistributedVxlanConnectionResource" {
lifecycle {
create_before_destroy = true
}
display_name = "string"
l3_vni = 0
route_controller_path = "string"
route_distinguisher = "string"
route_target = {
address_family = "string"
export_targets = ["string"]
import_targets = ["string"]
}
connectivity_type = "string"
description = "string"
nsx_id = "string"
policy_distributed_vxlan_connection_id = "string"
tags {
scope = "string"
tag = "string"
}
}
var policyDistributedVxlanConnectionResource = new PolicyDistributedVxlanConnection("policyDistributedVxlanConnectionResource", PolicyDistributedVxlanConnectionArgs.builder()
.displayName("string")
.l3Vni(0.0)
.routeControllerPath("string")
.routeDistinguisher("string")
.routeTarget(PolicyDistributedVxlanConnectionRouteTargetArgs.builder()
.addressFamily("string")
.exportTargets("string")
.importTargets("string")
.build())
.connectivityType("string")
.description("string")
.nsxId("string")
.policyDistributedVxlanConnectionId("string")
.tags(PolicyDistributedVxlanConnectionTagArgs.builder()
.scope("string")
.tag("string")
.build())
.build());
policy_distributed_vxlan_connection_resource = nsxt.PolicyDistributedVxlanConnection("policyDistributedVxlanConnectionResource",
display_name="string",
l3_vni=float(0),
route_controller_path="string",
route_distinguisher="string",
route_target={
"address_family": "string",
"export_targets": ["string"],
"import_targets": ["string"],
},
connectivity_type="string",
description="string",
nsx_id="string",
policy_distributed_vxlan_connection_id="string",
tags=[{
"scope": "string",
"tag": "string",
}])
const policyDistributedVxlanConnectionResource = new nsxt.PolicyDistributedVxlanConnection("policyDistributedVxlanConnectionResource", {
displayName: "string",
l3Vni: 0,
routeControllerPath: "string",
routeDistinguisher: "string",
routeTarget: {
addressFamily: "string",
exportTargets: ["string"],
importTargets: ["string"],
},
connectivityType: "string",
description: "string",
nsxId: "string",
policyDistributedVxlanConnectionId: "string",
tags: [{
scope: "string",
tag: "string",
}],
});
type: nsxt:PolicyDistributedVxlanConnection
properties:
connectivityType: string
description: string
displayName: string
l3Vni: 0
nsxId: string
policyDistributedVxlanConnectionId: string
routeControllerPath: string
routeDistinguisher: string
routeTarget:
addressFamily: string
exportTargets:
- string
importTargets:
- string
tags:
- scope: string
tag: string
PolicyDistributedVxlanConnection 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 PolicyDistributedVxlanConnection resource accepts the following input properties:
- Display
Name string - Display name of the resource.
- L3Vni double
- L3 VNI for overlay traffic.
- Route
Controller stringPath - Policy path of the route controller.
- Route
Distinguisher string - Route distinguisher for the VXLAN connection. Must be in ASN:nn or IP:nn format.
- Route
Target PolicyDistributed Vxlan Connection Route Target - Route target configuration. Only one block is supported.
- Connectivity
Type string - Connectivity type for the distributed VXLAN connection. Currently only
L3_EVPNis supported. Default isL3_EVPN. - Description string
- Description of the resource.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Policy
Distributed stringVxlan Connection Id - ID of the resource.
-
List<Policy
Distributed Vxlan Connection Tag> - A list of scope + tag pairs to associate with this resource.
- Display
Name string - Display name of the resource.
- L3Vni float64
- L3 VNI for overlay traffic.
- Route
Controller stringPath - Policy path of the route controller.
- Route
Distinguisher string - Route distinguisher for the VXLAN connection. Must be in ASN:nn or IP:nn format.
- Route
Target PolicyDistributed Vxlan Connection Route Target Args - Route target configuration. Only one block is supported.
- Connectivity
Type string - Connectivity type for the distributed VXLAN connection. Currently only
L3_EVPNis supported. Default isL3_EVPN. - Description string
- Description of the resource.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Policy
Distributed stringVxlan Connection Id - ID of the resource.
-
[]Policy
Distributed Vxlan Connection Tag Args - A list of scope + tag pairs to associate with this resource.
- display_
name string - Display name of the resource.
- l3_
vni number - L3 VNI for overlay traffic.
- route_
controller_ stringpath - Policy path of the route controller.
- route_
distinguisher string - Route distinguisher for the VXLAN connection. Must be in ASN:nn or IP:nn format.
- route_
target object - Route target configuration. Only one block is supported.
- connectivity_
type string - Connectivity type for the distributed VXLAN connection. Currently only
L3_EVPNis supported. Default isL3_EVPN. - description string
- Description of the resource.
- nsx_
id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy_
distributed_ stringvxlan_ connection_ id - ID of the resource.
- list(object)
- A list of scope + tag pairs to associate with this resource.
- display
Name String - Display name of the resource.
- l3Vni Double
- L3 VNI for overlay traffic.
- route
Controller StringPath - Policy path of the route controller.
- route
Distinguisher String - Route distinguisher for the VXLAN connection. Must be in ASN:nn or IP:nn format.
- route
Target PolicyDistributed Vxlan Connection Route Target - Route target configuration. Only one block is supported.
- connectivity
Type String - Connectivity type for the distributed VXLAN connection. Currently only
L3_EVPNis supported. Default isL3_EVPN. - description String
- Description of the resource.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy
Distributed StringVxlan Connection Id - ID of the resource.
-
List<Policy
Distributed Vxlan Connection Tag> - A list of scope + tag pairs to associate with this resource.
- display
Name string - Display name of the resource.
- l3Vni number
- L3 VNI for overlay traffic.
- route
Controller stringPath - Policy path of the route controller.
- route
Distinguisher string - Route distinguisher for the VXLAN connection. Must be in ASN:nn or IP:nn format.
- route
Target PolicyDistributed Vxlan Connection Route Target - Route target configuration. Only one block is supported.
- connectivity
Type string - Connectivity type for the distributed VXLAN connection. Currently only
L3_EVPNis supported. Default isL3_EVPN. - description string
- Description of the resource.
- nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy
Distributed stringVxlan Connection Id - ID of the resource.
-
Policy
Distributed Vxlan Connection Tag[] - A list of scope + tag pairs to associate with this resource.
- display_
name str - Display name of the resource.
- l3_
vni float - L3 VNI for overlay traffic.
- route_
controller_ strpath - Policy path of the route controller.
- route_
distinguisher str - Route distinguisher for the VXLAN connection. Must be in ASN:nn or IP:nn format.
- route_
target PolicyDistributed Vxlan Connection Route Target Args - Route target configuration. Only one block is supported.
- connectivity_
type str - Connectivity type for the distributed VXLAN connection. Currently only
L3_EVPNis supported. Default isL3_EVPN. - description str
- Description of the resource.
- nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy_
distributed_ strvxlan_ connection_ id - ID of the resource.
-
Sequence[Policy
Distributed Vxlan Connection Tag Args] - A list of scope + tag pairs to associate with this resource.
- display
Name String - Display name of the resource.
- l3Vni Number
- L3 VNI for overlay traffic.
- route
Controller StringPath - Policy path of the route controller.
- route
Distinguisher String - Route distinguisher for the VXLAN connection. Must be in ASN:nn or IP:nn format.
- route
Target Property Map - Route target configuration. Only one block is supported.
- connectivity
Type String - Connectivity type for the distributed VXLAN connection. Currently only
L3_EVPNis supported. Default isL3_EVPN. - description String
- Description of the resource.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy
Distributed StringVxlan Connection Id - ID of the resource.
- 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 PolicyDistributedVxlanConnection resource produces the following output properties:
Look up Existing PolicyDistributedVxlanConnection Resource
Get an existing PolicyDistributedVxlanConnection 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?: PolicyDistributedVxlanConnectionState, opts?: CustomResourceOptions): PolicyDistributedVxlanConnection@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
connectivity_type: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
l3_vni: Optional[float] = None,
nsx_id: Optional[str] = None,
path: Optional[str] = None,
policy_distributed_vxlan_connection_id: Optional[str] = None,
revision: Optional[float] = None,
route_controller_path: Optional[str] = None,
route_distinguisher: Optional[str] = None,
route_target: Optional[PolicyDistributedVxlanConnectionRouteTargetArgs] = None,
tags: Optional[Sequence[PolicyDistributedVxlanConnectionTagArgs]] = None) -> PolicyDistributedVxlanConnectionfunc GetPolicyDistributedVxlanConnection(ctx *Context, name string, id IDInput, state *PolicyDistributedVxlanConnectionState, opts ...ResourceOption) (*PolicyDistributedVxlanConnection, error)public static PolicyDistributedVxlanConnection Get(string name, Input<string> id, PolicyDistributedVxlanConnectionState? state, CustomResourceOptions? opts = null)public static PolicyDistributedVxlanConnection get(String name, Output<String> id, PolicyDistributedVxlanConnectionState state, CustomResourceOptions options)resources: _: type: nsxt:PolicyDistributedVxlanConnection get: id: ${id}import {
to = nsxt_policy_distributed_vxlan_connection.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.
- Connectivity
Type string - Connectivity type for the distributed VXLAN connection. Currently only
L3_EVPNis supported. Default isL3_EVPN. - Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- L3Vni double
- L3 VNI for overlay traffic.
- 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 stringVxlan 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.
- Route
Controller stringPath - Policy path of the route controller.
- Route
Distinguisher string - Route distinguisher for the VXLAN connection. Must be in ASN:nn or IP:nn format.
- Route
Target PolicyDistributed Vxlan Connection Route Target - Route target configuration. Only one block is supported.
-
List<Policy
Distributed Vxlan Connection Tag> - A list of scope + tag pairs to associate with this resource.
- Connectivity
Type string - Connectivity type for the distributed VXLAN connection. Currently only
L3_EVPNis supported. Default isL3_EVPN. - Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- L3Vni float64
- L3 VNI for overlay traffic.
- 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 stringVxlan 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.
- Route
Controller stringPath - Policy path of the route controller.
- Route
Distinguisher string - Route distinguisher for the VXLAN connection. Must be in ASN:nn or IP:nn format.
- Route
Target PolicyDistributed Vxlan Connection Route Target Args - Route target configuration. Only one block is supported.
-
[]Policy
Distributed Vxlan Connection Tag Args - A list of scope + tag pairs to associate with this resource.
- connectivity_
type string - Connectivity type for the distributed VXLAN connection. Currently only
L3_EVPNis supported. Default isL3_EVPN. - description string
- Description of the resource.
- display_
name string - Display name of the resource.
- l3_
vni number - L3 VNI for overlay traffic.
- 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_ stringvxlan_ 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.
- route_
controller_ stringpath - Policy path of the route controller.
- route_
distinguisher string - Route distinguisher for the VXLAN connection. Must be in ASN:nn or IP:nn format.
- route_
target object - Route target configuration. Only one block is supported.
- list(object)
- A list of scope + tag pairs to associate with this resource.
- connectivity
Type String - Connectivity type for the distributed VXLAN connection. Currently only
L3_EVPNis supported. Default isL3_EVPN. - description String
- Description of the resource.
- display
Name String - Display name of the resource.
- l3Vni Double
- L3 VNI for overlay traffic.
- 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 StringVxlan 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.
- route
Controller StringPath - Policy path of the route controller.
- route
Distinguisher String - Route distinguisher for the VXLAN connection. Must be in ASN:nn or IP:nn format.
- route
Target PolicyDistributed Vxlan Connection Route Target - Route target configuration. Only one block is supported.
-
List<Policy
Distributed Vxlan Connection Tag> - A list of scope + tag pairs to associate with this resource.
- connectivity
Type string - Connectivity type for the distributed VXLAN connection. Currently only
L3_EVPNis supported. Default isL3_EVPN. - description string
- Description of the resource.
- display
Name string - Display name of the resource.
- l3Vni number
- L3 VNI for overlay traffic.
- 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 stringVxlan 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.
- route
Controller stringPath - Policy path of the route controller.
- route
Distinguisher string - Route distinguisher for the VXLAN connection. Must be in ASN:nn or IP:nn format.
- route
Target PolicyDistributed Vxlan Connection Route Target - Route target configuration. Only one block is supported.
-
Policy
Distributed Vxlan Connection Tag[] - A list of scope + tag pairs to associate with this resource.
- connectivity_
type str - Connectivity type for the distributed VXLAN connection. Currently only
L3_EVPNis supported. Default isL3_EVPN. - description str
- Description of the resource.
- display_
name str - Display name of the resource.
- l3_
vni float - L3 VNI for overlay traffic.
- 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_ strvxlan_ 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.
- route_
controller_ strpath - Policy path of the route controller.
- route_
distinguisher str - Route distinguisher for the VXLAN connection. Must be in ASN:nn or IP:nn format.
- route_
target PolicyDistributed Vxlan Connection Route Target Args - Route target configuration. Only one block is supported.
-
Sequence[Policy
Distributed Vxlan Connection Tag Args] - A list of scope + tag pairs to associate with this resource.
- connectivity
Type String - Connectivity type for the distributed VXLAN connection. Currently only
L3_EVPNis supported. Default isL3_EVPN. - description String
- Description of the resource.
- display
Name String - Display name of the resource.
- l3Vni Number
- L3 VNI for overlay traffic.
- 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 StringVxlan 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.
- route
Controller StringPath - Policy path of the route controller.
- route
Distinguisher String - Route distinguisher for the VXLAN connection. Must be in ASN:nn or IP:nn format.
- route
Target Property Map - Route target configuration. Only one block is supported.
- List<Property Map>
- A list of scope + tag pairs to associate with this resource.
Supporting Types
PolicyDistributedVxlanConnectionRouteTarget, PolicyDistributedVxlanConnectionRouteTargetArgs
- Address
Family string - Address family for route targets. Currently only
L2VPN_EVPNis supported. Default isL2VPN_EVPN. - Export
Targets List<string> - List of export route targets in ASN:nn format.
- Import
Targets List<string> - List of import route targets in ASN:nn format.
- Address
Family string - Address family for route targets. Currently only
L2VPN_EVPNis supported. Default isL2VPN_EVPN. - Export
Targets []string - List of export route targets in ASN:nn format.
- Import
Targets []string - List of import route targets in ASN:nn format.
- address_
family string - Address family for route targets. Currently only
L2VPN_EVPNis supported. Default isL2VPN_EVPN. - export_
targets list(string) - List of export route targets in ASN:nn format.
- import_
targets list(string) - List of import route targets in ASN:nn format.
- address
Family String - Address family for route targets. Currently only
L2VPN_EVPNis supported. Default isL2VPN_EVPN. - export
Targets List<String> - List of export route targets in ASN:nn format.
- import
Targets List<String> - List of import route targets in ASN:nn format.
- address
Family string - Address family for route targets. Currently only
L2VPN_EVPNis supported. Default isL2VPN_EVPN. - export
Targets string[] - List of export route targets in ASN:nn format.
- import
Targets string[] - List of import route targets in ASN:nn format.
- address_
family str - Address family for route targets. Currently only
L2VPN_EVPNis supported. Default isL2VPN_EVPN. - export_
targets Sequence[str] - List of export route targets in ASN:nn format.
- import_
targets Sequence[str] - List of import route targets in ASN:nn format.
- address
Family String - Address family for route targets. Currently only
L2VPN_EVPNis supported. Default isL2VPN_EVPN. - export
Targets List<String> - List of export route targets in ASN:nn format.
- import
Targets List<String> - List of import route targets in ASN:nn format.
PolicyDistributedVxlanConnectionTag, PolicyDistributedVxlanConnectionTagArgs
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxtTerraform Provider.
published on Friday, Sep 11, 2026 by vmware