NSX-T Data Center REST API

VirtualNetworkApplianceListRequestParameters (type)

{
  "additionalProperties": false,
  "description": "Virtual network appliance(VNA) list request parameters.",
  "extends": {
    "$ref": "PolicyListRequestParameters"
  },
  "id": "VirtualNetworkApplianceListRequestParameters",
  "module_id": "NetworkAppliance",
  "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 virtual network appliances (VNA) with maintenance mode 'ENABLED' in desired state will be returned, otherwise virtual network appliances (VNA) 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": "Virtual network appliance(VNA) 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": "Virtual Network Appliance 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": {
      "title": "If true, results are sorted in ascending order",
      "type": "boolean"
    },
    "sort_by": {
      "title": "Field by which records are sorted",
      "type": "string"
    },
    "transport_zone_path": {
      "description": "Virtual Network Appliance with provided transport zone path will be returned.",
      "required": false,
      "title": "Transport zone path",
      "type": "string"
    }
  },
  "title": "Virtual Network Appliance List Request Parameters",
  "type": "object"
}