NSX-T Data Center REST API

UpgradeUnitFilterListRequestParameters (type)

{
  "additionalProperties": false,
  "extends": {
    "$ref": "ListRequestParameters"
  },
  "id": "UpgradeUnitFilterListRequestParameters",
  "module_id": "Upgrade",
  "properties": {
    "component_type": {
      "readonly": false,
      "required": true,
      "title": "Component type based on which upgrade units to be filtered",
      "type": "string"
    },
    "cursor": {
      "readonly": false,
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
      "type": "string"
    },
    "group_id": {
      "readonly": false,
      "required": false,
      "title": "Identifier of group based on which upgrade units to be filtered",
      "type": "string"
    },
    "group_name": {
      "readonly": false,
      "required": false,
      "title": "Group name to be filtered",
      "type": "string"
    },
    "hypervisor": {
      "readonly": false,
      "required": false,
      "title": "Hypervisor to be filtered for the upgrade unit",
      "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"
    },
    "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"
    },
    "status": {
      "readonly": false,
      "required": false,
      "title": "Status of the upgrade unit to filtered",
      "type": "string"
    },
    "unit_ip": {
      "readonly": false,
      "required": false,
      "title": "IP of the upgrade unit to be filtered",
      "type": "string"
    },
    "unit_name": {
      "readonly": false,
      "required": false,
      "title": "Unit name to be filtered for the group",
      "type": "string"
    }
  },
  "type": "object"
}