NSX-T Data Center REST API

PolicyEdgeTransportNodeListRequestParameters (type)

{
  "additionalProperties": false,
  "description": "Policy Edge Transport Node list request parameters.",
  "extends": {
    "$ref": "PolicyListRequestParameters"
  },
  "id": "PolicyEdgeTransportNodeListRequestParameters",
  "module_id": "PolicyEdgeTransportNode",
  "properties": {
    "cursor": {
      "readonly": false,
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
      "type": "string"
    },
    "in_maintenance_mode": {
      "description": "If the flag is true then edge transport nodes with maintenance mode 'ENABLED' in desired state will be returned, otherwise edge transport nodes in 'DISABLED' desired state will be returned.",
      "required": false,
      "title": "Maintenance mode flag",
      "type": "boolean"
    },
    "include_mark_for_delete_objects": {
      "default": false,
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.",
      "required": false,
      "title": "Include objects that are marked for deletion in results",
      "type": "boolean"
    },
    "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"
    },
    "management_ip": {
      "description": "Edge transport node with provided management IP address will be returned. This property can only be used alone. It can not be combined with other filtering properties.",
      "required": false,
      "title": "Edge transport node management IP address",
      "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"
    },
    "sort_ascending": {
      "type": "boolean"
    },
    "sort_by": {
      "title": "Field by which records are sorted",
      "type": "string"
    },
    "transport_zone_path": {
      "description": "Edge transport nodes with provided transport zone path will be returned.",
      "required": false,
      "title": "Transport zone path",
      "type": "string"
    }
  },
  "title": "Policy Edge Transport Node List Request Parameters",
  "type": "object"
}