Get Information on an NF Group
get
/{versionId}/inventory/nfMgmt/nfs/{nfId}/groups/{groupId}
Display a specific device group from a Network Function (NF).
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.
Examples
Examples of Accessing the API
See Authenticate for how to acquire a session cookie.
The following example shows how to get information on an NF group using curl.
curl -X GET \
-b sessionid.txt \
--header "Accept: application/xml" \
"https://example.com:8443/rest/v1.3/inventory/nfMgmt/nfs/ID5/groups/ID5"The following example shows how to get information on an NF group using Python.
import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/inventory/nfMgmt/nfs/ID5/groups/ID5"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)Example of the Response Body
The following example shows the contents of the response body in XML.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<deviceGroup>
<fullName>Home/sd154</fullName>
<id>ID5</id>
<isHidden>false</isHidden>
<name>sd154</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>Home</parentGroupFullName>
<parentGroupId>ID1</parentGroupId>
<type>DEVICE</type>
</deviceGroup>The following example shows the contents of the response body in JSON.
{
"fullName": "testGrp_REST_updated/ESBC153",
"id": "ID11",
"isHidden": "false",
"name": "ESBC153",
"parameters": [{
"description": "User name to use for device communication",
"name": "username",
"readOnly": false,
"value": "admin"
},{
"description": "Password of the user",
"name": "password",
"readOnly": false,
"value": "xxxx"
},{
"description": "The SNMP agent mode configured for the device",
"name": "snmp.mode",
"readOnly": true,
"value": "v1v2",
"validLists": {
"valueList": [
"v1v2",
"v3"
]
}
},{
"description": "SNMP Community to use for device communication",
"name": "snmp.community.name",
"readOnly": false,
"value": "soauddy"
},{
"description": "SNMP Port to use for device communication",
"maxValue": 9223372036854775807,
"minValue": 0,
"name": "snmp.port",
"readOnly": false,
"value": "161"
},{
"description": "Web protocol to use for device launch",
"name": "web.protocol",
"readOnly": false,
"value": "HTTP",
"validLists": {
"valueList": [
"HTTP",
"HTTPS"
]
}
},{
"description": "Web port to use for device launch",
"maxValue": 9223372036854775807,
"minValue": -9223372036854775808,
"name": "web.port",
"readOnly": false,
"value": "80"
}],
"parentGroupFullName": "testGrp_REST_updated",
"parentGroupId": "ID6",
"type": "DEVICE"
}