NSX-T Data Center Global Manager REST API

Read DHCP server statistics

Request:

Method:

GET

URI Path(s):

/global-manager/api/v1/global-infra/dhcp-server-configs/<config-id>/stats

Request Headers:

n/a

Query Parameters:

DhcpServerRequestParameters+

DhcpServerRequestParameters (schema)

Name	Description	Type	Notes
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 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>/global-manager/api/v1/global-infra/dhcp-server-configs/default/stats?enforcement_point_path=/global-infra/sites/default/enforcement-points/default

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

DhcpServerStatistics+

DhcpServerStatistics (schema)

Name	Description	Type	Notes
acks	The total number of DHCP ACK packets	integer	Required
declines	The total number of DHCP DECLINE packets	integer	Required
dhcp_server_id	dhcp server uuid	string	Required
discovers	The total number of DHCP DISCOVER packets	integer	Required
errors	The total number of DHCP errors	integer	Required
informs	The total number of DHCP INFORM packets	integer	Required
ip_pool_stats	The DHCP ip pool usage statistics	array of DhcpIpPoolUsage
nacks	The total number of DHCP NACK packets	integer	Required
offers	The total number of DHCP OFFER packets	integer	Required
releases	The total number of DHCP RELEASE packets	integer	Required
requests	The total number of DHCP REQUEST packets	integer	Required
timestamp	timestamp of the statistics	EpochMsTimestamp	Required

Example Response:

{ "dhcp_server_id": "0c660543-5edf-463a-ace8-bec9b9651d02", "timestamp": 1578798980607, "discovers": 0, "offers": 0, "requests": 0, "acks": 0, "nacks": 0, "declines": 0, "releases": 0, "informs": 0, "errors": 0 }