1. REST API for Session Delivery Manager Release 8.1
  2. Tasks
  3. network function

Get NF Device Groups

get

/rest/{versionId}/inventory/nfMgmt/nfs/{nfId}/groups

Use this (GET) method to display existing device groups in a Network Function (NF).

Request

Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

successful operation
Body ()
Root Schema : deviceGroups
Type: object
Show Source
Nested Schema : deviceGroup
Type: array
Show Source
Nested Schema : deviceGroup
Type: object
Show Source
Nested Schema : parameter
Type: array
Show Source
Nested Schema : parameter
Type: object
Show Source
Nested Schema : validValue
Type: array
Show Source
Nested Schema : validLists
Type: array
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

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

<curl>

Example of cURL Data

The following shows an example of cURL data sent with the request.

curl -v -b sessionid.txt -X GET -H"Content-Type: application/xml" -H"Accept: application/xml" http://localhost:8080/rest/v1.1/inventory/nfMgmt/nfs/ID16/groups

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Wed, 06 Sep 2017 20:38:27 GMT
Server: Apache
X-Frame-Options: SAMEORIGIN
Content-Length: 1486
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"?>
<deviceGroups>
  <deviceGroup>
    <fullName>HG1/NF2</fullName>
    <id>ID16</id>
    <isHidden>false</isHidden>
    <name>NF2</name>
    <parameters>
      <parameter>
        <description>User name to use for device communication</description>
        <name>username</name>
        <readOnly>false</readOnly>
        <value>admin</value>
        <valueType>String</valueType>
      </parameter>
      <parameter>
        <description>Password of the user</description>
        <name>password</name>
        <readOnly>false</readOnly>
        <value>xxxx</value>
        <valueType>String</valueType>
      </parameter>
      <parameter>
        <description>The SNMP agent mode configured for the device</description>
        <name>snmp.mode</name>
        <readOnly>true</readOnly>
        <validValues>
          <validValue>v1v2</validValue>
          <validValue>v3</validValue>
        </validValues>
        <value>v1v2</value>
        <validLists>
          <valueList>v1v2</valueList>
          <valueList>v3</valueList>
        </validLists>
        <valueType>SingleSelection</valueType>
      </parameter>
      <parameter>
        <description>SNMP Community to use for device communication</description>
        <name>snmp.community.name</name>
        <readOnly>false</readOnly>
        <value>public</value>
        <valueType>String</valueType>
      </parameter>
      <parameter>
        <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>
      </parameter>
    </parameters>
    <parentGroupFullName>HG1</parentGroupFullName>
    <parentGroupId>ID3</parentGroupId>
    <type>DEVICE</type>
  </deviceGroup>
</deviceGroups>
Back to Top