REST API for Session Delivery Manager Release 9.0.1 and newer

Get Information on SDM Servers

get

/{versionId}/admin/serverInfo

Retrieve server specific status and health information for all servers within a SDM cluster.

Request

Path Parameters

versionId(required):

Response

200 Response

400 Response

Invalid ID supplied

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.

curl
Python

The following example shows how to get information on SDM servers using curl.

curl -X GET \
    -b sessionid.txt \
    --header "Accept: application/xml" \
    "https://example.com:8443/rest/v1.3/admin/serverInfo"

The following example shows how to get information on SDM servers using Python.

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/admin/serverInfo"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)

Example of the Response Body

XML Response
JSON Response

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<serverInfo>
 <clusterMembers>
   <downTime>NA</downTime>
   <failureHeartBeatCount>0</failureHeartBeatCount>
   <heartBeatCount>11952</heartBeatCount>
   <inactivityHeartBeatCount>0</inactivityHeartBeatCount>
   <ipAddress>10.5.5.36</ipAddress>
   <lastHeartBeatTime>2022-08-03 00:46:02</lastHeartBeatTime>
   <maxFailureHeartBeatCount>1</maxFailureHeartBeatCount>
   <missedHeartBeatCount>0</missedHeartBeatCount>
   <name>10.5.5.36</name>
   <resetCount>0</resetCount>
   <status>ACTIVE</status>
   <upTime>00:16:40</upTime>
 </clusterMembers>
 <clusterMembers>
   <downTime>NA</downTime>
   <failureHeartBeatCount>0</failureHeartBeatCount>
   <heartBeatCount>11953</heartBeatCount>
   <inactivityHeartBeatCount>0</inactivityHeartBeatCount>
   <ipAddress>10.5.5.37</ipAddress>
   <lastHeartBeatTime>2022-08-03 00:46:03</lastHeartBeatTime>
   <maxFailureHeartBeatCount>1</maxFailureHeartBeatCount>
   <missedHeartBeatCount>0</missedHeartBeatCount>
   <name>10.5.5.37</name>
   <resetCount>0</resetCount>
   <status>ACTIVE</status>
   <upTime>00:16:36</upTime>
 </clusterMembers>
 <globalId>OCSDM</globalId>
 <masterNodeIp>10.5.5.36</masterNodeIp>
 <productName>OCSDM</productName>
 <version>NNC825_01B3</version>
</serverInfo>

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

{
  "clusterMembers": [
    {
      "downTime": "NA",
      "failureHeartBeatCount": 0,
      "heartBeatCount": 39610,
      "inactivityHeartBeatCount": 0,
      "ipAddress": "10.4.4.102",
      "lastHeartBeatTime": "2022-10-02 09:04:58",
      "maxFailureHeartBeatCount": 1,
      "missedHeartBeatCount": 0,
      "name": "10.4.4.102",
      "resetCount": 0,
      "status": "ACTIVE",
      "upTime": "02:07:00"
    },
    {
      "downTime": "NA",
      "failureHeartBeatCount": 0,
      "heartBeatCount": 39610,
      "inactivityHeartBeatCount": 0,
      "ipAddress": "10.4.4.101",
      "lastHeartBeatTime": "2022-10-02 09:05:02",
      "maxFailureHeartBeatCount": 1,
      "missedHeartBeatCount": 0,
      "name": "10.4.4.101",
      "resetCount": 0,
     "status": "ACTIVE",
      "upTime": "02:07:03"
    }
  ],
  "globalId": "OCSDM",
  "masterNodeIp": "10.4.4.101",
  "productName": "OCSDM",
  "version": "NNC90_1B10"
}