The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter describes the Device Management API:
■Using the Device Management API
■Using the device-client Script
■Device Management API Method Calls
In your IoT FND NB API client application, use this IoT FND server URL to access the Device API WSDL:
The IoT FND distribution provides a Device Management API client (device-client script) in the cgms-tools- version.x86_64.rpm package. The client is wrapped by a shell script (/opt/cgms-tools/bin/device-client) to directly communicate with the IoT FND API.
device-client Commands lists device-client script commands:
|
|
---|---|
Calls the getJob API to get the status of the job for one of the commands above. |
Except for export and job, all other commands return a job ID used to query the job execution status.
This call lets the client add the devices specified in a CSV file to a managed device list in the IoT FND database. It is an asynchronous call that returns a job ID used to query the status of the add device job using the getJob call (see getJob).
addDevices Parameters describes the parameters in the interface.
addDevices Response describes the parameters in the response.
|
|
|
---|---|---|
Use the job ID to get more information about the status of this call. For more information, see getJob. |
addDevice SOAP XML Request Format
This call lets the client remove the devices specified in a CSV file from a managed devices list stored in the IoT FND database. It is an asynchronous call that returns a job ID used to query the status of this job using the getJob call (see getJob).
removeDevices Parameters describes the parameters in the interface.
removeDevices Response describes the parameters in the response.
|
|
|
---|---|---|
The job ID used to get more information about the status of this call. For more information, see getJob. |
removeDevices SOAP XML Request Format
This call sets the properties of the specified devices as defined in a CSV file.
setDevices Parameters describes the parameters in the interface.
setDevices Response describes the parameters in the response.
|
|
|
---|---|---|
The job ID used to get more information about the status of this call. For more information, see getJob. |
This call updates the properties of the specified devices with new values provided in CSV file.
updateDevice Parameters describes the parameters in the interface.
updateDevice Response describes the parameters in the response.
|
|
|
---|---|---|
The job ID used to get more information about the status of this call. For more information, see getJob. |
updateDevice SOAP XML Request Format
This call returns a list of devices found by the query. This is an asynchronous call. Unlike other device management APIs, this call is blocking until all results are consumed by the caller.
exportDevices Parameters describes the parameters in the interface.
|
|
|
---|---|---|
The query that determines the criteria of the devices to export. |
exportDevices Response describes the parameters in the response.
|
|
|
---|---|---|
The job ID used to get more information about the status of this call. For more information, see getJob. |
||
exportDevices SOAP XML Request Format
This call returns a job report describing the detailed execution status of the specified job.
getJob Parameters describes the parameters in the interface.
|
|
|
---|---|---|
getJob Results describes the parameters in the response.
|
|
|
---|---|---|
Success count represents the number of devices successfully updated. |
||
Failure count summarizes the number of devices not successfully updated. |
||
exportJob SOAP XML Request Format