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

Update NF Information

put

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

Use this (PUT) method to update a device group in a Network Function (NF), such as the user name and password used with the device, SNMP parameters, and so on.

Request

Supported Media Types
Path Parameters
Body ()
Root 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
Back to Top

Response

Supported Media Types

200 Response

successful operation
Body ()
Root 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 update a device group for an NF by submitting a PUT 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 -b sessionid.txt -X PUT -d@nf/updateGroupInNf.xml -H"Content-Type: application/xml" -H"Accept: application/xml" http://localhost:8080/rest/v1.1/inventory/nfMgmt/nfs/ID7/groups/ID13

Example of Request Body

The following shows an example of the user request body input in XML format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<deviceGroup>
  <fullName>HG1/HG2/NF1/DependencyGroup/myCluster/grg/sd120</fullName>
  <id>ID13</id>
  <name>sd120</name>
  <parameters>
    <parameter>
      <name>snmp.community.name</name>
      <value>public</value>
    </parameter>
  </parameters>
<parentGroupFullName>HG1/HG2/NF1/DependencyGroup/myCluster/grg</parentGroupFullName>
  <parentGroupId>ID12</parentGroupId>
  <type>DEVICE</type>
</deviceGroup>

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Wed, 06 Sep 2017 21:26:37 GMT
Server: Apache
X-Frame-Options: SAMEORIGIN
Content-Length: 1538
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"?>
<deviceGroup>
  <fullName>HG1/HG2/NF1/DependencyGroup/myCluster/grg/sd120</fullName>
  <id>ID13</id>
  <isHidden>false</isHidden>
  <name>sd120</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/HG2/NF1/DependencyGroup/myCluster/grg</parentGroupFullName>
  <parentGroupId>ID12</parentGroupId>
  <type>DEVICE</type>
</deviceGroup>
Back to Top