| address |
IP or MAC address
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.
|
string |
|
| connectivity_path |
String Path of Tier0, Tier1 or Segment
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.
|
string |
Required |
| cursor |
Opaque cursor to be used for getting next page of records (supplied by current result page) |
string |
|
| enforcement_point_path |
String Path of the enforcement point
Enforcement point path. Required when multiple enforcement points are
configured.
|
string |
|
| include_mark_for_delete_objects |
Include objects that are marked for deletion in results
If true, resources that are marked for deletion will be included
in the results. By default, these resources are not included.
|
boolean |
Default: "False" |
| included_fields |
Comma separated list of fields that should be included in query result |
string |
|
| page_size |
Maximum number of results to return in this page (server may return fewer) |
integer |
Minimum: 0
Maximum: 1000
Default: "1000" |
| segment_path |
Segment path to retrieve lease information
Segment path to retrieve lease information.
Either a "address" or a "segment_path" can be provided, but not both
in the same call.
|
string |
|
| sort_ascending |
|
boolean |
|
| sort_by |
Field by which records are sorted |
string |
|
| source |
The data source
The data source, either realtime or cached. If not provided, cached
data is returned.
|
DataSourceType |
|