NSX-T Data Center REST API

Get IPSec VPN session detailed status under Transit Gateway

- 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/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status

Request Headers:

n/a

Query Parameters:

PolicyRuntimeRequestParameters+

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/orgs/default/projects/default/transit-gateways/ext_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+

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:

transit_gateway_vpn