1. REST API for Session Delivery Manager Release 9.0.1 and newer
  2. Tasks
  3. network function

Add an NF

post

/{versionId}/inventory/nfMgmt/nfs

Add a Network Function (NF) with devices to a group that you created. Once the NF is added successfully, the Oracle Communications Session Element Manager plug-in is able to communicate with the devices in the 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.
Back to Top

Examples

Examples of Accessing the API

See Authenticate for how to acquire a session cookie.

The following example shows how to add an NF using curl.

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

The following example shows how to add an NF using Python.

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/inventory/nfMgmt/nfs"
headers = { "Accept":"application/xml", "Content-Type: application/xml", "Cookie":cookie }
data = etree.tostring(etree.parse("request.json"))
resp = requests.post(url, headers=headers, data=data)

Example of the Request Body

The following example shows the contents of the request body in XML.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<nfConfig>
    <name>sd154</name>
    <parentGroupFullName>Home</parentGroupFullName>
   <nfCategory>
        <name>SP Edge &amp; Core</name>
        <product>Session Delivery</product>
        <vendor>Oracle</vendor>
    </nfCategory>
    <nfType>
        <name>Device</name>
    </nfType>
        <parameters>
            <name>primary.ip</name>
            <value>10.5.5.154</value>
        </parameters>
        <parameters>
            <name>snmp.community.name</name>
            <value>vm38</value>
        </parameters>
        <parameters>
            <name>snmp.port</name>
            <value>161</value>
        </parameters>
        <parameters>
            <name>username</name>
            <value>admin</value>
        </parameters>
        <parameters>
            <name>password</name>
            <value>abcd1234!</value>
        </parameters>
</nfConfig>

The following example shows the contents of the request body in JSON.

{
  "name": "sd177",
  "parentGroupFullName": "Home",
  "nfCategory": {
    "name": "SP Edge & Core",
    "product": "Session Delivery",
    "vendor": "Oracle"
  },
  "nfType": {
    "name": "Device"
  },
  "parameters": [{
    "name": "primary.ip",
    "value": "10.4.4.177"
  },{
    "name": "snmp.community.name",
    "value": "public"
  },{
    "name": "snmp.port",
    "value": "161"
  },{
    "name": "username",
    "value": "admin"
  },{
    "name": "password",
    "value": "abcd1234!"
  }]
}

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"?>
<nf>
    <children>
        <id>ID2</id>
        <ipAddress>10.5.5.154</ipAddress>
        <name>sd154</name>
        <parentGroupFullName>Home/sd154</parentGroupFullName>
        <parentGroupId>ID5</parentGroupId>
    </children>
    <groupType>DEVICE</groupType>
    <hidden>false</hidden>
    <id>ID5</id>
    <name>sd154</name>
    <nfCategory>
        <id>ID1</id>
        <name>SP Edge &amp; Core</name>
        <product>Session Delivery</product>
        <vendor>Oracle</vendor>
    </nfCategory>
    <nfType>
        <name>Device</name>
    </nfType>
    <parentGroupFullName>Home</parentGroupFullName>
    <parentGroupId>ID1</parentGroupId>
</nf>

The following example shows the contents of the response body in JSON.

{
  "children": [
    {
      "id": "ID2",
      "ipAddress": "10.4.4.177",
      "name": "sd177",
      "parentGroupFullName": "Home/sd177",
      "parentGroupId": "ID7"
    }
  ],
  "groupType": "DEVICE",
  "hidden": "false",
  "id": "ID7",
  "name": "sd177",
  "nfCategory": {
      "id": "ID5",
      "name": "SP Edge & Core",
      "product": "Session Delivery",
      "vendor": "Oracle"
  },
  "nfType": {
      "name": "Device"
  },
  "parentGroupFullName": "Home",
  "parentGroupId": "ID1"
}

Example of Adding a 2FA Device

This example demonstrates adding a 2FA device using this API.

An example XML request body:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<nfConfig>
    <name>HA</name>
    <parentGroupFullName>Home</parentGroupFullName>
    <nfCategory>
        <name>SP Edge &amp; Core</name>
        <product>Session Delivery</product>
        <vendor>Oracle</vendor>
    </nfCategory>
    <nfType>
        <name>Device</name>
    </nfType>
    <parameters>
        <name>primary.ip</name>
        <value>10.123.140.66</value>
    </parameters>
    <parameters>
        <name>snmp.community.name</name>
        <value>sdm103</value>
    </parameters>
    <parameters>
        <name>snmp.port</name>
        <value>161</value>
    </parameters>
    <parameters>
        <name>username</name>
        <value>admin</value>
    </parameters>
    <parameters>
        <name>password</name>
        <value>Cardinals@1982BB!</value>
    </parameters>
        <parameters>
        <name>2faStatus</name>
        <value>enabled</value>
    </parameters>
    <parameters>
        <name>keyId</name>
        <value>ID5</value>
    </parameters>
    <parameters>
        <name>passphrase</name>
        <value>abcd1234!</value>
    </parameters>
</nfConfig>

An example JSON request body:

{
  "name": "sd66",
  "parentGroupFullName": "Home",
  "nfCategory": {
    "name": "SP Edge & Core",
    "product": "Session Delivery",
    "vendor": "Oracle"
  },
  "nfType": {
    "name": "Device"
  },
  "parameters": [{
    "name": "primary.ip",
    "value": "10.123.140.66"
  },{
    "name": "snmp.community.name",
    "value": "sdm103"
  },{
    "name": "snmp.port",
    "value": "161"
  },{
    "name": "username",
    "value": "admin"
  },{
    "name": "password",
    "value": "Cardinals@1982BB!"
  },{
    "name": "2faStatus",
    "value": "enabled"
  },{
    "name": "keyId",
    "value": "ID8"
  },{
    "name": "passphrase",
    "value": "abcd1234!"
  }
  ]
}

An example XML response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<nf>
    <children>
        <id>ID10</id>
        <ipAddress>10.123.140.66</ipAddress>
        <name>sd66</name>
        <parentGroupFullName>Home/HA</parentGroupFullName>
        <parentGroupId>ID41</parentGroupId>
    </children>
    <groupType>DEVICE</groupType>
    <hidden>false</hidden>
    <id>ID41</id>
    <name>HA</name>
    <nfCategory>
        <id>ID1</id>
        <name>SP Edge &amp; Core</name>
        <product>Session Delivery</product>
        <vendor>Oracle</vendor>
    </nfCategory>
    <nfType>
        <name>Device</name>
    </nfType>
    <parentGroupFullName>Home</parentGroupFullName>
    <parentGroupId>ID1</parentGroupId>
</nf>

An example JSON response:

{
  "children": [
      {
        "id": "ID12",
        "ipAddress": "10.123.140.66",
        "name": "sd66",
        "parentGroupFullName": "Home/sd66",
        "parentGroupId": "ID45"
      }
  ],
  "groupType": "DEVICE",
  "hidden": "false",
  "id": "ID45",
  "name": "sd66",
  "nfCategory": {
      "id": "ID1",
      "name": "SP Edge & Core",
      "product": "Session Delivery",
      "vendor": "Oracle"
  },
  "nfType": {
      "name": "Device"
  },
  "parentGroupFullName": "Home",
  "parentGroupId": "ID1"
}
Back to Top