NSX-T Data Center REST API

IPAddressGroupAssociationRequestParams (type)

{
  "description": "List request parameters containing ip address and enforcement point path",
  "extends": {
    "$ref": "PolicyListRequestParameters"
  },
  "id": "IPAddressGroupAssociationRequestParams",
  "module_id": "PolicyGroupRealization",
  "properties": {
    "cursor": {
      "readonly": false,
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
      "type": "string"
    },
    "enforcement_point_path": {
      "description": "The path of the enforcement point from which the list of groups needs to be fetched. Forward slashes must be escaped using %2F. If no enforcement point path is specified, the default enforcement point is considered",
      "required": false,
      "title": "String Path of the enforcement point",
      "type": "string"
    },
    "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"
    },
    "ip_address": {
      "required": true,
      "title": "IPAddress",
      "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"
    }
  },
  "title": "List request parameters containing ip address and enforcement point path",
  "type": "object"
}