Read DHCP server status

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/dhcp-server-configs/{config-id}/status
/policy/api/v1/global-infra/dhcp-server-configs/{config-id}/status
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{config-id}/status

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>/policy/api/v1/infra/dhcp-server-configs/default/status?connectivity_path=/infra/tier-1s/it_t1&enforcement_point_path=/infra/sites/default/enforcement-points/default

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

DhcpServerStatus+

Name	Description	Type	Notes
active_node	uuid of active transport node	string	Required
error_message	Error message, if available	string
service_status	UP means the dhcp service is working fine on both active transport-node and stand-by transport-node (if have), hence fail-over can work at this time if there is failure happens on one of the transport-node; DOWN means the dhcp service is down on both active transport-node and stand-by node (if have), hence the dhcp-service will not repsonse any dhcp request; Error means error happens on transport-node(s) or no status is reported from transport-node(s). The dhcp service may be working (or not working); NO_STANDBY means dhcp service is working in one of the transport node while not in the other transport-node (if have). Hence if the dhcp service in the working transport-node is down, fail-over will not happen and the dhcp service will go down.	string	Required Enum: UP, DOWN, ERROR, NO_STANDBY
stand_by_node	uuid of stand_by transport node. null if non-HA mode	string

Example Response:

{ "active_node": "/infra/sites/default/enforcement-points/default/edge-clusters/43436d79-05ce-4c0b-b31f-078989d4e6fd/edge-nodes/bf80b020-2df8-11ea-986b-000c291ec83c", "stand_by_node": "/infra/sites/default/enforcement-points/default/edge-clusters/43436d79-05ce-4c0b-b31f-078989d4e6fd/edge-nodes/c03dadec-2df8-11ea-a4e6-000c295fbd46", "service_status": "UP" }

Read DHCP server status

Request:

DhcpServerRequestParameters (schema)

Example Request:

Successful Response:

DhcpServerStatus (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: