NSX-T Data Center REST API

IPSecVPNSessionListParameters (type)

{
  "additionalProperties": false,
  "description": "Parameters to get filtered list of IPSec VPN Sessions. The filter parameters are not mutually exclusive and can be used together.",
  "extends": {
    "$ref": "ListRequestParameters"
  },
  "id": "IPSecVPNSessionListParameters",
  "module_id": "IPSecVPN",
  "properties": {
    "cursor": {
      "readonly": false,
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
      "type": "string"
    },
    "included_fields": {
      "description": "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.",
      "title": "Comma separated list of fields that should be included in query result",
      "type": "string"
    },
    "ipsec_vpn_service_id": {
      "description": "All the IPSec VPN sessions configured with the specified VPN Service id will be included in the result.",
      "required": false,
      "title": "Id of the IPSec VPN service",
      "type": "string"
    },
    "logical_router_id": {
      "description": "All the VPN sessions belonging to the specified logical router id will be included in the result.",
      "required": false,
      "title": "Id of logical router",
      "type": "string"
    },
    "page_size": {
      "default": 1000,
      "maximum": 1000,
      "minimum": 0,
      "title": "Maximum number of results to return in this page (server may return fewer)",
      "type": "integer"
    },
    "session_type": {
      "$ref": "IPSecVPNSessionResourceType",
      "description": "All the IPSec VPN sessions of specified type will be included in the result.",
      "required": false,
      "title": "Type of the vpn session"
    },
    "sort_ascending": {
      "type": "boolean"
    },
    "sort_by": {
      "title": "Field by which records are sorted",
      "type": "string"
    }
  },
  "title": "List parameters for IPSec VPN Sessions",
  "type": "object"
}