Example of Accessing the API with cURL

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

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

Example of Accessing the API with Python

The following example shows how to get NF device groups by submitting a GET 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
url = "https://example.com:8443/rest/v1.3/inventory/nfMgmt/nfs/ID5/groups"
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 format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<deviceGroups>
    <deviceGroups>
        <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>
    </deviceGroups>
</deviceGroups>