NSX Autonomous Edge REST API

Create an L2VPN session for HCX

Create an L2VPN session and the underlying L3VPN session.

Request:

Method:

POST

URI Path(s):

/vpn/l2vpn/sessions

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

L2VPNSession+

L2VPNSession (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	integer	Readonly
_schema	Location of schema for this resource	string	Readonly
_self		SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
actions	Actions applicable to the resource at this time	array of ActionDescriptor	Readonly
description	Description of the L2VPN session Description of the L2VPN session	string
display_name	Name of L2VPN session Name of L2VPN session	string
enabled	Enable L2VPN session Enable to extend all the associated logical switches.	boolean	Default: "True"
encryptionless	Encryptionless flag Flag to skip IPSec processing and encryption for L2 encapsulation	boolean	Default: "False"
id	Unique identifier of this resource	string	Readonly Sortable
notify_mpa	send notification to MPA about this config change (applicable on edge node)	boolean	Default: "False"
resource_type	Must be set to the value L2VPNSession	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_mss_clamping	TCP MSS Clamping Enables the TCP MSS clamping for the L2Vpn session	boolean
tcp_mss_value	TCP MSS Clamping value TCP MSS clamping value for the L2Vpn session	integer
transport_tunnels	List of L2VPN Transport Tunnel List of L2VPN transport tunnel.	array of TransportTunnel	Required Minimum items: 1 Maximum items: 4
tunnel_encapsulation	Encapsulation Tunnel Encapsulation Tunnel used by the L2VPN session.	TunnelEncapsulation

Example Request:

POST https://<ip>/api/v1/vpn/l2vpn/sessions { "display_name" : "L2VPN session for network extension", "encryptionless" : false, "tcp_mss_clamping" : true, "tcp_mss_value" : 1600, "transport_tunnels" : [ { "local_address" : "10.10.10.1", "peer_address" : "20.20.20.1", "certificate_id" : "2b9bd96f-a8ff-4649-bb95-72594934ef0a", "trust_ca_ids" : ["998fdcd0-343c-499d-85eb-f99f68776282"], "peer_certificate" : "-----BEGIN CERTIFICATE-----\n----END CERTIFICATE-----\n", "multipath": false, "connection_initiation_mode" : "INITIATOR", "local_vti_ip" : "192.168.50.1/31" } ], "tunnel_encapsulation" : { "protocol" : "GRE", "local_endpoint_ip" : "169.254.64.1", "peer_endpoint_ip" : "169.254.64.2" } }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

L2VPNSession+

L2VPNSession (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	integer	Readonly
_schema	Location of schema for this resource	string	Readonly
_self		SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
actions	Actions applicable to the resource at this time	array of ActionDescriptor	Readonly
description	Description of the L2VPN session Description of the L2VPN session	string
display_name	Name of L2VPN session Name of L2VPN session	string
enabled	Enable L2VPN session Enable to extend all the associated logical switches.	boolean	Default: "True"
encryptionless	Encryptionless flag Flag to skip IPSec processing and encryption for L2 encapsulation	boolean	Default: "False"
id	Unique identifier of this resource	string	Readonly Sortable
notify_mpa	send notification to MPA about this config change (applicable on edge node)	boolean	Default: "False"
resource_type	Must be set to the value L2VPNSession	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_mss_clamping	TCP MSS Clamping Enables the TCP MSS clamping for the L2Vpn session	boolean
tcp_mss_value	TCP MSS Clamping value TCP MSS clamping value for the L2Vpn session	integer
transport_tunnels	List of L2VPN Transport Tunnel List of L2VPN transport tunnel.	array of TransportTunnel	Required Minimum items: 1 Maximum items: 4
tunnel_encapsulation	Encapsulation Tunnel Encapsulation Tunnel used by the L2VPN session.	TunnelEncapsulation

Example Response:

{ "id" : "36004fe6-f995-4e6f-b3ff-3c349915a040", "display_name" : "L2VPN session for network extension", "encryptionless" : false, "tcp_mss_clamping" : true, "tcp_mss_value" : 1600, "transport_tunnels" : [ { "local_address" : "10.10.10.1", "peer_address" : "20.20.20.1", "peer_id" : "C = IN, ST = Karnataka, O = VCF, OU = BCM, CN = left", "multipath": false, "connection_initiation_mode" : "INITIATOR", "local_vti_ip" : "192.168.50.1/31", "ipsec_session_id" : "bb28d7e0-67af-4a6f-b64f-bc56ee401203" } ], "tunnel_encapsulation" : { "protocol" : "GRE", "local_endpoint_ip" : "169.254.64.1", "peer_endpoint_ip" : "169.254.64.2" }, "enabled" : true }

Required Permissions:

crud

Feature:

vpn

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable