1. REST API for Session Delivery Manager Release 8.2.5p1
  2. Tasks
  3. device configuration

Get a List of Devices Associated with Element Manager

get

/{versionId}/configuration/devices

Use this (GET) method to retrieve a list of device names that are currently being managed by Session Element Manager. A device can be added to Device Manager (refer to Add an NF), but does not show up in the managed list until it is assigned to Session Element Manager (refer to Associate a Device with a Configuration Service).

Request

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

Examples

Example of Accessing the API with cURL

The following example shows how to get a list of devices associated with element manager 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/configuration/devices"

Example of Accessing the API with Python

The following example shows how to get a list of devices associated with element manager 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/configuration/devices"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)

Example of Response Bodies

The following shows examples of response bodies in XML and JSON.

The following example shows the contents of the response body in XML format.

Note:

Response payload example observed in SDM 8.2.5 and onwards. 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<devices>
    <devices>
        <bootstrapState>Activated</bootstrapState>
        <connectivityStatus>true</connectivityStatus>
        <id>ID2</id>
        <ip>10.0.0.154</ip>
        <key>sd154_10.0.0.154</key>
        <manageable>true</manageable>
        <name>sd154</name>
        <nfId>ID5</nfId>
        <nfName>sd154</nfName>
        <parentGroupId>ID5</parentGroupId>
        <platformInfo>
            <platform>6100</platform>
            <serialNumber>--</serialNumber>
        </platformInfo>
        <softwareInfo>
            <configVersion>617</configVersion>
            <version>SCZ910p2</version>
        </softwareInfo>
        <lastOperation>SaveActivate</lastOperation>
        <loadedConfigVersion>616</loadedConfigVersion>
        <pendingChanges>0</pendingChanges>
        <status>success</status>
        <statusChangeTime>Wed Aug 03 02:48:59 EDT 2022</statusChangeTime>
    </devices>
</devices>

The following example shows the contents of the response body in JSON format.

Note:

Response payload example observed in SDM 8.2.5 and onwards. 
{
  "devices": [
    {
      "bootstrapState": "Activated",
      "connectivityStatus": true,
      "id": "ID3",
      "ip": "10.0.0.181",
      "key": "esbc181_10.0.0.181",
      "manageable": true,
      "name": "esbc181",
      "nfId": "ID7",
      "nfName": "esbc181",
      "parentGroupId": "ID7",
      "platformInfo": {
          "platform": "NNOSVM",
          "serialNumber": "--"
      },
      "softwareInfo": {
          "configVersion": "92",
          "version": "SCZ910"
      },
      "loadedConfigVersion": "78",
      "pendingChanges": "0"
    }
  ]
}
Back to Top