Get IPSec VPN session list result

Get paginated list of all IPSec VPN sessions.

Request:

Method:

GET

URI Path(s):

/api/v1/vpn/ipsec/sessions

Request Headers:

n/a

Query Parameters:

IPSecVPNSessionListParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
ipsec_vpn_service_id	Id of the IPSec VPN service All the IPSec VPN sessions configured with the specified VPN Service id will be included in the result.	string
logical_router_id	Id of logical router All the VPN sessions belonging to the specified logical router id will be included in the result.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
session_type	Type of the vpn session All the IPSec VPN sessions of specified type will be included in the result.	IPSecVPNSessionResourceType
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/vpn/ipsec/sessions

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IPSecVPNSessionListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	IPSec VPN sessions list result	array of IPSecVPNSession (Abstract type: pass one of the following concrete types) PolicyBasedIPSecVPNSession RouteBasedIPSecVPNSession	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count": 1, "results": [ { "resource_type": "PolicyBasedIPSecVPNSession", "id": "ee4f7777-f837-4dbb-9a03-eeb9beb52b09", "display_name": "PBS 12", "ipsec_vpn_service_id": "f770a847-a6c9-4bc0-94cb-1dd1d5ae622a", "peer_endpoint_id": "f0cb1b37-d618-4406-94eb-b4099418a165", "local_endpoint_id": "c99d8ed0-195b-46b0-8474-664b55cfb176", "enabled": true, "policy_rules": [ { "id": "1026", "sources": [ { "subnet": "1.1.1.0/24" } ], "logged": true, "destinations": [ { "subnet": "2.1.4.0/24" } ], "action": "PROTECT", "enabled": true, "_revision": 0 } ], "_create_time": 1517293798690, "_last_modified_user": "admin", "_last_modified_time": 1517293798690, "_system_owned": false, "_create_user": "admin", "_protection": "NOT_PROTECTED", "_revision": 0 } ] }

Get IPSec VPN session list result

Request:

IPSecVPNSessionListParameters (schema)

Example Request:

Successful Response:

IPSecVPNSessionListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: