NSX-T Data Center REST API

List Subnet DHCP server leases

Request:

Method:

GET

URI Path(s):

/policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/state/dhcp-server-leases

Request Headers:

n/a

Query Parameters:

SubnetDhcpServerLeaseRequestParameters+

Name	Description	Type	Notes
address	IP, IP range or MAC address IPv4 address, IPv4 range or MAC address to retrieve specific lease information.	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	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 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.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/orgs/default/projects/default/vpcs/vpc1/subnets/subnet1/state/dhcp-server-leases?address=184.168.1.3

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

DhcpLeasesResult+

DhcpLeasesResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
connectivity_path	Policy path to Segment, Tier0 or Tier1 gateway Policy path to Segment, Tier0 or Tier1 gateway where DHCP server is attached.	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
dhcp_server_id	dhcp server uuid	string
ipv6_leases	The ipv6 lease info list of the server	array of DhcpV6Lease	Minimum items: 0 Maximum items: 65535
leases	The lease info list of the server	array of DhcpLeasePerIP	Minimum items: 0 Maximum items: 65535
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly
timestamp	timestamp of the lease info	EpochMsTimestamp

Example Response:

{ "leases": [ { "subnet": "184.168.1.0", "start_time": "2017-06-26 18:34:34 +0000", "mac_address": "00:50:56:ae:6b:01", "lease_time": "3600", "expire_time": "2017-06-26 19:34:35 +0000", "ip_address": "184.168.1.3" } ], "dhcp_server_id": "9f34f749-08d9-4744-b1e9-9f079f9ce726", "timestamp": 1498503052577 }

NSX-T Data Center REST API

List Subnet DHCP server leases

Request:

SubnetDhcpServerLeaseRequestParameters (schema)

Example Request:

Successful Response:

DhcpLeasesResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: