[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy

Get L2VPN Peer Config

Description

Get peer config for the L2Vpn to configure the remote side of the tunnel.

  • no enforcement point path specified: L2Vpn Peer Codes will be evaluated on each enforcement point.
  • {enforcement_point_path}: L2Vpn Peer Codes are evaluated only on the given enforcement point. This API is deprecated. Please use GET /infra/tier-0s//locale-services/ /l2vpn-services/default/sessions/L2VPN_/peer-config instead.

Request

Request

URL

URL


get
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-context/l2vpns/{l2vpn-id}/peer-config
Copy

Path Parameters

Path Parameters

string
tier-0-id Required

string
locale-service-id Required

string
l2vpn-id Required

Query Parameters

Query Parameters

string
enforcement_point_path Optional

String Path of the enforcement point


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns AggregateL2VpnPeerConfig of type(s) application/json
{
	"l2vpn_path": "string",
	"l2vpn_peer_config_per_enforcement_point": [
		{
			"enforcement_point_path": "string",
			"resource_type": "L2VpnPeerCodes"
		}
	]
}
string
l2vpn_path Required

Policy path referencing the L2Vpn.


l2vpn_peer_config_per_enforcement_point Optional

List of L2Vpn peer config per Enforcement Point.

Errors

Errors

400

Bad Request


403

Forbidden


404

Not Found


412

Precondition Failed


500

Internal Server Error


503

Service Unavailable

Code Samples

Code Samples

PowerCLI Client SDK Example

Invoke-ReadL2VpnPeerConfig -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -l2vpnId "Myl2vpnId" -enforcementPointPath "MyenforcementPointPath"

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-context/l2vpns/{l2vpn-id}/peer-config
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated: null
x-vmw-doc-operation: get-l2vpn-peer-config
x-vmw-nsx-module: PolicyL2Vpn


Feedback

Was this page helpful?