NSX-T Data Center REST API

DhcpServerLeaseRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DhcpServerRequestParameters
  }, 
  "id": "DhcpServerLeaseRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "address": {
      "description": "IP address, IP range or MAC address to retrieve specific lease information. Either a \"address\" or a \"segment_path\" can be provided, but not both in the same call.", 
      "required": false, 
      "title": "IP or MAC address", 
      "type": "string"
    }, 
    "connectivity_path": {
      "description": "String Path of Tier0, Tier1 or Segment where DHCP server is deployed. Specify Tier0/Tier1 gateway path for DHCP server attached to the gateway. Segment path must be specified for local DHCP server configuration.", 
      "required": true, 
      "title": "String Path of Tier0, Tier1 or Segment", 
      "type": "string"
    }, 
    "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": "Enforcement point path. Required when multiple enforcement points are configured.", 
      "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"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "segment_path": {
      "description": "Segment path to retrieve lease information. Either a \"address\" or a \"segment_path\" can be provided, but not both in the same call.", 
      "required": false, 
      "title": "Segment path to retrieve lease information", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType, 
      "description": "The data source, either realtime or cached. If not provided, cached data is returned.", 
      "required": false, 
      "title": "The data source"
    }
  }, 
  "title": "DHCP server lease request parameters", 
  "type": "object"
}