NSX-T Data Center REST API
IPSecVPNSessionListParameters (schema)
List parameters for IPSec VPN Sessions
Parameters to get filtered list of IPSec VPN Sessions. The filter parameters are not mutually exclusive and can be used together.
| 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 Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs. |
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 |