NSX-T Data Center REST API

Edit a L2VPN service (Deprecated)

Edit a specific L2VPN service Deprecated:
Please use below Policy APIs.
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>

Request:

Method:

PUT

URI Path(s):

/api/v1/vpn/l2vpn/services/{l2vpn-service-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

L2VpnService+

L2VpnService (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
enable_full_mesh	Enable full mesh topology Full mesh topology auto disables traffic replication between connected peers. However, this property is deprecated. Please refer enable_hub property instead to control client to client forwarding via the server. The value of enable_full_mesh will not be used anymore. If enable_hub is not provided explicitly, the default value of it will be used.	boolean	Deprecated Default: "False"
enable_hub	Enable client to client forwarding via server This property only applies in SERVER mode. If set to true, traffic from any client will be replicated to all other clients. If set to false, traffic received from clients is only replicated to the local VPN endpoint.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
logical_router_id	Logical router id Logical router id	string	Required
logical_tap_ip_pool	IP Pool for Logical Taps IP Pool to allocate local and peer endpoint IPs for L2VpnSession logical Tap.	array of IPv4CIDRBlock
mode	L2VPN Service Mode Specify an L2VPN service mode as SERVER or CLIENT. L2VPN service in SERVER mode requires user to configure L2VPN session explicitly. L2VPN service in CLIENT mode can use peercode generated from SERVER to configure L2VPN session.	string	Enum: SERVER, CLIENT Default: "SERVER"
resource_type	Must be set to the value L2VpnService	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

{ "id": "f962173f-ac03-4d08-8366-56a41779f61d", "logical_router_id": "88a3c980-c433-43f7-80b8-987c8f80d9e1", "logical_tap_ip_pool" : [ "169.254.64.0/24" ], "mode" : "SERVER", "enable_full_mesh" : true }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

L2VpnService+

L2VpnService (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
enable_full_mesh	Enable full mesh topology Full mesh topology auto disables traffic replication between connected peers. However, this property is deprecated. Please refer enable_hub property instead to control client to client forwarding via the server. The value of enable_full_mesh will not be used anymore. If enable_hub is not provided explicitly, the default value of it will be used.	boolean	Deprecated Default: "False"
enable_hub	Enable client to client forwarding via server This property only applies in SERVER mode. If set to true, traffic from any client will be replicated to all other clients. If set to false, traffic received from clients is only replicated to the local VPN endpoint.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
logical_router_id	Logical router id Logical router id	string	Required
logical_tap_ip_pool	IP Pool for Logical Taps IP Pool to allocate local and peer endpoint IPs for L2VpnSession logical Tap.	array of IPv4CIDRBlock
mode	L2VPN Service Mode Specify an L2VPN service mode as SERVER or CLIENT. L2VPN service in SERVER mode requires user to configure L2VPN session explicitly. L2VPN service in CLIENT mode can use peercode generated from SERVER to configure L2VPN session.	string	Enum: SERVER, CLIENT Default: "SERVER"
resource_type	Must be set to the value L2VpnService	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "id": "f962173f-ac03-4d08-8366-56a41779f61d", "logical_router_id": "88a3c980-c433-43f7-80b8-987c8f80d9e1", "logical_tap_ip_pool" : [ "169.254.64.0/24" ], "mode" : "SERVER", "enable_full_mesh" : 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