DHCP

The following are the DHCP REST APIs:

List POAP Scopes

Resource Name

/poap/dhcp/scopes

Description

List of POAP DHCP scopes

https Method

GET

URL

https://dcnm-ip/rest/poap/dhcp/scopes

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

Poap-scopes

A

A list of scope objects including scope name, ip-range, default-lease-time, max-lease-time, tftp-server-ip-address, tftp-server-username, tftp-server-password, boot-script-path is displayed.

Status Code

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

Create a POAP Scope

Resource Name

/poap/dhcp/scopes

Description

Create a new DHCP scope for POAP.

https Method

POST

URL

https://dcnm-ip/rest/poap/dhcp/scopes

Parameter

Parameter
Type
Description

Poap-scope

 

Displays a list of POAP scope objects including scope name and ip-range, default-lease-time, max-lease-time, tftp-server-ip-address, tftp-server-username, tftp-server-password, boot-script-path.

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

scope-name

S

DHCP scope name.

Status Code

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

Update a POAP Scope

Resource Name

/poap/dhcp/scopes/{scope-name}

Description

Update a DHCP scope for POAP.

https Method

PUT

URL

https://dcnm-ip/rest/poap/dhcp/scopes/{scope-name}

Parameter

Parameter
Type
Description

Poap-scope

O

Displays a list of POAP scope objects including scope name and switch-settings, switch-settings includes ip-range, default-lease-time, max-lease-time, tftp-server-ip-address, tftp-server-username, tftp-server-password, boot-script-path

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

 

 

Status Code

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

Delete a POAP Scope

Resource Name

/poap/dhcp/scopes/{scope-name}

Description

Delete a DHCP scope for POAP.

https Method

DELETE

URL

https://dcnm-ip/rest/poap/dhcp/scopes/{scope-name}

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

 

 

Status Code

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error