NSX Autonomous Edge REST API

Get a L2VPN session

Get a specific L2VPN session

Request:

Method:

GET

URI Path(s):

/vpn/l2vpn/sessions/{l2vpn-session-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<ip>/api/v1/vpn/l2vpn/sessions/a4181e5c-5532-4498-af88-1c09a452a0b6

Successful Response:

Response Code:

200 OK

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 this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enable L2VPN session Enable to extend all the associated logical switches.	boolean	Default: "True"
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
transport_tunnels	List of L2VPN Transport Tunnel List of L2VPN transport tunnel.	array of TransportTunnel	Required Minimum items: 1 Maximum items: 4

Example Response:

{ "resource_type": "L2VPNSession", "description": "L2vpn session", "id": "a4181e5c-5532-4498-af88-1c09a452a0b6", "display_name": "L2Vpn session", "transport_tunnels": [ { "peer_address": "10.10.10.10", "local_address": "20.20.20.20", "ipsec_session_id": "07829375-9aa8-4f82-9cb7-3c028bf81ca3" } ] "enabled": true }

Required Permissions:

read

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