NSX Autonomous Edge REST API
# ***************************************************************************
# Copyright 2020-2024 VMware, Inc. All rights reserved. VMware Confidential.
# ***************************************************************************
TransportTunnel (schema)
L2VPN Session Transport Tunnel
For client, L2VPN Session Transport Tunnel uses a peer code
which has all the information to create the transport tunnel.
| Name | Description | Type | Notes |
|---|---|---|---|
| certificate_id | Certificate Id Site certificate identifier. |
string | Pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" |
| connection_initiation_mode | Connection initiation mode Connection initiation mode used by local endpoint to establish ike connection with peer endpoint. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, 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 request. |
string | Enum: INITIATOR, RESPOND_ONLY, ON_DEMAND Default: "INITIATOR" |
| display_name | Name for transport tunnel Name for transport tunnel. |
string | |
| ipsec_session_id | Transport tunnel id Transport tunnel id. When service is in client mode, this is read only. |
string | Readonly |
| local_address | IPv4 Address of local endpoint IPv4 Address of local endpoint. This is required when service is in client mode. |
IPv4Address | |
| local_vti_ip | Local VTI interface VTI used by the RouteBased IPsecVPN session. |
IPv4CIDRBlock | |
| multipath | Mutipath flag Enables the IPSec packets to be routed via multiple paths. |
boolean | Default: "False" |
| peer_address | IPv4 Address of Peer endpoint IPv4 Address of Peer endpoint on remote site. This is required when service is in client mode. |
IPv4Address | |
| peer_certificate | Peer endpoint certificate PEM encoded certificate of Peer endpoint. |
string | |
| peer_code | Peer code for the transport tunnel Peer code represents a base64 encoded string which has all the configuration for tunnel. E.g. local/peer ids and protocol, encryption algorithm, etc. Peer code also contains PSK; be careful when sharing or storing it. This is required when service is in client mode. |
string | |
| peer_id | ID of Peer endpoint IPv4 Address/FQDN/DN of Peer endpoint on remote site. |
string | |
| psk | Pre-shared key IPSec Pre-shared key. Maximum length of this field is 128 characters. Its required input in PSK authentication mode. |
string | Minimum: 1 Maximum: 128 |
| trust_ca_ids | Certificate authority (CA) identifiers Certificate authority (CA) identifier list to verify peer certificates. |
array of string | |
| trust_crl_ids | Certificate revocation list (CRL) Identifiers Certificate revocation list (CRL) identifier list of peer certificates. |
array of string |