Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. EdgeTransportNodeRtep
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.EdgeTransportNodeRtep

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    Create EdgeTransportNodeRtep Resource

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

    Constructor syntax

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

@overload
def EdgeTransportNodeRtep(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          edge_id: Optional[str] = None,
                          host_switch_name: Optional[str] = None,
                          ip_assignment: Optional[EdgeTransportNodeRtepIpAssignmentArgs] = None,
                          rtep_vlan: Optional[float] = None,
                          edge_transport_node_rtep_id: Optional[str] = None,
                          named_teaming_policy: Optional[str] = None)
    func NewEdgeTransportNodeRtep(ctx *Context, name string, args EdgeTransportNodeRtepArgs, opts ...ResourceOption) (*EdgeTransportNodeRtep, error)
    public EdgeTransportNodeRtep(string name, EdgeTransportNodeRtepArgs args, CustomResourceOptions? opts = null)
    public EdgeTransportNodeRtep(String name, EdgeTransportNodeRtepArgs args)
public EdgeTransportNodeRtep(String name, EdgeTransportNodeRtepArgs args, CustomResourceOptions options)

    type: nsxt:EdgeTransportNodeRtep
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EdgeTransportNodeRtepArgs
    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 EdgeTransportNodeRtepArgs
    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 EdgeTransportNodeRtepArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EdgeTransportNodeRtepArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EdgeTransportNodeRtepArgs
    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 edgeTransportNodeRtepResource = new Nsxt.EdgeTransportNodeRtep("edgeTransportNodeRtepResource", new()
{
    EdgeId = "string",
    HostSwitchName = "string",
    IpAssignment = new Nsxt.Inputs.EdgeTransportNodeRtepIpAssignmentArgs
    {
        AssignedByDhcp = false,
        NoIpv4 = false,
        StaticIp = new Nsxt.Inputs.EdgeTransportNodeRtepIpAssignmentStaticIpArgs
        {
            DefaultGateway = "string",
            IpAddresses = new[]
            {
                "string",
            },
            SubnetMask = "string",
        },
        StaticIpMac = new Nsxt.Inputs.EdgeTransportNodeRtepIpAssignmentStaticIpMacArgs
        {
            DefaultGateway = "string",
            IpMacPairs = new[]
            {
                new Nsxt.Inputs.EdgeTransportNodeRtepIpAssignmentStaticIpMacIpMacPairArgs
                {
                    IpAddress = "string",
                    MacAddress = "string",
                },
            },
            SubnetMask = "string",
        },
        StaticIpPool = "string",
    },
    RtepVlan = 0,
    EdgeTransportNodeRtepId = "string",
    NamedTeamingPolicy = "string",
});

    example, err := nsxt.NewEdgeTransportNodeRtep(ctx, "edgeTransportNodeRtepResource", &nsxt.EdgeTransportNodeRtepArgs{
	EdgeId:         pulumi.String("string"),
	HostSwitchName: pulumi.String("string"),
	IpAssignment: &nsxt.EdgeTransportNodeRtepIpAssignmentArgs{
		AssignedByDhcp: pulumi.Bool(false),
		NoIpv4:         pulumi.Bool(false),
		StaticIp: &nsxt.EdgeTransportNodeRtepIpAssignmentStaticIpArgs{
			DefaultGateway: pulumi.String("string"),
			IpAddresses: pulumi.StringArray{
				pulumi.String("string"),
			},
			SubnetMask: pulumi.String("string"),
		},
		StaticIpMac: &nsxt.EdgeTransportNodeRtepIpAssignmentStaticIpMacArgs{
			DefaultGateway: pulumi.String("string"),
			IpMacPairs: nsxt.EdgeTransportNodeRtepIpAssignmentStaticIpMacIpMacPairArray{
				&nsxt.EdgeTransportNodeRtepIpAssignmentStaticIpMacIpMacPairArgs{
					IpAddress:  pulumi.String("string"),
					MacAddress: pulumi.String("string"),
				},
			},
			SubnetMask: pulumi.String("string"),
		},
		StaticIpPool: pulumi.String("string"),
	},
	RtepVlan:                pulumi.Float64(0),
	EdgeTransportNodeRtepId: pulumi.String("string"),
	NamedTeamingPolicy:      pulumi.String("string"),
})

    var edgeTransportNodeRtepResource = new EdgeTransportNodeRtep("edgeTransportNodeRtepResource", EdgeTransportNodeRtepArgs.builder()
    .edgeId("string")
    .hostSwitchName("string")
    .ipAssignment(EdgeTransportNodeRtepIpAssignmentArgs.builder()
        .assignedByDhcp(false)
        .noIpv4(false)
        .staticIp(EdgeTransportNodeRtepIpAssignmentStaticIpArgs.builder()
            .defaultGateway("string")
            .ipAddresses("string")
            .subnetMask("string")
            .build())
        .staticIpMac(EdgeTransportNodeRtepIpAssignmentStaticIpMacArgs.builder()
            .defaultGateway("string")
            .ipMacPairs(EdgeTransportNodeRtepIpAssignmentStaticIpMacIpMacPairArgs.builder()
                .ipAddress("string")
                .macAddress("string")
                .build())
            .subnetMask("string")
            .build())
        .staticIpPool("string")
        .build())
    .rtepVlan(0)
    .edgeTransportNodeRtepId("string")
    .namedTeamingPolicy("string")
    .build());

    edge_transport_node_rtep_resource = nsxt.EdgeTransportNodeRtep("edgeTransportNodeRtepResource",
    edge_id="string",
    host_switch_name="string",
    ip_assignment={
        "assigned_by_dhcp": False,
        "no_ipv4": False,
        "static_ip": {
            "default_gateway": "string",
            "ip_addresses": ["string"],
            "subnet_mask": "string",
        },
        "static_ip_mac": {
            "default_gateway": "string",
            "ip_mac_pairs": [{
                "ip_address": "string",
                "mac_address": "string",
            }],
            "subnet_mask": "string",
        },
        "static_ip_pool": "string",
    },
    rtep_vlan=0,
    edge_transport_node_rtep_id="string",
    named_teaming_policy="string")

    const edgeTransportNodeRtepResource = new nsxt.EdgeTransportNodeRtep("edgeTransportNodeRtepResource", {
    edgeId: "string",
    hostSwitchName: "string",
    ipAssignment: {
        assignedByDhcp: false,
        noIpv4: false,
        staticIp: {
            defaultGateway: "string",
            ipAddresses: ["string"],
            subnetMask: "string",
        },
        staticIpMac: {
            defaultGateway: "string",
            ipMacPairs: [{
                ipAddress: "string",
                macAddress: "string",
            }],
            subnetMask: "string",
        },
        staticIpPool: "string",
    },
    rtepVlan: 0,
    edgeTransportNodeRtepId: "string",
    namedTeamingPolicy: "string",
});

    type: nsxt:EdgeTransportNodeRtep
properties:
    edgeId: string
    edgeTransportNodeRtepId: string
    hostSwitchName: string
    ipAssignment:
        assignedByDhcp: false
        noIpv4: false
        staticIp:
            defaultGateway: string
            ipAddresses:
                - string
            subnetMask: string
        staticIpMac:
            defaultGateway: string
            ipMacPairs:
                - ipAddress: string
                  macAddress: string
            subnetMask: string
        staticIpPool: string
    namedTeamingPolicy: string
    rtepVlan: 0

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

    EdgeId string
    Edge ID to associate with remote tunnel endpoint.
    HostSwitchName string
    The host switch name to be used for the remote tunnel endpoint.
    IpAssignment EdgeTransportNodeRtepIpAssignment
    Specification for IPs to be used with host switch virtual tunnel endpoints. Should contain exatly one of the below:
    RtepVlan double
    VLAN id for remote tunnel endpoint.
    EdgeTransportNodeRtepId string
    NamedTeamingPolicy string
    The named teaming policy to be used by the remote tunnel endpoint.
    EdgeId string
    Edge ID to associate with remote tunnel endpoint.
    HostSwitchName string
    The host switch name to be used for the remote tunnel endpoint.
    IpAssignment EdgeTransportNodeRtepIpAssignmentArgs
    Specification for IPs to be used with host switch virtual tunnel endpoints. Should contain exatly one of the below:
    RtepVlan float64
    VLAN id for remote tunnel endpoint.
    EdgeTransportNodeRtepId string
    NamedTeamingPolicy string
    The named teaming policy to be used by the remote tunnel endpoint.
    edgeId String
    Edge ID to associate with remote tunnel endpoint.
    hostSwitchName String
    The host switch name to be used for the remote tunnel endpoint.
    ipAssignment EdgeTransportNodeRtepIpAssignment
    Specification for IPs to be used with host switch virtual tunnel endpoints. Should contain exatly one of the below:
    rtepVlan Double
    VLAN id for remote tunnel endpoint.
    edgeTransportNodeRtepId String
    namedTeamingPolicy String
    The named teaming policy to be used by the remote tunnel endpoint.
    edgeId string
    Edge ID to associate with remote tunnel endpoint.
    hostSwitchName string
    The host switch name to be used for the remote tunnel endpoint.
    ipAssignment EdgeTransportNodeRtepIpAssignment
    Specification for IPs to be used with host switch virtual tunnel endpoints. Should contain exatly one of the below:
    rtepVlan number
    VLAN id for remote tunnel endpoint.
    edgeTransportNodeRtepId string
    namedTeamingPolicy string
    The named teaming policy to be used by the remote tunnel endpoint.
    edge_id str
    Edge ID to associate with remote tunnel endpoint.
    host_switch_name str
    The host switch name to be used for the remote tunnel endpoint.
    ip_assignment EdgeTransportNodeRtepIpAssignmentArgs
    Specification for IPs to be used with host switch virtual tunnel endpoints. Should contain exatly one of the below:
    rtep_vlan float
    VLAN id for remote tunnel endpoint.
    edge_transport_node_rtep_id str
    named_teaming_policy str
    The named teaming policy to be used by the remote tunnel endpoint.
    edgeId String
    Edge ID to associate with remote tunnel endpoint.
    hostSwitchName String
    The host switch name to be used for the remote tunnel endpoint.
    ipAssignment Property Map
    Specification for IPs to be used with host switch virtual tunnel endpoints. Should contain exatly one of the below:
    rtepVlan Number
    VLAN id for remote tunnel endpoint.
    edgeTransportNodeRtepId String
    namedTeamingPolicy String
    The named teaming policy to be used by the remote tunnel endpoint.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EdgeTransportNodeRtep Resource

    Get an existing EdgeTransportNodeRtep 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?: EdgeTransportNodeRtepState, opts?: CustomResourceOptions): EdgeTransportNodeRtep
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        edge_id: Optional[str] = None,
        edge_transport_node_rtep_id: Optional[str] = None,
        host_switch_name: Optional[str] = None,
        ip_assignment: Optional[EdgeTransportNodeRtepIpAssignmentArgs] = None,
        named_teaming_policy: Optional[str] = None,
        rtep_vlan: Optional[float] = None) -> EdgeTransportNodeRtep
    func GetEdgeTransportNodeRtep(ctx *Context, name string, id IDInput, state *EdgeTransportNodeRtepState, opts ...ResourceOption) (*EdgeTransportNodeRtep, error)
    public static EdgeTransportNodeRtep Get(string name, Input<string> id, EdgeTransportNodeRtepState? state, CustomResourceOptions? opts = null)
    public static EdgeTransportNodeRtep get(String name, Output<String> id, EdgeTransportNodeRtepState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:EdgeTransportNodeRtep    get:      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.
    The following state arguments are supported:
    EdgeId string
    Edge ID to associate with remote tunnel endpoint.
    EdgeTransportNodeRtepId string
    HostSwitchName string
    The host switch name to be used for the remote tunnel endpoint.
    IpAssignment EdgeTransportNodeRtepIpAssignment
    Specification for IPs to be used with host switch virtual tunnel endpoints. Should contain exatly one of the below:
    NamedTeamingPolicy string
    The named teaming policy to be used by the remote tunnel endpoint.
    RtepVlan double
    VLAN id for remote tunnel endpoint.
    EdgeId string
    Edge ID to associate with remote tunnel endpoint.
    EdgeTransportNodeRtepId string
    HostSwitchName string
    The host switch name to be used for the remote tunnel endpoint.
    IpAssignment EdgeTransportNodeRtepIpAssignmentArgs
    Specification for IPs to be used with host switch virtual tunnel endpoints. Should contain exatly one of the below:
    NamedTeamingPolicy string
    The named teaming policy to be used by the remote tunnel endpoint.
    RtepVlan float64
    VLAN id for remote tunnel endpoint.
    edgeId String
    Edge ID to associate with remote tunnel endpoint.
    edgeTransportNodeRtepId String
    hostSwitchName String
    The host switch name to be used for the remote tunnel endpoint.
    ipAssignment EdgeTransportNodeRtepIpAssignment
    Specification for IPs to be used with host switch virtual tunnel endpoints. Should contain exatly one of the below:
    namedTeamingPolicy String
    The named teaming policy to be used by the remote tunnel endpoint.
    rtepVlan Double
    VLAN id for remote tunnel endpoint.
    edgeId string
    Edge ID to associate with remote tunnel endpoint.
    edgeTransportNodeRtepId string
    hostSwitchName string
    The host switch name to be used for the remote tunnel endpoint.
    ipAssignment EdgeTransportNodeRtepIpAssignment
    Specification for IPs to be used with host switch virtual tunnel endpoints. Should contain exatly one of the below:
    namedTeamingPolicy string
    The named teaming policy to be used by the remote tunnel endpoint.
    rtepVlan number
    VLAN id for remote tunnel endpoint.
    edge_id str
    Edge ID to associate with remote tunnel endpoint.
    edge_transport_node_rtep_id str
    host_switch_name str
    The host switch name to be used for the remote tunnel endpoint.
    ip_assignment EdgeTransportNodeRtepIpAssignmentArgs
    Specification for IPs to be used with host switch virtual tunnel endpoints. Should contain exatly one of the below:
    named_teaming_policy str
    The named teaming policy to be used by the remote tunnel endpoint.
    rtep_vlan float
    VLAN id for remote tunnel endpoint.
    edgeId String
    Edge ID to associate with remote tunnel endpoint.
    edgeTransportNodeRtepId String
    hostSwitchName String
    The host switch name to be used for the remote tunnel endpoint.
    ipAssignment Property Map
    Specification for IPs to be used with host switch virtual tunnel endpoints. Should contain exatly one of the below:
    namedTeamingPolicy String
    The named teaming policy to be used by the remote tunnel endpoint.
    rtepVlan Number
    VLAN id for remote tunnel endpoint.

    Supporting Types

    EdgeTransportNodeRtepIpAssignment, EdgeTransportNodeRtepIpAssignmentArgs

    AssignedByDhcp bool
    Enables DHCP assignment.
    NoIpv4 bool
    No IPv4 assignment
    StaticIp EdgeTransportNodeRtepIpAssignmentStaticIp
    IP assignment specification for Static IP List.
    StaticIpMac EdgeTransportNodeRtepIpAssignmentStaticIpMac
    IP assignment specification for Static MAC List.
    StaticIpPool string
    IP assignment specification for Static IP Pool.
    AssignedByDhcp bool
    Enables DHCP assignment.
    NoIpv4 bool
    No IPv4 assignment
    StaticIp EdgeTransportNodeRtepIpAssignmentStaticIp
    IP assignment specification for Static IP List.
    StaticIpMac EdgeTransportNodeRtepIpAssignmentStaticIpMac
    IP assignment specification for Static MAC List.
    StaticIpPool string
    IP assignment specification for Static IP Pool.
    assignedByDhcp Boolean
    Enables DHCP assignment.
    noIpv4 Boolean
    No IPv4 assignment
    staticIp EdgeTransportNodeRtepIpAssignmentStaticIp
    IP assignment specification for Static IP List.
    staticIpMac EdgeTransportNodeRtepIpAssignmentStaticIpMac
    IP assignment specification for Static MAC List.
    staticIpPool String
    IP assignment specification for Static IP Pool.
    assignedByDhcp boolean
    Enables DHCP assignment.
    noIpv4 boolean
    No IPv4 assignment
    staticIp EdgeTransportNodeRtepIpAssignmentStaticIp
    IP assignment specification for Static IP List.
    staticIpMac EdgeTransportNodeRtepIpAssignmentStaticIpMac
    IP assignment specification for Static MAC List.
    staticIpPool string
    IP assignment specification for Static IP Pool.
    assigned_by_dhcp bool
    Enables DHCP assignment.
    no_ipv4 bool
    No IPv4 assignment
    static_ip EdgeTransportNodeRtepIpAssignmentStaticIp
    IP assignment specification for Static IP List.
    static_ip_mac EdgeTransportNodeRtepIpAssignmentStaticIpMac
    IP assignment specification for Static MAC List.
    static_ip_pool str
    IP assignment specification for Static IP Pool.
    assignedByDhcp Boolean
    Enables DHCP assignment.
    noIpv4 Boolean
    No IPv4 assignment
    staticIp Property Map
    IP assignment specification for Static IP List.
    staticIpMac Property Map
    IP assignment specification for Static MAC List.
    staticIpPool String
    IP assignment specification for Static IP Pool.

    EdgeTransportNodeRtepIpAssignmentStaticIp, EdgeTransportNodeRtepIpAssignmentStaticIpArgs

    DefaultGateway string
    Gateway IP.
    IpAddresses List<string>
    List of IPs for transport node host switch virtual tunnel endpoints.
    SubnetMask string
    Subnet mask.
    DefaultGateway string
    Gateway IP.
    IpAddresses []string
    List of IPs for transport node host switch virtual tunnel endpoints.
    SubnetMask string
    Subnet mask.
    defaultGateway String
    Gateway IP.
    ipAddresses List<String>
    List of IPs for transport node host switch virtual tunnel endpoints.
    subnetMask String
    Subnet mask.
    defaultGateway string
    Gateway IP.
    ipAddresses string[]
    List of IPs for transport node host switch virtual tunnel endpoints.
    subnetMask string
    Subnet mask.
    default_gateway str
    Gateway IP.
    ip_addresses Sequence[str]
    List of IPs for transport node host switch virtual tunnel endpoints.
    subnet_mask str
    Subnet mask.
    defaultGateway String
    Gateway IP.
    ipAddresses List<String>
    List of IPs for transport node host switch virtual tunnel endpoints.
    subnetMask String
    Subnet mask.

    EdgeTransportNodeRtepIpAssignmentStaticIpMac, EdgeTransportNodeRtepIpAssignmentStaticIpMacArgs

    defaultGateway String
    Gateway IP
    ipMacPairs List<Property Map>
    List of IP MAC pairs
    subnetMask String
    Subnet mask

    EdgeTransportNodeRtepIpAssignmentStaticIpMacIpMacPair, EdgeTransportNodeRtepIpAssignmentStaticIpMacIpMacPairArgs

    IpAddress string
    A single IPv6 address
    MacAddress string
    A single MAC address
    IpAddress string
    A single IPv6 address
    MacAddress string
    A single MAC address
    ipAddress String
    A single IPv6 address
    macAddress String
    A single MAC address
    ipAddress string
    A single IPv6 address
    macAddress string
    A single MAC address
    ip_address str
    A single IPv6 address
    mac_address str
    A single MAC address
    ipAddress String
    A single IPv6 address
    macAddress String
    A single MAC address

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt