1. REST API for Session Delivery Manager Release 8.2
  2. Tasks
  3. inventory
  4. device

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

200 Response

successful operation
Body ()
Root Schema : device
Type: object
Show Source
Nested Schema : groupParameters
Type: array
Show Source
Nested Schema : parameters
Type: array
parameters
Show Source
Nested Schema : platformInfo
Type: object
Show Source
Nested Schema : softwareInfo
Type: object
Show Source
Nested Schema : parameter
Type: object
Show Source
Nested Schema : validValues
Type: array
Show Source
Nested Schema : validLists
Type: array
Show Source
Nested Schema : timeZoneInfo
Type: object
Show Source

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.
Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to get device information by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X GET -b sessionid.txt \
    --header "Accept: application/xml" \
    "https://example.com:8443/rest/v1.3/inventory/deviceMgmt/devices/ID2"

Example of Accessing the API with Python

The following example shows how to get device information by submitting a GET request on the REST resource using Python. This example assumes the cookie variable contains a valid authentication cookie. For an example of authenticating with Python, see Authenticate. 

import requests
url = "https://example.com:8443/rest/v1.3/inventory/deviceMgmt/devices/ID2"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

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 the 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>
Back to Top