Page History

{dmi-root}/dmi/v1/ch/<cmhandle>/data/ds/ncmp-datastore:running/{parent-data-resource-identifier}

{
<new-yang-data-resource>
}

Content-Type: application/json

"data" payload : yang-data+json

{dmi-root}/dmi/v1/ch/<cm-handle>/data/ds/ncmp-datastore:running/{resource-identifier}

{
<yang-data-for-merging>
}

Content-Type: application/json

"data" payload : yang-data+json

{dmi-root}/dmi/v1/ch/<cm-handle>/data/ds/ncmp-datastore:running/{resource-identifier}

Content-Type: application/json

"data" payload : yang-patch+json

{dmi-root}/dmi/v1/ch/<cm-handle>/data/ds/ncmp-datastore:operational/{resource-identifier}/{action}

input: {
         "param1Name" :"param1Value”,
          "param2Name" : "param2Value”

}

Note : If the "action" statement has no "input" section, the request message MUST NOT include a message-body

{dmi-root}/dmi/v1/operations/ch/<cm-handle>/ds/ncmp-datastore:operational/ {module-name}:{action}

{ input: {
            "param1Name" : "param1Value”,
             "param2Name" : "param2Value”
} }

Note: If there is no "input" section, the request MUST NOT include a message-body

{dmiroot}/dmi/v1/ch/<cm-handle>/data/ds/ncmp-datastore:operational/{resource-identifier}?fields={fields-expression}

{dmi-root}/dmi/v1/ch/<cm-handle>/data/ds/ncmp-datastore:operational/{resource-identifier}?fields={fields-expression}

{dmi-root}/dmi/v1/ch/{cm-handle}/data/ds/ncmp-datastore:operational/{resource-identifier}?depth={level}

{dmi-root}/dmi/v1/ch/<cm-handle>/data/ds/ncmp-datastore:running/{resource-identifier}

{data : {

            .... the complete tree config to be replaced

      }}

POST

json attributes:

• "dmi-plugin" resolvable servicename
• "createdcmhandles" used for initial cm handle registrations or subsequent
  cmhandle creations
• "updatedcmhandles"
  Used for updates to cmhandles. Same structure as for create handles
  
• "removedcmhandles"  array of cmhandles that have been deleted
  from the network (no additional properties

{ncmp-root}/ncmp-dmi/v1/ch/

Scenario : DMI notifies NCMP of new cmhandles
Method : POST
URI : {ncmp-root}/ncmp-dmi/v1/ch/
Header :
    Content-Type: application/json

Request Body : {
      "dmi-plugin" : "onap.dmi.plugin", 
      "createdcmhandles" : [ {   "cmhandle" : "rf4er5454",
                                 "additionalProperties" :
                                   { "subsystemId" : "system-001" }
                             }, {..} ],
      "updatedcmhandles" : [ .. ],
      "removedcmhandles" : [ "node-1", "node-2" , ... ]
  }

Scenario : Get all cmhandles from NCMP for a given dmi-plugin. May be used
    for conciliation
Method : GET
URI : {ncmp-root}/ncmp-dmi/v1/dmi-plugins/{dmi-plugin}/ch
Header :
    Content-Type: application/json

Success Response :
    HTTP/1.1 200 Ok
Date: Thu, 26 Jan 2021 20:56:30 GMT
Server: example-server
  { "cmhandles" : [ {
          "cmhandle" : "node-1",
          "additionalProperties" : [ "subSystem" : "system-001" ]
       } ]
   }

Get module set for a cmhandle

Header :
Content-Type: application/json

Body :
  { "operation" : "read",
    "cmhandle"  :  "cmhandle-001",
    "additionalProperties"  : ["subSystem" : "subsystem-001"]}

Response:
  {
    "ietf-yang-library:yang-library" : [ 
    { "module-set" : [ {
                         "name" : "sample-module",
                         "module" : [
                         {
                           "name" : "_3gpp-nr-nrm-nrsectorcarrier",
                           "revision" : "2020-12-09",
                           "namespace" : "urn:3gpp:sa5:_3gpp-nr-nrm-nrnetwork-nrsectorcarrier",
                          } 
            ...
    }

{dmi-root}/dmi/v1/ch/<cm-handle>model

DMI PLugin will make multiple requests to xNF and combine the result in a list

Body :
{ "operation" : "read",
  "additionalProperties" : ["subSystem" : "subsystem-001"]
  "modules" :  [ { "namespace": "urn:3gpp:sa5:_3gpp-nr-nrm-nrnetwork-nrsectorcarrier", "name": "_3gpp-nr-nrm-nrsectorcarrier", "revision": "2020-12-09" } , { ... } ] }


Response: a list yang module references and source for each

{ [
{
"name" : "_3gpp-nr-nrm-nrsectorcarrier",
"revision" : "2020-12-09", 
"namespace": "urn:3gpp:sa5:_3gpp-nr-nrm-nrnetwork-nrsectorcarrier", "name": "_3gpp-nr-nrm-nrsectorcarrier", "revision": "2020-12-09" },
"yang-source": "module pnf-sw-upgrade {\n namespace \"http://onap.org/pnf-sw-upgrade\";\n prefix upgrade;\n\n import ietf-yang-types {\n prefix yang;\n }
\n\n revision 2019-12-03 {\n description\n \"initial version\";\n }\n\n container software-upgrade {\n list upgrade-package {\n key \"id\";\n leaf id {\n type string;\n }
\n\n leaf current-status {\n type enumeration {\n enum \"CREATED\";\n enum \"INITIALIZED\";\n enum \"DOWNLOAD_IN_PROGRESS\";\n enum \"DOWNLOAD_COMPLETED\";\n
 enum \"ACTIVATION_IN_PROGRESS\";\n enum \"ACTIVATION_COMPLETED\";\n }\n description\n \"List of possible states of the upgrade\";\n }\n\n leaf state-change-time 
{\n type yang:date-and-time;\n mandatory false;\n description\n \"Date and time of the last state change.\";\n }\n\n leaf action {\n type enumeration 
{\n enum \"NONE\";\n enum \"PRE_CHECK\";\n enum \"DOWNLOAD_NE_SW\";\n enum \"ACTIVATE_NE_SW\";\n enum \"CANCEL\";\n }\n mandatory false;\n description\n 
\"List of possible actions for the upgrade\";\n }\n\n leaf software-version {\n type string;\n description\n \"Possible name or release version of the UP\";\n }
\n\n leaf uri {\n type string;\n description\n \"A URI that points to the directory where the UP can be found.\";\n }\n\n leaf user {\n type string;\n description\n
 \"Indicates the user.\";\n }\n\n leaf password {\n type string;\n description\n \"Indicates the password.\";\n }\n\n leaf user-label {\n type string;\n description\n
 \"Free-text description of the UP.\";\n }\n\n leaf node-health {\n type string;\n description\n \"Reflect Node Health Status\";\n }\n }\n }\n}"
}, {...} ]
}