NSX-T Data Center REST API

Get IPSec VPN session detailed status under Tier-1

- 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:

Method:

GET

URI Path(s):

/policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/detailed-status

Request Headers:

n/a

Query Parameters:

PolicyRuntimeRequestParameters+

PolicyRuntimeRequestParameters (schema)

Name	Description	Type	Notes
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/rbs-1/detailed-status

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AggregateIPSecVpnSessionStatus+

AggregateIPSecVpnSessionStatus (schema)

Name	Description	Type	Notes
intent_path	String Path of the intent object Intent path of object, forward slashes must be escaped using %2F.	string	Required Readonly
results	List of IPSec VPN Session Status per Enforcement Point List of IPSec VPN Session Status per Enforcement Point.	array of IPSecVpnSessionStatusPerEP (Abstract type: pass one of the following concrete types) IPSecVpnSessionStatusNsxT	Readonly

Required Permissions:

read

Feature:

policy_statistics

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable