[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Get IPsec VPN Session Status
Description- no enforcement point path specified: detailed status is evaluated on each enforcement point.
- an enforcement point path is specified: detailed status is evaluated only on the given enforcement point.
- source=realtime: detailed status is fetched realtime from the enforcement point.
- source=cached: cached detailed status from enforcement point is returned.
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/{session-id}/detailed-status
Path Parameters
Path Parameters
string
tier-0-id
Required
string
locale-service-id
Required
string
service-id
Required
string
session-id
Required
Query Parameters
Query Parameters
string
enforcement_point_path
Optional
String Path of the enforcement point
string
source
Optional
Data source type.
Possible values are: realtime , cached
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
AggregateIPSecVpnSessionStatus
of type(s) application/json
This response body class contains all of the following:
AggregatePolicyRuntimeInfo, InlineAggregateIPSecVpnSessionStatus1
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-GetTier0IPSecVpnSessionStatus -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -serviceId "MyserviceId" -sessionId "MysessionId" -enforcementPointPath "MyenforcementPointPath" -source "realtime"
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/{session-id}/detailed-status
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get-ipsec-vpn-session-status
x-vmw-nsx-module: PolicyVPNStatistics
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Tier 0s Operations
delete
delete
patch
