Update the Configuration on a Device
post
/{versionId}/configuration/devices/{deviceId}/action
Push a device configuration stored on the SDM database to the device and ensure that it is properly activated and used as the running configuration for the device. Actions such as save, activate, and save and activate are supported.
Request
Path Parameters
Back to Top
Response
200 Response
400 Response
The user input is invalid.
401 Response
The session ID is invalid.
404 Response
The object (resource URI, device, and so on) of your input request cannot be found.
Examples
Examples of Accessing the API
See Authenticate for how to acquire a session cookie.
The following example shows how to update the configuration on a device using curl.
curl -X POST \
-b sessionid.txt \
-d@request.xml \
--header "Accept: application/xml" \
--header "Content-Type: application/xml" \
"https://example.com:8443/rest/v1.3/configuration/devices/ID9/action"The following example shows how to update the configuration on a device using Python.
import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/configuration/devices/ID9/action"
headers = { "Accept":"application/xml", "Content-Type: application/xml", "Cookie":cookie }
data = etree.tostring(etree.parse("request.json"))
resp = requests.post(url, headers=headers, data=data)Example of the Request Body
The following example shows the contents of the request body in XML.
<?xml version="1.0" encoding="UTF-8"?>
<deviceAction>
<type>SaveActivateConfig</type>
</deviceAction>The following example shows the contents of the request body in JSON.
{
"type": "SaveActivateConfig"
}Example of the Response Body
The following example shows the contents of the response body in XML.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<saveActivateResult>
<action>SaveActivateConfig</action>
<isActivateConfigSuccess>SUCCESS</isActivateConfigSuccess>
<isCreateSuccess>SUCCESS</isCreateSuccess>
<isDeviceFirmwareChangedFailure>false</isDeviceFirmwareChangedFailure>
<isEraseCacheSuccess>Not Applicable</isEraseCacheSuccess>
<isIntegrityCheckSuccess>SUCCESS</isIntegrityCheckSuccess>
<isLockSuccess>SUCCESS</isLockSuccess>
<isRestoreConfigSuccess>Not Applicable</isRestoreConfigSuccess>
<isSaveConfigSuccess>SUCCESS</isSaveConfigSuccess>
<isUnlockSuccess>SUCCESS</isUnlockSuccess>
<isValidationSuccess>SUCCESS</isValidationSuccess>
<status>SUCCESS</status>
<taskId>admin-2017-09-12-20-38-30-897-10.0.0.194</taskId>
</saveActivateResult>The following example shows the contents of the response body in JSON.
{
"action": "SaveActivateConfig",
"isActivateConfigSuccess": "SUCCESS",
"isCreateSuccess": "SUCCESS",
"isDeviceFirmwareChangedFailure": "false",
"isEraseCacheSuccess": "Not Applicable",
"isIntegrityCheckSuccess": "SUCCESS",
"isLockSuccess": "SUCCESS",
"isRestoreConfigSuccess": "Not Applicable",
"isSaveConfigSuccess": "SUCCESS",
"isUnlockSuccess": "SUCCESS",
"isValidationSuccess": "SUCCESS",
"status": "SUCCESS",
"taskId": "admin-2022-10-03-10-43-35-607-10.4.4.102"
}