Load a Configuration for a Targeted Device
get
/{versionId}/configuration/devices/{deviceId}/loadConfig
Start a provisioning (configuration modification) session. This method ensures that the targeted device configuration in the SDM database is synchronized with the configuration on the device. A new targeted device must be provisioned before any work begins to prevent any configuration with a create, read, update, destroy (CRUD) operation from failing to load.
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 load a configuration for a targeted device using curl.
curl -X GET \
-b sessionid.txt \
--header "Accept: application/xml" \
"https://example.com:8443/rest/v1.3/configuration/devices/{deviceId}/loadConfig"The following example shows how to load a configuration for a targeted device using Python.
import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/configuration/devices/{deviceId}/loadConfig"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)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"?>
<device>
<bootstrapState>Activated</bootstrapState>
<connectivityStatus>true</connectivityStatus>
<id>ID10</id>
<ip>10.0.17.193</ip>
<key>sbc193_10.0.17.193</key>
<manageable>true</manageable>
<name>sbc193</name>
<nfId>ID36</nfId>
<nfName>sbc193</nfName>
<parentGroupId>ID36</parentGroupId>
<platformInfo>
<platform>NNOSVM</platform>
<serialNumber>--</serialNumber>
</platformInfo>
<softwareInfo>
<configVersion>52</configVersion>
<version>SCZ910</version>
</softwareInfo>
<loadedConfigVersion>52</loadedConfigVersion>
<pendingChanges>0</pendingChanges>
</device>The following example shows the contents of the response body in JSON.
{
"type": "restManagedDevice",
"bootstrapState": "Activated",
"connectivityStatus": true,
"id": "ID5",
"ip": "10.4.4.177",
"key": "sd177_10.4.4.177",
"manageable": true,
"name": "sd177",
"nfId": "ID13",
"nfName": "sd177",
"parentGroupId": "ID13",
"platformInfo": {
"platform": "3820",
"serialNumber": "00:00:00:00:00:00:00:00:00:00:00:00",
"timeZoneInfo": {
"daySaveTimeEnd": "102603",
"daySaveTimeStart": "033003",
"minFromUTC": "0"
}
},
"softwareInfo": {
"configVersion": "21444",
"version": "SCX640m7p4"
},
"loadedConfigVersion": "21444",
"pendingChanges": "0"
}