Edit a L2VPN session

Edit a specific L2VPN session

Request:

Method:

PUT

URI Path(s):

/api/v1/vpn/l2vpn/sessions/<l2vpn-session-id>

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	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	Sortable
l2vpn_service_id	L2VPN service id L2VPN service id	string	Required
l2vpn_tcp_mss_clamping	L2VPN TCP MSS Clamping	L2VpnTcpMssClamping
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 transport tunnels List of transport tunnels for redundancy.	array of ResourceReference	Required Minimum items: 1 Maximum items: 1
tunnel_encapsulation	Tunnel encapsulation config Tunnel encapsulation config. For hub, this property should not be provided as it will be auto-generated. For spoke, this property must be provided.	L2VpnTunnelEncapsulation

Example Request:

PUT https://<nsx-mgr>/api/v1/vpn/l2vpn/services/f962173f-ac03-4d08-8366-56a41779f611 TBD

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	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	Sortable
l2vpn_service_id	L2VPN service id L2VPN service id	string	Required
l2vpn_tcp_mss_clamping	L2VPN TCP MSS Clamping	L2VpnTcpMssClamping
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 transport tunnels List of transport tunnels for redundancy.	array of ResourceReference	Required Minimum items: 1 Maximum items: 1
tunnel_encapsulation	Tunnel encapsulation config Tunnel encapsulation config. For hub, this property should not be provided as it will be auto-generated. For spoke, this property must be provided.	L2VpnTunnelEncapsulation

Example Response:

TBD

Required Permissions:

crud

Feature:

vpn

Edit a L2VPN session

Request:

L2VpnSession (schema)

Example Request:

Successful Response:

L2VpnSession (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: