NSX-T Data Center REST API
CsmVpnSessionStatusListRequestParameters (schema)
These parameters can be used to filter the list of CSM VPN sessions statuses.
Multiple parameters can be given as input. Different parameters are implicitly 'AND'ed.
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 | |
page_size | Maximum number of results to return in this page (server may return fewer) | integer | Minimum: 0 Maximum: 1000 Default: "1000" |
refresh | Flag to fetch the updated list of CSM VPN sessions statuses | boolean | Default: "False" |
sort_ascending | boolean | ||
sort_by | Field by which records are sorted | string | |
state | CSM VPN session realized state based on which the CSM VPN sessions list is to be filtered | string | Enum: DOWN, UP, IN_PROGRESS |