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

Get IPsec VPN Session Stats

Description

  • no enforcement point path specified: statistics are evaluated on each enforcement point.
  • an enforcement point path is specified: statistics are evaluated only on the given enforcement point.
  • source=realtime: statistics are fetched realtime from the enforcement point.
  • source=cached: cached statistics from enforcement point are returned.

Request

Request

URL

URL


get
https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
Copy

Path Parameters

Path Parameters

string
tier-1-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: realtimecached


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns AggregateIPSecVpnSessionStatistics of type(s) application/json
This response body class contains all of the following: AggregatePolicyRuntimeInfo, InlineAggregateIPSecVpnSessionStatistics1
Errors

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

Code Samples

PowerCLI Client SDK Example

Invoke-GetTier1IPSecVpnSessionStatistics -tier1Id "Mytier1Id" -localeServiceId "MylocaleServiceId" -serviceId "MyserviceId" -sessionId "MysessionId" -enforcementPointPath "MyenforcementPointPath" -source "realtime"

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get-ipsec-vpn-session-stats
x-vmw-nsx-module: PolicyVPNStatistics


Feedback

Was this page helpful?