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

vcd.NsxtEdgegatewayL2VpnTunnel

Explore with Pulumi AI

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

    Create NsxtEdgegatewayL2VpnTunnel Resource

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

    Constructor syntax

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

@overload
def NsxtEdgegatewayL2VpnTunnel(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               local_endpoint_ip: Optional[str] = None,
                               session_mode: Optional[str] = None,
                               edge_gateway_id: Optional[str] = None,
                               remote_endpoint_ip: Optional[str] = None,
                               nsxt_edgegateway_l2_vpn_tunnel_id: Optional[str] = None,
                               name: Optional[str] = None,
                               connector_initiation_mode: Optional[str] = None,
                               org: Optional[str] = None,
                               peer_code: Optional[str] = None,
                               pre_shared_key: Optional[str] = None,
                               enabled: Optional[bool] = None,
                               description: Optional[str] = None,
                               stretched_networks: Optional[Sequence[NsxtEdgegatewayL2VpnTunnelStretchedNetworkArgs]] = None,
                               tunnel_interface: Optional[str] = None)
    func NewNsxtEdgegatewayL2VpnTunnel(ctx *Context, name string, args NsxtEdgegatewayL2VpnTunnelArgs, opts ...ResourceOption) (*NsxtEdgegatewayL2VpnTunnel, error)
    public NsxtEdgegatewayL2VpnTunnel(string name, NsxtEdgegatewayL2VpnTunnelArgs args, CustomResourceOptions? opts = null)
    public NsxtEdgegatewayL2VpnTunnel(String name, NsxtEdgegatewayL2VpnTunnelArgs args)
public NsxtEdgegatewayL2VpnTunnel(String name, NsxtEdgegatewayL2VpnTunnelArgs args, CustomResourceOptions options)

    type: vcd:NsxtEdgegatewayL2VpnTunnel
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 NsxtEdgegatewayL2VpnTunnelArgs
    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 NsxtEdgegatewayL2VpnTunnelArgs
    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 NsxtEdgegatewayL2VpnTunnelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NsxtEdgegatewayL2VpnTunnelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NsxtEdgegatewayL2VpnTunnelArgs
    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 nsxtEdgegatewayL2VpnTunnelResource = new Vcd.NsxtEdgegatewayL2VpnTunnel("nsxtEdgegatewayL2VpnTunnelResource", new()
{
    LocalEndpointIp = "string",
    SessionMode = "string",
    EdgeGatewayId = "string",
    RemoteEndpointIp = "string",
    NsxtEdgegatewayL2VpnTunnelId = "string",
    Name = "string",
    ConnectorInitiationMode = "string",
    Org = "string",
    PeerCode = "string",
    PreSharedKey = "string",
    Enabled = false,
    Description = "string",
    StretchedNetworks = new[]
    {
        new Vcd.Inputs.NsxtEdgegatewayL2VpnTunnelStretchedNetworkArgs
        {
            NetworkId = "string",
            TunnelId = 0,
        },
    },
    TunnelInterface = "string",
});

    example, err := vcd.NewNsxtEdgegatewayL2VpnTunnel(ctx, "nsxtEdgegatewayL2VpnTunnelResource", &vcd.NsxtEdgegatewayL2VpnTunnelArgs{
	LocalEndpointIp:              pulumi.String("string"),
	SessionMode:                  pulumi.String("string"),
	EdgeGatewayId:                pulumi.String("string"),
	RemoteEndpointIp:             pulumi.String("string"),
	NsxtEdgegatewayL2VpnTunnelId: pulumi.String("string"),
	Name:                         pulumi.String("string"),
	ConnectorInitiationMode:      pulumi.String("string"),
	Org:                          pulumi.String("string"),
	PeerCode:                     pulumi.String("string"),
	PreSharedKey:                 pulumi.String("string"),
	Enabled:                      pulumi.Bool(false),
	Description:                  pulumi.String("string"),
	StretchedNetworks: vcd.NsxtEdgegatewayL2VpnTunnelStretchedNetworkArray{
		&vcd.NsxtEdgegatewayL2VpnTunnelStretchedNetworkArgs{
			NetworkId: pulumi.String("string"),
			TunnelId:  pulumi.Float64(0),
		},
	},
	TunnelInterface: pulumi.String("string"),
})

    var nsxtEdgegatewayL2VpnTunnelResource = new NsxtEdgegatewayL2VpnTunnel("nsxtEdgegatewayL2VpnTunnelResource", NsxtEdgegatewayL2VpnTunnelArgs.builder()
    .localEndpointIp("string")
    .sessionMode("string")
    .edgeGatewayId("string")
    .remoteEndpointIp("string")
    .nsxtEdgegatewayL2VpnTunnelId("string")
    .name("string")
    .connectorInitiationMode("string")
    .org("string")
    .peerCode("string")
    .preSharedKey("string")
    .enabled(false)
    .description("string")
    .stretchedNetworks(NsxtEdgegatewayL2VpnTunnelStretchedNetworkArgs.builder()
        .networkId("string")
        .tunnelId(0)
        .build())
    .tunnelInterface("string")
    .build());

    nsxt_edgegateway_l2_vpn_tunnel_resource = vcd.NsxtEdgegatewayL2VpnTunnel("nsxtEdgegatewayL2VpnTunnelResource",
    local_endpoint_ip="string",
    session_mode="string",
    edge_gateway_id="string",
    remote_endpoint_ip="string",
    nsxt_edgegateway_l2_vpn_tunnel_id="string",
    name="string",
    connector_initiation_mode="string",
    org="string",
    peer_code="string",
    pre_shared_key="string",
    enabled=False,
    description="string",
    stretched_networks=[{
        "network_id": "string",
        "tunnel_id": 0,
    }],
    tunnel_interface="string")

    const nsxtEdgegatewayL2VpnTunnelResource = new vcd.NsxtEdgegatewayL2VpnTunnel("nsxtEdgegatewayL2VpnTunnelResource", {
    localEndpointIp: "string",
    sessionMode: "string",
    edgeGatewayId: "string",
    remoteEndpointIp: "string",
    nsxtEdgegatewayL2VpnTunnelId: "string",
    name: "string",
    connectorInitiationMode: "string",
    org: "string",
    peerCode: "string",
    preSharedKey: "string",
    enabled: false,
    description: "string",
    stretchedNetworks: [{
        networkId: "string",
        tunnelId: 0,
    }],
    tunnelInterface: "string",
});

    type: vcd:NsxtEdgegatewayL2VpnTunnel
properties:
    connectorInitiationMode: string
    description: string
    edgeGatewayId: string
    enabled: false
    localEndpointIp: string
    name: string
    nsxtEdgegatewayL2VpnTunnelId: string
    org: string
    peerCode: string
    preSharedKey: string
    remoteEndpointIp: string
    sessionMode: string
    stretchedNetworks:
        - networkId: string
          tunnelId: 0
    tunnelInterface: string

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

    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    LocalEndpointIp string
    The IP address corresponding to the Edge Gateway the tunnel is being configured on. The IP must be sub-allocated on the Edge Gateway.
    RemoteEndpointIp string
    The IP address of the remote endpoint, which corresponds to the device on the remote site terminating the VPN tunnel.
    SessionMode string
    Mode of the tunnel session (SERVER or CLIENT).
    ConnectorInitiationMode string
    Mode in which the connection is formed. Required for SERVER mode sessions. One of:

    • INITIATOR - Local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from the peer gateway.
    • RESPOND_ONLY - Local endpoint shall only respond to incoming tunnel setup requests, it shall not initiate the tunnel setup.
    • ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received, and will also respond to incoming initiation requests.
    Description string
    The description of the tunnel.
    Enabled bool
    State of the SERVER mode session, always set to true for CLIENT mode sessions. Default is true.
    Name string
    The name of the tunnel.
    NsxtEdgegatewayL2VpnTunnelId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    PeerCode string
    Base64 encoded string of the full configuration of the tunnel provided by the SERVER session. It is a computed field for SERVER sessions and is a required field for CLIENT sessions.
    PreSharedKey string
    The key that is used for authenticating the connection. Required for SERVER mode sessions.
    StretchedNetworks List<NsxtEdgegatewayL2VpnTunnelStretchedNetwork>
    One or more stretched networks for the tunnel. See stretched_network for more detail.
    TunnelInterface string
    The network CIDR block over which the session interfaces. Relevant only for SERVER mode sessions. If not provided, Cloud Director will attempt to automatically allocate a tunnel interface.
    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    LocalEndpointIp string
    The IP address corresponding to the Edge Gateway the tunnel is being configured on. The IP must be sub-allocated on the Edge Gateway.
    RemoteEndpointIp string
    The IP address of the remote endpoint, which corresponds to the device on the remote site terminating the VPN tunnel.
    SessionMode string
    Mode of the tunnel session (SERVER or CLIENT).
    ConnectorInitiationMode string
    Mode in which the connection is formed. Required for SERVER mode sessions. One of:

    • INITIATOR - Local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from the peer gateway.
    • RESPOND_ONLY - Local endpoint shall only respond to incoming tunnel setup requests, it shall not initiate the tunnel setup.
    • ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received, and will also respond to incoming initiation requests.
    Description string
    The description of the tunnel.
    Enabled bool
    State of the SERVER mode session, always set to true for CLIENT mode sessions. Default is true.
    Name string
    The name of the tunnel.
    NsxtEdgegatewayL2VpnTunnelId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    PeerCode string
    Base64 encoded string of the full configuration of the tunnel provided by the SERVER session. It is a computed field for SERVER sessions and is a required field for CLIENT sessions.
    PreSharedKey string
    The key that is used for authenticating the connection. Required for SERVER mode sessions.
    StretchedNetworks []NsxtEdgegatewayL2VpnTunnelStretchedNetworkArgs
    One or more stretched networks for the tunnel. See stretched_network for more detail.
    TunnelInterface string
    The network CIDR block over which the session interfaces. Relevant only for SERVER mode sessions. If not provided, Cloud Director will attempt to automatically allocate a tunnel interface.
    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    localEndpointIp String
    The IP address corresponding to the Edge Gateway the tunnel is being configured on. The IP must be sub-allocated on the Edge Gateway.
    remoteEndpointIp String
    The IP address of the remote endpoint, which corresponds to the device on the remote site terminating the VPN tunnel.
    sessionMode String
    Mode of the tunnel session (SERVER or CLIENT).
    connectorInitiationMode String
    Mode in which the connection is formed. Required for SERVER mode sessions. One of:

    • INITIATOR - Local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from the peer gateway.
    • RESPOND_ONLY - Local endpoint shall only respond to incoming tunnel setup requests, it shall not initiate the tunnel setup.
    • ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received, and will also respond to incoming initiation requests.
    description String
    The description of the tunnel.
    enabled Boolean
    State of the SERVER mode session, always set to true for CLIENT mode sessions. Default is true.
    name String
    The name of the tunnel.
    nsxtEdgegatewayL2VpnTunnelId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    peerCode String
    Base64 encoded string of the full configuration of the tunnel provided by the SERVER session. It is a computed field for SERVER sessions and is a required field for CLIENT sessions.
    preSharedKey String
    The key that is used for authenticating the connection. Required for SERVER mode sessions.
    stretchedNetworks List<NsxtEdgegatewayL2VpnTunnelStretchedNetwork>
    One or more stretched networks for the tunnel. See stretched_network for more detail.
    tunnelInterface String
    The network CIDR block over which the session interfaces. Relevant only for SERVER mode sessions. If not provided, Cloud Director will attempt to automatically allocate a tunnel interface.
    edgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    localEndpointIp string
    The IP address corresponding to the Edge Gateway the tunnel is being configured on. The IP must be sub-allocated on the Edge Gateway.
    remoteEndpointIp string
    The IP address of the remote endpoint, which corresponds to the device on the remote site terminating the VPN tunnel.
    sessionMode string
    Mode of the tunnel session (SERVER or CLIENT).
    connectorInitiationMode string
    Mode in which the connection is formed. Required for SERVER mode sessions. One of:

    • INITIATOR - Local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from the peer gateway.
    • RESPOND_ONLY - Local endpoint shall only respond to incoming tunnel setup requests, it shall not initiate the tunnel setup.
    • ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received, and will also respond to incoming initiation requests.
    description string
    The description of the tunnel.
    enabled boolean
    State of the SERVER mode session, always set to true for CLIENT mode sessions. Default is true.
    name string
    The name of the tunnel.
    nsxtEdgegatewayL2VpnTunnelId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    peerCode string
    Base64 encoded string of the full configuration of the tunnel provided by the SERVER session. It is a computed field for SERVER sessions and is a required field for CLIENT sessions.
    preSharedKey string
    The key that is used for authenticating the connection. Required for SERVER mode sessions.
    stretchedNetworks NsxtEdgegatewayL2VpnTunnelStretchedNetwork[]
    One or more stretched networks for the tunnel. See stretched_network for more detail.
    tunnelInterface string
    The network CIDR block over which the session interfaces. Relevant only for SERVER mode sessions. If not provided, Cloud Director will attempt to automatically allocate a tunnel interface.
    edge_gateway_id str
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    local_endpoint_ip str
    The IP address corresponding to the Edge Gateway the tunnel is being configured on. The IP must be sub-allocated on the Edge Gateway.
    remote_endpoint_ip str
    The IP address of the remote endpoint, which corresponds to the device on the remote site terminating the VPN tunnel.
    session_mode str
    Mode of the tunnel session (SERVER or CLIENT).
    connector_initiation_mode str
    Mode in which the connection is formed. Required for SERVER mode sessions. One of:

    • INITIATOR - Local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from the peer gateway.
    • RESPOND_ONLY - Local endpoint shall only respond to incoming tunnel setup requests, it shall not initiate the tunnel setup.
    • ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received, and will also respond to incoming initiation requests.
    description str
    The description of the tunnel.
    enabled bool
    State of the SERVER mode session, always set to true for CLIENT mode sessions. Default is true.
    name str
    The name of the tunnel.
    nsxt_edgegateway_l2_vpn_tunnel_id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    peer_code str
    Base64 encoded string of the full configuration of the tunnel provided by the SERVER session. It is a computed field for SERVER sessions and is a required field for CLIENT sessions.
    pre_shared_key str
    The key that is used for authenticating the connection. Required for SERVER mode sessions.
    stretched_networks Sequence[NsxtEdgegatewayL2VpnTunnelStretchedNetworkArgs]
    One or more stretched networks for the tunnel. See stretched_network for more detail.
    tunnel_interface str
    The network CIDR block over which the session interfaces. Relevant only for SERVER mode sessions. If not provided, Cloud Director will attempt to automatically allocate a tunnel interface.
    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    localEndpointIp String
    The IP address corresponding to the Edge Gateway the tunnel is being configured on. The IP must be sub-allocated on the Edge Gateway.
    remoteEndpointIp String
    The IP address of the remote endpoint, which corresponds to the device on the remote site terminating the VPN tunnel.
    sessionMode String
    Mode of the tunnel session (SERVER or CLIENT).
    connectorInitiationMode String
    Mode in which the connection is formed. Required for SERVER mode sessions. One of:

    • INITIATOR - Local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from the peer gateway.
    • RESPOND_ONLY - Local endpoint shall only respond to incoming tunnel setup requests, it shall not initiate the tunnel setup.
    • ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received, and will also respond to incoming initiation requests.
    description String
    The description of the tunnel.
    enabled Boolean
    State of the SERVER mode session, always set to true for CLIENT mode sessions. Default is true.
    name String
    The name of the tunnel.
    nsxtEdgegatewayL2VpnTunnelId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    peerCode String
    Base64 encoded string of the full configuration of the tunnel provided by the SERVER session. It is a computed field for SERVER sessions and is a required field for CLIENT sessions.
    preSharedKey String
    The key that is used for authenticating the connection. Required for SERVER mode sessions.
    stretchedNetworks List<Property Map>
    One or more stretched networks for the tunnel. See stretched_network for more detail.
    tunnelInterface String
    The network CIDR block over which the session interfaces. Relevant only for SERVER mode sessions. If not provided, Cloud Director will attempt to automatically allocate a tunnel interface.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NsxtEdgegatewayL2VpnTunnel 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 NsxtEdgegatewayL2VpnTunnel Resource

    Get an existing NsxtEdgegatewayL2VpnTunnel 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?: NsxtEdgegatewayL2VpnTunnelState, opts?: CustomResourceOptions): NsxtEdgegatewayL2VpnTunnel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connector_initiation_mode: Optional[str] = None,
        description: Optional[str] = None,
        edge_gateway_id: Optional[str] = None,
        enabled: Optional[bool] = None,
        local_endpoint_ip: Optional[str] = None,
        name: Optional[str] = None,
        nsxt_edgegateway_l2_vpn_tunnel_id: Optional[str] = None,
        org: Optional[str] = None,
        peer_code: Optional[str] = None,
        pre_shared_key: Optional[str] = None,
        remote_endpoint_ip: Optional[str] = None,
        session_mode: Optional[str] = None,
        stretched_networks: Optional[Sequence[NsxtEdgegatewayL2VpnTunnelStretchedNetworkArgs]] = None,
        tunnel_interface: Optional[str] = None) -> NsxtEdgegatewayL2VpnTunnel
    func GetNsxtEdgegatewayL2VpnTunnel(ctx *Context, name string, id IDInput, state *NsxtEdgegatewayL2VpnTunnelState, opts ...ResourceOption) (*NsxtEdgegatewayL2VpnTunnel, error)
    public static NsxtEdgegatewayL2VpnTunnel Get(string name, Input<string> id, NsxtEdgegatewayL2VpnTunnelState? state, CustomResourceOptions? opts = null)
    public static NsxtEdgegatewayL2VpnTunnel get(String name, Output<String> id, NsxtEdgegatewayL2VpnTunnelState state, CustomResourceOptions options)
    resources:  _:    type: vcd:NsxtEdgegatewayL2VpnTunnel    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:
    ConnectorInitiationMode string
    Mode in which the connection is formed. Required for SERVER mode sessions. One of:

    • INITIATOR - Local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from the peer gateway.
    • RESPOND_ONLY - Local endpoint shall only respond to incoming tunnel setup requests, it shall not initiate the tunnel setup.
    • ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received, and will also respond to incoming initiation requests.
    Description string
    The description of the tunnel.
    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    Enabled bool
    State of the SERVER mode session, always set to true for CLIENT mode sessions. Default is true.
    LocalEndpointIp string
    The IP address corresponding to the Edge Gateway the tunnel is being configured on. The IP must be sub-allocated on the Edge Gateway.
    Name string
    The name of the tunnel.
    NsxtEdgegatewayL2VpnTunnelId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    PeerCode string
    Base64 encoded string of the full configuration of the tunnel provided by the SERVER session. It is a computed field for SERVER sessions and is a required field for CLIENT sessions.
    PreSharedKey string
    The key that is used for authenticating the connection. Required for SERVER mode sessions.
    RemoteEndpointIp string
    The IP address of the remote endpoint, which corresponds to the device on the remote site terminating the VPN tunnel.
    SessionMode string
    Mode of the tunnel session (SERVER or CLIENT).
    StretchedNetworks List<NsxtEdgegatewayL2VpnTunnelStretchedNetwork>
    One or more stretched networks for the tunnel. See stretched_network for more detail.
    TunnelInterface string
    The network CIDR block over which the session interfaces. Relevant only for SERVER mode sessions. If not provided, Cloud Director will attempt to automatically allocate a tunnel interface.
    ConnectorInitiationMode string
    Mode in which the connection is formed. Required for SERVER mode sessions. One of:

    • INITIATOR - Local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from the peer gateway.
    • RESPOND_ONLY - Local endpoint shall only respond to incoming tunnel setup requests, it shall not initiate the tunnel setup.
    • ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received, and will also respond to incoming initiation requests.
    Description string
    The description of the tunnel.
    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    Enabled bool
    State of the SERVER mode session, always set to true for CLIENT mode sessions. Default is true.
    LocalEndpointIp string
    The IP address corresponding to the Edge Gateway the tunnel is being configured on. The IP must be sub-allocated on the Edge Gateway.
    Name string
    The name of the tunnel.
    NsxtEdgegatewayL2VpnTunnelId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    PeerCode string
    Base64 encoded string of the full configuration of the tunnel provided by the SERVER session. It is a computed field for SERVER sessions and is a required field for CLIENT sessions.
    PreSharedKey string
    The key that is used for authenticating the connection. Required for SERVER mode sessions.
    RemoteEndpointIp string
    The IP address of the remote endpoint, which corresponds to the device on the remote site terminating the VPN tunnel.
    SessionMode string
    Mode of the tunnel session (SERVER or CLIENT).
    StretchedNetworks []NsxtEdgegatewayL2VpnTunnelStretchedNetworkArgs
    One or more stretched networks for the tunnel. See stretched_network for more detail.
    TunnelInterface string
    The network CIDR block over which the session interfaces. Relevant only for SERVER mode sessions. If not provided, Cloud Director will attempt to automatically allocate a tunnel interface.
    connectorInitiationMode String
    Mode in which the connection is formed. Required for SERVER mode sessions. One of:

    • INITIATOR - Local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from the peer gateway.
    • RESPOND_ONLY - Local endpoint shall only respond to incoming tunnel setup requests, it shall not initiate the tunnel setup.
    • ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received, and will also respond to incoming initiation requests.
    description String
    The description of the tunnel.
    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    enabled Boolean
    State of the SERVER mode session, always set to true for CLIENT mode sessions. Default is true.
    localEndpointIp String
    The IP address corresponding to the Edge Gateway the tunnel is being configured on. The IP must be sub-allocated on the Edge Gateway.
    name String
    The name of the tunnel.
    nsxtEdgegatewayL2VpnTunnelId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    peerCode String
    Base64 encoded string of the full configuration of the tunnel provided by the SERVER session. It is a computed field for SERVER sessions and is a required field for CLIENT sessions.
    preSharedKey String
    The key that is used for authenticating the connection. Required for SERVER mode sessions.
    remoteEndpointIp String
    The IP address of the remote endpoint, which corresponds to the device on the remote site terminating the VPN tunnel.
    sessionMode String
    Mode of the tunnel session (SERVER or CLIENT).
    stretchedNetworks List<NsxtEdgegatewayL2VpnTunnelStretchedNetwork>
    One or more stretched networks for the tunnel. See stretched_network for more detail.
    tunnelInterface String
    The network CIDR block over which the session interfaces. Relevant only for SERVER mode sessions. If not provided, Cloud Director will attempt to automatically allocate a tunnel interface.
    connectorInitiationMode string
    Mode in which the connection is formed. Required for SERVER mode sessions. One of:

    • INITIATOR - Local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from the peer gateway.
    • RESPOND_ONLY - Local endpoint shall only respond to incoming tunnel setup requests, it shall not initiate the tunnel setup.
    • ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received, and will also respond to incoming initiation requests.
    description string
    The description of the tunnel.
    edgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    enabled boolean
    State of the SERVER mode session, always set to true for CLIENT mode sessions. Default is true.
    localEndpointIp string
    The IP address corresponding to the Edge Gateway the tunnel is being configured on. The IP must be sub-allocated on the Edge Gateway.
    name string
    The name of the tunnel.
    nsxtEdgegatewayL2VpnTunnelId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    peerCode string
    Base64 encoded string of the full configuration of the tunnel provided by the SERVER session. It is a computed field for SERVER sessions and is a required field for CLIENT sessions.
    preSharedKey string
    The key that is used for authenticating the connection. Required for SERVER mode sessions.
    remoteEndpointIp string
    The IP address of the remote endpoint, which corresponds to the device on the remote site terminating the VPN tunnel.
    sessionMode string
    Mode of the tunnel session (SERVER or CLIENT).
    stretchedNetworks NsxtEdgegatewayL2VpnTunnelStretchedNetwork[]
    One or more stretched networks for the tunnel. See stretched_network for more detail.
    tunnelInterface string
    The network CIDR block over which the session interfaces. Relevant only for SERVER mode sessions. If not provided, Cloud Director will attempt to automatically allocate a tunnel interface.
    connector_initiation_mode str
    Mode in which the connection is formed. Required for SERVER mode sessions. One of:

    • INITIATOR - Local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from the peer gateway.
    • RESPOND_ONLY - Local endpoint shall only respond to incoming tunnel setup requests, it shall not initiate the tunnel setup.
    • ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received, and will also respond to incoming initiation requests.
    description str
    The description of the tunnel.
    edge_gateway_id str
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    enabled bool
    State of the SERVER mode session, always set to true for CLIENT mode sessions. Default is true.
    local_endpoint_ip str
    The IP address corresponding to the Edge Gateway the tunnel is being configured on. The IP must be sub-allocated on the Edge Gateway.
    name str
    The name of the tunnel.
    nsxt_edgegateway_l2_vpn_tunnel_id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    peer_code str
    Base64 encoded string of the full configuration of the tunnel provided by the SERVER session. It is a computed field for SERVER sessions and is a required field for CLIENT sessions.
    pre_shared_key str
    The key that is used for authenticating the connection. Required for SERVER mode sessions.
    remote_endpoint_ip str
    The IP address of the remote endpoint, which corresponds to the device on the remote site terminating the VPN tunnel.
    session_mode str
    Mode of the tunnel session (SERVER or CLIENT).
    stretched_networks Sequence[NsxtEdgegatewayL2VpnTunnelStretchedNetworkArgs]
    One or more stretched networks for the tunnel. See stretched_network for more detail.
    tunnel_interface str
    The network CIDR block over which the session interfaces. Relevant only for SERVER mode sessions. If not provided, Cloud Director will attempt to automatically allocate a tunnel interface.
    connectorInitiationMode String
    Mode in which the connection is formed. Required for SERVER mode sessions. One of:

    • INITIATOR - Local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from the peer gateway.
    • RESPOND_ONLY - Local endpoint shall only respond to incoming tunnel setup requests, it shall not initiate the tunnel setup.
    • ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received, and will also respond to incoming initiation requests.
    description String
    The description of the tunnel.
    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    enabled Boolean
    State of the SERVER mode session, always set to true for CLIENT mode sessions. Default is true.
    localEndpointIp String
    The IP address corresponding to the Edge Gateway the tunnel is being configured on. The IP must be sub-allocated on the Edge Gateway.
    name String
    The name of the tunnel.
    nsxtEdgegatewayL2VpnTunnelId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    peerCode String
    Base64 encoded string of the full configuration of the tunnel provided by the SERVER session. It is a computed field for SERVER sessions and is a required field for CLIENT sessions.
    preSharedKey String
    The key that is used for authenticating the connection. Required for SERVER mode sessions.
    remoteEndpointIp String
    The IP address of the remote endpoint, which corresponds to the device on the remote site terminating the VPN tunnel.
    sessionMode String
    Mode of the tunnel session (SERVER or CLIENT).
    stretchedNetworks List<Property Map>
    One or more stretched networks for the tunnel. See stretched_network for more detail.
    tunnelInterface String
    The network CIDR block over which the session interfaces. Relevant only for SERVER mode sessions. If not provided, Cloud Director will attempt to automatically allocate a tunnel interface.

    Supporting Types

    NsxtEdgegatewayL2VpnTunnelStretchedNetwork, NsxtEdgegatewayL2VpnTunnelStretchedNetworkArgs

    NetworkId string
    ID of the Org VDC network
    TunnelId double
    Tunnel ID of the network for the tunnel. Read-only for SERVER sessions.
    NetworkId string
    ID of the Org VDC network
    TunnelId float64
    Tunnel ID of the network for the tunnel. Read-only for SERVER sessions.
    networkId String
    ID of the Org VDC network
    tunnelId Double
    Tunnel ID of the network for the tunnel. Read-only for SERVER sessions.
    networkId string
    ID of the Org VDC network
    tunnelId number
    Tunnel ID of the network for the tunnel. Read-only for SERVER sessions.
    network_id str
    ID of the Org VDC network
    tunnel_id float
    Tunnel ID of the network for the tunnel. Read-only for SERVER sessions.
    networkId String
    ID of the Org VDC network
    tunnelId Number
    Tunnel ID of the network for the tunnel. Read-only for SERVER sessions.

    Package Details

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