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

Update NF Information

put

/{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

Path 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 update NF information by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X PUT \
    -b sessionid.txt \
    --header "Accept: application/xml" \
    --header "Content-Type: application/xml" \
    "https://example.com:8443/rest/v1.3/inventory/nfMgmt/nfs/ID8/groups/ID8"

The following shows an example of the contents of the request.json file sent as the request body. 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<deviceGroup>
  <fullName>testGrp_REST/10.0.0.154</fullName>
  <id>ID24</id>
  <name>SD154</name>
  <parameters>
      <name>snmp.community.name</name>
      <value>jvbharad</value>
  </parameters>
<parentGroupFullName>DevGrp_REST_updated</parentGroupFullName>
  <parentGroupId>ID7</parentGroupId>
  <type>DEVICE</type>
</deviceGroup>

Example of Accessing the API with Python

The following example shows how to update NF information by submitting a PUT 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
from lxml import etree
url = "https://example.com:8443/rest/v1.3/inventory/nfMgmt/nfs/ID8/groups/ID8"
headers = { "Accept":"application/xml", "Content-Type":"application/xml", "Cookie":cookie }
data = etree.tostring(etree.parse("request.json"))
resp = requests.put(url, headers=headers, data=data)

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"?>
<deviceGroup>
    <fullName>DevGrp_REST_updated/sd157</fullName>
    <id>ID8</id>
    <isHidden>false</isHidden>
    <name>sd157</name>
    <parameters>
        <description>User name to use for device communication</description>
        <name>username</name>
        <readOnly>false</readOnly>
        <value>admin</value>
    </parameters>
    <parameters>
        <description>Password of the user</description>
        <name>password</name>
        <readOnly>false</readOnly>
        <value>xxxx</value>
    </parameters>
    <parameters>
        <description>The SNMP agent mode configured for the device</description>
        <name>snmp.mode</name>
        <readOnly>true</readOnly>
        <value>v1v2</value>
        <validLists>
            <valueList>v1v2</valueList>
            <valueList>v3</valueList>
        </validLists>
    </parameters>
    <parameters>
        <description>SNMP Community to use for device communication</description>
        <name>snmp.community.name</name>
        <readOnly>false</readOnly>
        <value>jvbharad</value>
    </parameters>
    <parameters>
        <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>
    </parameters>
    <parentGroupFullName>DevGrp_REST_updated</parentGroupFullName>
    <parentGroupId>ID7</parentGroupId>
    <type>DEVICE</type>
</deviceGroup>
Back to Top