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

nsx-vmc-policy

List L3VPN Sessions

Description

Paginated list of L3Vpns. This API is deprecated. Please use the following APIs instead:

GET /infra/tier-0s//locale-services//ipsec-vpn-services/ default/sessions to list all IPSecVpnSessions.
GET /infra/tier-0s//locale-services//ipsec-vpn-services/ default/local-endpoints to list all IPSecVpnLocalEndpoints.
GET /infra/ipsec-vpn-tunnel-profiles to list all IPSecVpnTunnelProfiles.
GET /infra/ipsec-vpn-ike-profiles to list all IPSecVpnIkeProfiles.
GET /infra/ipsec-vpn-dpd-profiles to list all IPSecVpnDpdProfiles. If used, this deprecated API will only return L3Vpns that were created through the deprecated PATCH and PUT /infra/tier-0s//locale-services//l3vpns/ APIs.

Request

URL

get

https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l3vpns

Copy

Path Parameters

string

tier-0-id Required

string

locale-service-id Required

Query Parameters

string

cursor Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

boolean

include_mark_for_delete_objects Optional

Include objects that are marked for deletion in results

string

included_fields Optional

Comma separated list of fields that should be included in query result

string

l3vpn_session Optional

Resource type of L3Vpn Session

Possible values are: PolicyBasedL3VpnSession , RouteBasedL3VpnSession

integer

page_size Optional

Maximum number of results to return in this page (server may return fewer)

boolean

sort_ascending Optional

string

sort_by Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Response

Response Body

200 OK

Returns L3VpnListResult of type(s) application/json

This response body class contains all of the following: ListResult, InlineL3VpnListResult1

Errors

ApiError

400

Bad Request

ApiError

403

Forbidden

ApiError

404

Not Found

ApiError

412

Precondition Failed

ApiError

500

Internal Server Error

ApiError

503

Service Unavailable

Code Samples

PowerCLI Client SDK Example

Invoke-ListL3Vpns -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -cursor "Mycursor" -includeMarkForDeleteObjects $true -includedFields "MyincludedFields" -l3vpnSession "PolicyBasedL3VpnSession" -pageSize 789 -sortAscending $true -sortBy "MysortBy"

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l3vpns

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vmw-doc-deprecated: null
x-vmw-doc-operation: list-l3vpn-sessions
x-vmw-nsx-module: PolicyL3Vpn

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

nsx-vmc-policy

Tier 0s Operations

put

Create L3VPN

delete

Delete L3VPN

get

Get L3VPN

get

Get L3VPN Peer Config

get

Get L3VPN Sessions

get

Get L3VPN Statistics

get

Get L3VPN With Sensitve Data

get

List L3VPN Sessions

patch

Update L3VPN

List L3VPN Sessions

Request

URL

Path Parameters

Query Parameters

Authentication

BasicAuth

Response

Response Body

200 OK

Errors

Code Samples

PowerCLI Client SDK Example

cURL Command

Vendor Extensions

On This Page

Tier 0s Operations

Was this page helpful?