Developer Documentation
Create L2VPN Session From Peer Code
Create or patch an L2VPN session from Peer Codes. In addition to the L2VPN Session, the IPSec VPN Session, along with the IKE, Tunnel, and DPD Profiles are created and owned by the system. IPSec VPN Service and Local Endpoint are created only when required, i.e., an IPSec VPN Service does not already exist, or an IPSec VPN Local Endpoint with same local address does not already exist. Updating the L2VPN Session can be performed only through this API by specifying new peer codes. Use of specific APIs to update the L2VPN Session and the different resources associated with it is not allowed, except for IPSec VPN Service and Local Endpoint, resources that are not system owned. API supported only when L2VPN Service is in Client Mode.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}?action=create_with_peer_code
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Not available |
| required |
|
string | Not available |
| required |
|
string | Not available |
| required |
|
string | Not available |
Request Body
Request Body
Contains
L2VPNSessionData
(required)
{
"description": "string",
"display_name": "string",
"enabled": false,
"transport_tunnels": [
{
"local_address": "string",
"peer_address": "string",
"peer_code": "string"
}
]
}| Required | Property Name | Type | Description |
|---|---|---|---|
| optional | description | string |
Description of L2VPN Session |
| optional | display_name | string |
Defaults to id if not set. |
| optional | enabled | boolean |
Enable to extend all the associated segments. |
| optional | transport_tunnels | array of L2VPNSessionTransportTunnelData |
List of L2VPN transport tunnel data. |
Errors
| Code | Returns | Description |
|---|---|---|
| 403 | Forbidden | The server understood the request, but is refusing to fulfill it. |
| 404 | NotFound | The requested resource could not be found but may be available again in the future. |
| 412 | PreconditionFailed | Not available |
| 500 | InternalServerError | The server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | ServiceUnavailable | The server is currently unavailable (because it is overloaded or down for maintenance). |
| 400 | BadRequest | The request cannot be fulfilled due to bad syntax. |
On This Page
Locale Services L2VPN Operations
put
delete
delete
delete
get
get
get
patch
patch
patch
