Policy > Networking > IP Management > DHCP > DHCP Server Configs

Read DHCP server state

Read DHCP server state

Request:

Method:
GET
URI Path(s):
/policy/api/v1/global-infra/dhcp-server-configs/<config-id>/state
/policy/api/v1/infra/dhcp-server-configs/<config-id>/state
Request Headers:
n/a
Query Parameters:
DhcpServerRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/dhcp-server-configs/default/state?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:
DhcpServerState+

Example Response:

{ "details": [ { "sub_system_type": "TransportNode", "sub_system_id": "fe651e63-04bd-43a4-a8ec-45381a3b71b9", "state": "in_progress", "failure_message": "CCP Id:ab5958df-d98a-468e-a72b-d89dcdae5346, Message:State realization is in progress at the node." }, { "sub_system_type": "TransportNode", "sub_system_id": "ebe174ac-e4f1-4135-ba72-3dd2eb7099e3", "state": "in_sync" } ], "state": "in_progress", "failure_message": "The state realization is in progress at transport nodes." }

Required Permissions:

read

Feature:

policy_dhcp

Additional Errors: