Power On Auto Provisioning (POAP)
The following are the Power On Auto Provisioning (POAP) REST APIs:
Resource Name
/poap/servers
Description
List POAP image/config servers
URL
https://dcnm-ip/rest/poap/servers
https://dcnm-ip/rest/poap/servers?detail=true
Return Value
Format: JSON
Type: Object
|
|
|
|
poap-servers |
|
By default, a list of POAP image/config server names is displayed. If "detail=true"a list of POAP image/config server-objects including server-name and URI is displayed. |
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Resource Name
/poap/servers
Description
Create a new POAP image/config server
URL
https://dcnm-ip/rest/poap/servers
Parameter
|
|
|
|
poap-servers |
|
POAP image/config server-object includingserver-name,URI,hostname/ipaddress, path,username and password. |
Return Value
Format: JSON
Type: Object
|
|
|
|
poap-server-name |
|
POAP image/config server name. |
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Resource Name
/poap/servers/server-name
Description
Get the POAP image/config servers
URL
https://dcnm-ip/rest/poap/servers/server-name
Return Value
Format: JSON
Type: Object
|
|
|
|
poap-server |
|
POAP image/config server-object including server-name and URI. |
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Resource Name
/poap/servers/server-name
Description
Update the POAP image/config servers
URL
https://dcnm-ip/rest/poap/servers/server-name
Parameter
|
|
|
|
poap-server |
|
POAP image/configserver-object including server-name,hostname/ipaddress, path,username and password. |
Return Value
Format: JSON
Type: Object
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Resource Name
/poap/servers/server-name
Description
Delete the POAP image/config servers
URL
https://dcnm-ip/rest/poap/servers/server-name
Return Value
Format: JSON
Type: Object
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Resource Name
/poap/switch-definitions
Description
List the POAP switch definitions
URL
https://dcnm-ip/rest/poap/switch-definitions
https://dcnm-ip/rest/poap/switch-definitions?detail=true https://dcnm-ip/rest/poap/switch-definitions?search-string=<search-string>&start-index=<start-index>&size=<size>
Return Value
Format: JSON
Type: Object
|
|
|
|
Switch-definitions |
|
By default, a list of serial- numbers is displayed. If "detail=true", then a list of switch-definition objects including serial-numbers, status(saved and publish later/published/saved and publishing/error), system-image, kick-start-image, image-server-uri, config-server-uri, template-name, parameter-values with a list of name, type, value corresponding to the template 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 Switch Definitions
Resource Name
/poap/switch-definitions
Description
Create POAP switch definitions
URL
https://dcnm-ip/rest/poap/switch-definitions
Parameter
|
|
|
|
Switch-definitions |
|
Displays a list of serial-numbers, system-image, kick-start-image, image-server-uri, config-server-uri, template-name, poap-settings-name, parameter-values with a list of name, type, value corresponding to the template, and publish=true/false. |
Return Value
Format: JSON
Type: Object
|
|
|
|
switch-numbers |
|
List of serial numbers. |
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Publish Switch Definitions
Resource Name
/poap/published-switch-definitions/{serial-number}
Description
Publish list of switch-definitions to the Repository server.
URL
https://dcnm-ip/rest/poap/published-switch-definitions/{serial-number}
Return Value
Format: JSON
Type: Object
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Resource Name
/poap/switch-definitions/{serial-number}
Description
Get a switch definition.
URL
https://dcnm-ip/rest/poap/switch-definitions/{serial-number}
Return Value
Format: JSON
Type: Object
|
|
|
|
switch-definition |
|
Displays a list of serial-numbers, system-image, kick-start-image, image-server-uri, config-server-uri, template-name and parameter-values with a list of name, type, value corresponding to the template. |
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Update a Switch Definition
Resource Name
/poap/switch-definitions/serial-number
Description
Update a switch-definition.
URL
https://dcnm-ip/rest/poap/switch-definitions/{serial-number}
Parameter
|
|
|
|
switch-definition |
|
Displays a list of serial-numbers, system-image, kick-start-image, image-server-uri, config-server-uri, template-name and parameter-values with a list of name, type, value corresponding to the template, and publish=true/false. |
Return Value
Format: JSON
Type: Object
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Delete a Switch Definition
Resource Name
/poap/switch-definitions/serial-number
Description
Delete a switch-definition.
URL
https://dcnm-ip/rest/poap/switch-definitions/{serial-number}
Return Value
Format: JSON
Type: Object
Status Code
202 |
Accepted |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Resource Name
/poap/templates/{template-name}
Description
Get a POAP template.
URL
https://dcnm-ip/rest/poap/templates/{template-name}
Parameter
|
|
|
|
Serial-number |
S |
Device serial-number |
Return Value
Format: JSON
Type: Object
|
|
|
|
Poap-template |
O |
Poap template object |
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Resource Name
/poap/templates
Description
Create a POAP template.
URL
https://dcnm-ip/rest/poap/templates
Parameter
|
|
|
|
Poap-template |
O |
Poap template object |
Return Value
Format: JSON
Type: Object
|
|
|
|
Poap-template-name |
O |
Poap template name |
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Resource Name
/poap/templates/{template-name}
Description
Update a POAP template.
URL
https://dcnm-ip/rest/poap/templates/{template-name}
Parameter
|
|
|
|
Poap-template |
O |
Poap template object |
Return Value
Format: JSON
Type: Object
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Resource Name
/poap/templates/{template-name}
Description
Delete a POAP template.
URL
https://dcnm-ip/rest/poap/templates/{template-name}
Parameter
|
|
|
|
Poap-template-name |
S |
Poap template name |
Return Value
Format: JSON
Type: Object
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Get All Published Templates
Resource Name
/poap/templates?published=true
Description
Get all the published templates.
URL
https://dcnm-ip/rest/templates?published=true
Return Value
Format: JSON
Type: Object
|
|
|
|
templates |
O |
Returns all the published template names, if published=true. Returns all the templates if published=false. |
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Generate Template Startup Config
Resource Name
/templates/populate-template/{template-name}
Description
Get all the published templates.
URL
https://dcnm-ip/rest/templates/populate-template/{template-name}
Parameter
|
|
|
|
templateParams |
A |
Template parameters with values. You will get the templateParams in get template data API response. It returns the template parameters with default values. |
Return Value
Format: JSON
Type: Object
|
|
|
|
startupConfig |
S |
Return startup config |
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Resource Name
/templates/groups
Description
Get all the groups.
URL
https://dcnm-ip/rest/templates/groups
Return Value
Format: JSON
Type: Object
|
|
|
|
memDbId, name, navType |
S |
Return group/scope details |
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Perform Shallow Discovery
Resource Name
/templates/perform-shallow-discovery
Description
All the devices provided in payload will be discovered into DCNM.
URL
https://dcnm-ip/rest/templates/perform-shallow-discovery
Parameter
|
|
|
|
POAP |
A |
Serial Number, Management IP, Lan Group, User Name and Password need to provide in payload. |
Return Value
Format: JSON
Type: Object
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Resource Name
/poap/poap-switch-definition
Description
All the devices provided in payload will be discovered into DCNM.
URL
https://dcnm-ip/rest/poap/poap-switch-definition
Parameter
|
|
|
|
POAP |
A |
Array of template parameters and POAP switch details. |
Return Value
Format: JSON
Type: Object
|
|
|
|
poap |
A |
Array of POAPv switch details with template content. |
Status Code
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
500 |
Internal Server Error |
Feedback