NSX-T Data Center REST API

ListAllocationStateQueryParams (type)

{
  "additionalProperties": false,
  "extends": {
    "$ref": "ListRequestParameters"
  },
  "id": "ListAllocationStateQueryParams",
  "module_id": "PolicyIpam",
  "nsx_feature": "IPSpaces",
  "properties": {
    "cidr": {
      "description": "CIDR allocated from the IpAddressBlock",
      "type": "string"
    },
    "cursor": {
      "readonly": false,
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
      "type": "string"
    },
    "include_workload_details": {
      "default": false,
      "description": "If set to true, and if the allocated CIDR is being used by a VM, the API will return details about the VM.",
      "title": "Filter details by Workload VM",
      "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"
    },
    "ip_address_block_path": {
      "description": "Policy path of the Requested IpAddressBlock",
      "type": "string"
    },
    "page_size": {
      "default": 10,
      "maximum": 10,
      "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"
    }
  },
  "title": "AllocationState common parameters",
  "type": "object"
}