[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
List IPsec VPN Sessions
DescriptionGet paginated list of all IPSec VPN sessions for a given locale service under Tier-0.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions
Path Parameters
Path Parameters
string
tier-0-id
Required
string
locale-service-id
Required
string
service-id
Required
Query Parameters
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
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.
Response
Response
Response BodyResponse Body
200 OK
Returns
IPSecVpnSessionListResult
of type(s) application/json
This response body class contains all of the following:
ListResult, InlineIPSecVpnSessionListResult1
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-ListTier0IPSecVpnSessions -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -serviceId "MyserviceId" -cursor "Mycursor" -includeMarkForDeleteObjects $true -includedFields "MyincludedFields" -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}/ipsec-vpn-services/{service-id}/sessions
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list-ipsec-vpn-sessions
x-vmw-nsx-module: PolicyIPSecVpn
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Tier 0s Operations
delete
delete
patch
