1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyEvpnTunnelEndpoint
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

nsxt.PolicyEvpnTunnelEndpoint

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

    Create PolicyEvpnTunnelEndpoint Resource

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

    Constructor syntax

    new PolicyEvpnTunnelEndpoint(name: string, args: PolicyEvpnTunnelEndpointArgs, opts?: CustomResourceOptions);
    @overload
    def PolicyEvpnTunnelEndpoint(resource_name: str,
                                 args: PolicyEvpnTunnelEndpointArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def PolicyEvpnTunnelEndpoint(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 display_name: Optional[str] = None,
                                 edge_node_path: Optional[str] = None,
                                 external_interface_path: Optional[str] = None,
                                 local_address: Optional[str] = None,
                                 description: Optional[str] = None,
                                 mtu: Optional[float] = None,
                                 nsx_id: Optional[str] = None,
                                 policy_evpn_tunnel_endpoint_id: Optional[str] = None,
                                 tags: Optional[Sequence[PolicyEvpnTunnelEndpointTagArgs]] = None)
    func NewPolicyEvpnTunnelEndpoint(ctx *Context, name string, args PolicyEvpnTunnelEndpointArgs, opts ...ResourceOption) (*PolicyEvpnTunnelEndpoint, error)
    public PolicyEvpnTunnelEndpoint(string name, PolicyEvpnTunnelEndpointArgs args, CustomResourceOptions? opts = null)
    public PolicyEvpnTunnelEndpoint(String name, PolicyEvpnTunnelEndpointArgs args)
    public PolicyEvpnTunnelEndpoint(String name, PolicyEvpnTunnelEndpointArgs args, CustomResourceOptions options)
    
    type: nsxt:PolicyEvpnTunnelEndpoint
    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 PolicyEvpnTunnelEndpointArgs
    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 PolicyEvpnTunnelEndpointArgs
    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 PolicyEvpnTunnelEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyEvpnTunnelEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyEvpnTunnelEndpointArgs
    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 policyEvpnTunnelEndpointResource = new Nsxt.PolicyEvpnTunnelEndpoint("policyEvpnTunnelEndpointResource", new()
    {
        DisplayName = "string",
        EdgeNodePath = "string",
        ExternalInterfacePath = "string",
        LocalAddress = "string",
        Description = "string",
        Mtu = 0,
        NsxId = "string",
        PolicyEvpnTunnelEndpointId = "string",
        Tags = new[]
        {
            new Nsxt.Inputs.PolicyEvpnTunnelEndpointTagArgs
            {
                Scope = "string",
                Tag = "string",
            },
        },
    });
    
    example, err := nsxt.NewPolicyEvpnTunnelEndpoint(ctx, "policyEvpnTunnelEndpointResource", &nsxt.PolicyEvpnTunnelEndpointArgs{
    	DisplayName:                pulumi.String("string"),
    	EdgeNodePath:               pulumi.String("string"),
    	ExternalInterfacePath:      pulumi.String("string"),
    	LocalAddress:               pulumi.String("string"),
    	Description:                pulumi.String("string"),
    	Mtu:                        pulumi.Float64(0),
    	NsxId:                      pulumi.String("string"),
    	PolicyEvpnTunnelEndpointId: pulumi.String("string"),
    	Tags: nsxt.PolicyEvpnTunnelEndpointTagArray{
    		&nsxt.PolicyEvpnTunnelEndpointTagArgs{
    			Scope: pulumi.String("string"),
    			Tag:   pulumi.String("string"),
    		},
    	},
    })
    
    var policyEvpnTunnelEndpointResource = new PolicyEvpnTunnelEndpoint("policyEvpnTunnelEndpointResource", PolicyEvpnTunnelEndpointArgs.builder()
        .displayName("string")
        .edgeNodePath("string")
        .externalInterfacePath("string")
        .localAddress("string")
        .description("string")
        .mtu(0)
        .nsxId("string")
        .policyEvpnTunnelEndpointId("string")
        .tags(PolicyEvpnTunnelEndpointTagArgs.builder()
            .scope("string")
            .tag("string")
            .build())
        .build());
    
    policy_evpn_tunnel_endpoint_resource = nsxt.PolicyEvpnTunnelEndpoint("policyEvpnTunnelEndpointResource",
        display_name="string",
        edge_node_path="string",
        external_interface_path="string",
        local_address="string",
        description="string",
        mtu=0,
        nsx_id="string",
        policy_evpn_tunnel_endpoint_id="string",
        tags=[{
            "scope": "string",
            "tag": "string",
        }])
    
    const policyEvpnTunnelEndpointResource = new nsxt.PolicyEvpnTunnelEndpoint("policyEvpnTunnelEndpointResource", {
        displayName: "string",
        edgeNodePath: "string",
        externalInterfacePath: "string",
        localAddress: "string",
        description: "string",
        mtu: 0,
        nsxId: "string",
        policyEvpnTunnelEndpointId: "string",
        tags: [{
            scope: "string",
            tag: "string",
        }],
    });
    
    type: nsxt:PolicyEvpnTunnelEndpoint
    properties:
        description: string
        displayName: string
        edgeNodePath: string
        externalInterfacePath: string
        localAddress: string
        mtu: 0
        nsxId: string
        policyEvpnTunnelEndpointId: string
        tags:
            - scope: string
              tag: string
    

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

    DisplayName string
    Display name of the resource.
    EdgeNodePath string
    Edge node path.
    ExternalInterfacePath string
    Policy path for External Interface on Tier0 Gateway.
    LocalAddress string
    Local IPv4 IP address.
    Description string
    Description of the resource.
    Mtu double
    Maximal Transmission Unit.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    PolicyEvpnTunnelEndpointId string
    Tags List<PolicyEvpnTunnelEndpointTag>
    A list of scope + tag pairs to associate with this resource.
    DisplayName string
    Display name of the resource.
    EdgeNodePath string
    Edge node path.
    ExternalInterfacePath string
    Policy path for External Interface on Tier0 Gateway.
    LocalAddress string
    Local IPv4 IP address.
    Description string
    Description of the resource.
    Mtu float64
    Maximal Transmission Unit.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    PolicyEvpnTunnelEndpointId string
    Tags []PolicyEvpnTunnelEndpointTagArgs
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    edgeNodePath String
    Edge node path.
    externalInterfacePath String
    Policy path for External Interface on Tier0 Gateway.
    localAddress String
    Local IPv4 IP address.
    description String
    Description of the resource.
    mtu Double
    Maximal Transmission Unit.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policyEvpnTunnelEndpointId String
    tags List<PolicyEvpnTunnelEndpointTag>
    A list of scope + tag pairs to associate with this resource.
    displayName string
    Display name of the resource.
    edgeNodePath string
    Edge node path.
    externalInterfacePath string
    Policy path for External Interface on Tier0 Gateway.
    localAddress string
    Local IPv4 IP address.
    description string
    Description of the resource.
    mtu number
    Maximal Transmission Unit.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policyEvpnTunnelEndpointId string
    tags PolicyEvpnTunnelEndpointTag[]
    A list of scope + tag pairs to associate with this resource.
    display_name str
    Display name of the resource.
    edge_node_path str
    Edge node path.
    external_interface_path str
    Policy path for External Interface on Tier0 Gateway.
    local_address str
    Local IPv4 IP address.
    description str
    Description of the resource.
    mtu float
    Maximal Transmission Unit.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policy_evpn_tunnel_endpoint_id str
    tags Sequence[PolicyEvpnTunnelEndpointTagArgs]
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    edgeNodePath String
    Edge node path.
    externalInterfacePath String
    Policy path for External Interface on Tier0 Gateway.
    localAddress String
    Local IPv4 IP address.
    description String
    Description of the resource.
    mtu Number
    Maximal Transmission Unit.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policyEvpnTunnelEndpointId String
    tags 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 PolicyEvpnTunnelEndpoint resource produces the following output properties:

    GatewayId string
    Tier0 Gateway ID on which EVPN Tunnel is configured.
    Id string
    The provider-assigned unique ID for this managed resource.
    LocaleServiceId string
    Tier0 Gateway Locale Service ID on which EVPN Tunnel is configured.
    Path string
    The NSX path of the policy resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    GatewayId string
    Tier0 Gateway ID on which EVPN Tunnel is configured.
    Id string
    The provider-assigned unique ID for this managed resource.
    LocaleServiceId string
    Tier0 Gateway Locale Service ID on which EVPN Tunnel is configured.
    Path string
    The NSX path of the policy resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    gatewayId String
    Tier0 Gateway ID on which EVPN Tunnel is configured.
    id String
    The provider-assigned unique ID for this managed resource.
    localeServiceId String
    Tier0 Gateway Locale Service ID on which EVPN Tunnel is configured.
    path String
    The NSX path of the policy resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    gatewayId string
    Tier0 Gateway ID on which EVPN Tunnel is configured.
    id string
    The provider-assigned unique ID for this managed resource.
    localeServiceId string
    Tier0 Gateway Locale Service ID on which EVPN Tunnel is configured.
    path string
    The NSX path of the policy resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    gateway_id str
    Tier0 Gateway ID on which EVPN Tunnel is configured.
    id str
    The provider-assigned unique ID for this managed resource.
    locale_service_id str
    Tier0 Gateway Locale Service ID on which EVPN Tunnel is configured.
    path str
    The NSX path of the policy resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    gatewayId String
    Tier0 Gateway ID on which EVPN Tunnel is configured.
    id String
    The provider-assigned unique ID for this managed resource.
    localeServiceId String
    Tier0 Gateway Locale Service ID on which EVPN Tunnel is configured.
    path String
    The NSX path of the policy resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

    Look up Existing PolicyEvpnTunnelEndpoint Resource

    Get an existing PolicyEvpnTunnelEndpoint 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?: PolicyEvpnTunnelEndpointState, opts?: CustomResourceOptions): PolicyEvpnTunnelEndpoint
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            edge_node_path: Optional[str] = None,
            external_interface_path: Optional[str] = None,
            gateway_id: Optional[str] = None,
            local_address: Optional[str] = None,
            locale_service_id: Optional[str] = None,
            mtu: Optional[float] = None,
            nsx_id: Optional[str] = None,
            path: Optional[str] = None,
            policy_evpn_tunnel_endpoint_id: Optional[str] = None,
            revision: Optional[float] = None,
            tags: Optional[Sequence[PolicyEvpnTunnelEndpointTagArgs]] = None) -> PolicyEvpnTunnelEndpoint
    func GetPolicyEvpnTunnelEndpoint(ctx *Context, name string, id IDInput, state *PolicyEvpnTunnelEndpointState, opts ...ResourceOption) (*PolicyEvpnTunnelEndpoint, error)
    public static PolicyEvpnTunnelEndpoint Get(string name, Input<string> id, PolicyEvpnTunnelEndpointState? state, CustomResourceOptions? opts = null)
    public static PolicyEvpnTunnelEndpoint get(String name, Output<String> id, PolicyEvpnTunnelEndpointState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyEvpnTunnelEndpoint    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:
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    EdgeNodePath string
    Edge node path.
    ExternalInterfacePath string
    Policy path for External Interface on Tier0 Gateway.
    GatewayId string
    Tier0 Gateway ID on which EVPN Tunnel is configured.
    LocalAddress string
    Local IPv4 IP address.
    LocaleServiceId string
    Tier0 Gateway Locale Service ID on which EVPN Tunnel is configured.
    Mtu double
    Maximal Transmission Unit.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    Path string
    The NSX path of the policy resource.
    PolicyEvpnTunnelEndpointId string
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags List<PolicyEvpnTunnelEndpointTag>
    A list of scope + tag pairs to associate with this resource.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    EdgeNodePath string
    Edge node path.
    ExternalInterfacePath string
    Policy path for External Interface on Tier0 Gateway.
    GatewayId string
    Tier0 Gateway ID on which EVPN Tunnel is configured.
    LocalAddress string
    Local IPv4 IP address.
    LocaleServiceId string
    Tier0 Gateway Locale Service ID on which EVPN Tunnel is configured.
    Mtu float64
    Maximal Transmission Unit.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    Path string
    The NSX path of the policy resource.
    PolicyEvpnTunnelEndpointId string
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []PolicyEvpnTunnelEndpointTagArgs
    A list of scope + tag pairs to associate with this resource.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    edgeNodePath String
    Edge node path.
    externalInterfacePath String
    Policy path for External Interface on Tier0 Gateway.
    gatewayId String
    Tier0 Gateway ID on which EVPN Tunnel is configured.
    localAddress String
    Local IPv4 IP address.
    localeServiceId String
    Tier0 Gateway Locale Service ID on which EVPN Tunnel is configured.
    mtu Double
    Maximal Transmission Unit.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path String
    The NSX path of the policy resource.
    policyEvpnTunnelEndpointId String
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<PolicyEvpnTunnelEndpointTag>
    A list of scope + tag pairs to associate with this resource.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    edgeNodePath string
    Edge node path.
    externalInterfacePath string
    Policy path for External Interface on Tier0 Gateway.
    gatewayId string
    Tier0 Gateway ID on which EVPN Tunnel is configured.
    localAddress string
    Local IPv4 IP address.
    localeServiceId string
    Tier0 Gateway Locale Service ID on which EVPN Tunnel is configured.
    mtu number
    Maximal Transmission Unit.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path string
    The NSX path of the policy resource.
    policyEvpnTunnelEndpointId string
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags PolicyEvpnTunnelEndpointTag[]
    A list of scope + tag pairs to associate with this resource.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    edge_node_path str
    Edge node path.
    external_interface_path str
    Policy path for External Interface on Tier0 Gateway.
    gateway_id str
    Tier0 Gateway ID on which EVPN Tunnel is configured.
    local_address str
    Local IPv4 IP address.
    locale_service_id str
    Tier0 Gateway Locale Service ID on which EVPN Tunnel is configured.
    mtu float
    Maximal Transmission Unit.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path str
    The NSX path of the policy resource.
    policy_evpn_tunnel_endpoint_id str
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags Sequence[PolicyEvpnTunnelEndpointTagArgs]
    A list of scope + tag pairs to associate with this resource.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    edgeNodePath String
    Edge node path.
    externalInterfacePath String
    Policy path for External Interface on Tier0 Gateway.
    gatewayId String
    Tier0 Gateway ID on which EVPN Tunnel is configured.
    localAddress String
    Local IPv4 IP address.
    localeServiceId String
    Tier0 Gateway Locale Service ID on which EVPN Tunnel is configured.
    mtu Number
    Maximal Transmission Unit.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path String
    The NSX path of the policy resource.
    policyEvpnTunnelEndpointId String
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Supporting Types

    PolicyEvpnTunnelEndpointTag, PolicyEvpnTunnelEndpointTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.
    scope string
    tag string
    A list of scope + tag pairs to associate with this resource.
    scope str
    tag str
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.

    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