Get Device Information
get
/rest/{versionId}/inventory/deviceMgmt/devices/{deviceId}
Use this (GET) method to retrieve device credentials that where provided when the device was added for a targeted device as well as additional summary information as provided in Device Manager graphical user interface.
Request
Path Parameters
Back to Top
Response
Supported Media Types
- application/xml
- application/json
200 Response
successful operation
Root Schema : device
Type:
Show Source
object
-
bootstrapState(optional):
string
-
connectivityStatus(optional):
boolean
Default Value:
false
-
description(optional):
string
-
groupParameters(optional):
array groupParameter
-
id(optional):
string
-
ip(optional):
string
-
key(optional):
string
-
manageable(optional):
boolean
Default Value:
false
-
name(optional):
string
-
nfId(optional):
string
-
nfName(optional):
string
-
parameters(optional):
array parameter
parameters
-
parentGroupId(optional):
string
-
platformInfo(optional):
object platformInfo
-
softwareInfo(optional):
object softwareInfo
Nested Schema : parameter
Type:
Show Source
object
-
description(optional):
string
-
label(optional):
string
-
maxValue(optional):
integer(int64)
-
minValue(optional):
integer(int64)
-
name(optional):
string
-
readOnly(optional):
boolean
Default Value:
false
-
validValues(optional):
array validValue
-
value(optional):
string
-
valueList(optional):
array validLists
-
valueType(optional):
string
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
The following example shows how to retrieve information for a specified device by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL
Example of cURL Data
The following shows an example of cURL data sent with the request.
curl -v -s -b sessionid.txt -X GET -H"Content-Type: application/xml" -H"Accept: application/xml" http://example.com:8080/rest/v1.1/inventory/deviceMgmt/devices/ID2
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Fri, 24 Feb 2017 19:39:17 GMT Server: Apache X-Frame-Options: SAMEORIGIN Content-Length: 1366 Vary: Accept-Encoding Content-Type: application/xml
Example of Response Body
The following example shows the contents of the response body in XML format.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <device> <connectivityStatus>true</connectivityStatus> <groupParameters> <groupParameter> <description>SNMP Community to use for device communication</description> <name>snmp.community.name</name> <readOnly>false</readOnly> <value>techpubs</value> <valueType>String</valueType> </groupParameter> <groupParameter> <description>SNMP Port to use for device communication</description> <maxValue>9223372036854775807</maxValue> <minValue>0</minValue> <name>snmp.port</name> <readOnly>false</readOnly> <value>161</value> <valueType>NumberString</valueType> </groupParameter> <groupParameter> <description>User name to use for device communication</description> <name>username</name> <readOnly>false</readOnly> <value>admin</value> <valueType>String</valueType> </groupParameter> <groupParameter> <description>Password of the user</description> <name>password</name> <readOnly>false</readOnly> <value>xxxx</value> <valueType>String</valueType> </groupParameter> </groupParameters> <id>ID2</id> <ip>10.0.0.24</ip> <key>ARISTOTLE_10.0.0.24</key> <manageable>true</manageable> <name>ARISTOTLE</name> <nfId>ID6</nfId> <nfName>sd1</nfName> <parentGroupId>ID6</parentGroupId> <platformInfo> <platform>NNOSVM</platform> <serialNumber>--</serialNumber> </platformInfo> <softwareInfo> <configVersion>5</configVersion> <version>SCZ740m1</version> </softwareInfo> </device>