...

Datastore, Paths and Format Combinations for Write Operations

• Write operations are only supported on the ncmp-datastores:running and ncmp-datastores:passthrough-running datastores
• The Data Target for all write operation is DMI-Plugin
• Write operations are only supported for config=true data
• Fields and similar parameters are not supported for write operations

REST API

Scenario : Read all NRCellDU MOs with attributes userLabel and id under the _3gpp-nr-nrm-gnbdufunction:GNBDUFunction MO

Method  : GET

URI         :{ncmp-root}/ncmp/v1/ch/3445fff/data/ManagedElement[@id=Kista-001]
/GNBCUCPFunction[@id=1]?fields=_3gpp-nr-nrm-nrcelldu:NRCellDU/attributes
(administrativeState;operationalState)

Header :
      Accept : application/yang-data+json

Response :

      HTTP/1.1 200 OK
      Date: Thu, 26 Jan 2017 20:56:30 GMT
      Server: example-server
      Content-Type: application/yang-data+json


{
"_3gpp-nr-nrm-gnbdufunction:GNBDUFunction" : [
{
"_3gpp-nr-nrm-nrcelldu:NRCellDU" : [
{
"top3gpp:id" : "NR-Cell-001"
"attributes" : {
"administrativeState " : "LOCKED",
"operationalState" : "disabled"
}
},
{
"top3gpp:id" : "NR-Cell-002"
"attributes" : {
"administrativeState " : "LOCKED",
"operationalState" : "disabled"
}
},
{
"top3gpp:id" : "NR-Cell-003"
"attributes" : {
"administrativeState " : "LOCKED",
"operationalState" : "disabled"
}
},
{
"top3gpp:id" : "NR-Cell-004"
"attributes" : {
"administrativeState " : "LOCKED",
"operationalState" : "disabled"
}
},
{
"top3gpp:id" : "NR-Cell-005"
"attributes" : {
"administrativeState " : "LOCKED",
"operationalState" : "disabled"
}
}
]
}
]
}

Sync & ModelAPI

{ncmp-root}/ncmp/v1/ch/<cm-handle>/data/{data-resource-identifier}

{

<updated-yang-data-resource>

}

Content: application/yang-patch+json

If using yang-patch content then ds/ncmp-datastore-passthrough-running must be used by rad apps until full
support is available from NCMP/CPS

Scenario : Update _3gpp-common-managed-element:ManagedElement=Kista-001/_3gpp-nr-nrm-gnbdufunction:GNBDUFunction=1 with multiple operations on the tree
Method : PATCH
URI : {ncmp-root}/ncmp/v1/ch/34l5k32/data/ds/ncmp-datastore-passthrough-running/ManagedElement[@id=Kista-001]/GNBDUFunction[@id=1]

Header :
  Content-Type: application/yang-patch+json
Body :
  {
    "ietf-restconf:yang-patch" : {
      "patch-id" : "change-cell-and-carriers",
      "edit" : [
      {
        "edit-id" : 1,
        "operation" : "create",
        "target" : "/_3gpp-nr-nrm-nrcelldu:NRCellDU=1",
        "value" : {
          "_3gpp-nr-nrm-nrcelldu:NRCellDU" : [{
            "id" : 1,
            "arrtibutes" : {
                      "cId" : 511,
                      "userLabel" : "some-cell-label",
                                               ...
            }
          }
          ]
        }
      },
      {
        "edit-id" : 2, "operation" : "create",
        "target" : "/_3gpp-nr-nrm-nrcelldu:NRCellDU=2",
        "value" : {
          "_3gpp-nr-nrm-nrcelldu:NRCellDU" : [ {
            "id" : 2,
            "arrtibutes" : {
            "cId" : 512,
            "userLabel" : "some-other-cell-label",
                                               ...
          }
          }
          ]
        }
      },
      {
        "edit-id" : 3,
        "operation" : "merge",
        "target" : "/_3gpp-nr-nrm-nrcelldu:NRCellDU=3",
        "value" : {
          "_3gpp-nr-nrm-nrcelldu:NRCellDU" : [{
            "cId" : 412,
            "userLabel" : "yet-another-cell-label",
                                               ...
          }]
        }
      },
      {
        "edit-id" : 4,
        "operation" : "merge",
        "target" : "_3gpp-nr-nrm-nrcelldu:NRCellDU=4",
        "value" : {
          "_3gpp-nr-nrm-nrcelldu:NRCellDU" : [{
            "cId" : 412,
            "userLabel" : "yet-another-cell-label",
                                               ...
          }]
        }
      }
      ]
    }
  }
Response :
  HTTP/1.1 200 OK
  Date: Thu, 26 Jan 2017 20:56:30 GMT
  Server: example-server
  Last-Modified: Thu, 26 Jan 2017 20:56:30 GMT
  Content-Type: application/yang-patch+json
  {
    "ietf-yang-patch:yang-patch-status" : {
      "patch-id" : "change-cell-and-carriers",
      "ok" : [null]
    }
  }

Scenario : Replace _3gpp-nr-nrm-nrsectorcarrier:NRSectorCarrier=4 txDirection
to "DL_AND_UL" under _3gpp-common-managed-element:ManagedElement=Kista001/_3gpp-nr-nrm-gnbdufunction:GNBDUFunction=1 - removes all config params not
specified including sub-tree if one exists
Method : PUT
URI : {ncmp-root}/ncmp/v1/ch/34l5k32/data/ManagedElement[@id=Kista-001]
/GNBDUFunction[@id=1]/NRSectorCarrier[@id=4]
Header :
Content-Type: application/yang-data+json

Body :
  {
    _3gpp-nr-nrm-nrsectorcarrier:NRSectorCarrier" : [{
      "id" : 4
        "attributes" : {
          "txDirection" : "DL_AND_UL"
        }
    }]
  }

{
  "_3gpp-common-managed-element:ManagedElement" : [
  {
    "id"="Kista-001",
    "_3gpp-nr-nrm-gnbcucpfunction:GNBCUCPFunction" : [
    {
      "id"="1",
      "attributes" : {
                       "pLMNId : [ { "mcc" : "01", "mnc" : "123" }],
      "gNBId" : 123,
      "gNBIdLength" : 3
    }
      }
    ]
  }
  ]
}

Response :
  {
    "responseId" : 323234
  }
Event Response:
  {
    "requestId" : "dd3434",
    "data" : {
      "_3gpp-common-managed-element:ManagedElement" : [
      {
        "id"="Kista-001",
        "_3gpp-nr-nrm-gnbcucpfunction:GNBCUCPFunction" : [
        {
          "id"="1",
          "attributes" : {
                           "pLMNId" : [ { "mcc" : "01", "mnc" : "123" }],
          "gNBId" : 123,
          "gNBIdLength" : 3
        }
          }
        ]
      }
      ]
    }
  }

Header :
  Content-Type: application/yang-data+json
Body :
  {
    "_3gpp-nr-nrm-nrsectorcarrier:NRSectorCarrier" :[ {
      "id" : 4
        "cld" : 5
        "attributes" : {
          "userLabel" : "nrSectorCar-4",
          "txDirection" : "DL_AND_UL",
          "configuredMaxTxPower" : "90",
          "arfcnDL" : "9999999",
          "arfcnUL" : "888888",
          "bSChannelBwDL" : "90",
          "bSChannelBwUL" : "80"
          
        }
    }]
  }

{
  _3gpp-nr-nrm-nrsectorcarrier:NRSectorCarrier" : [{
    "id" : 4
      "attributes" : {
        "txDirection" : "DL_AND_UL"
      }
  }]
}

{
  "ietf-yang-library:modules-set" : [ # from RFC 8525
  {
    "name" : "5479120c17a619545ea6aff7aa19838b036ebbd7",
    "module" : [
    {
      "name" : "_3gpp-nr-nrm-nrsectorcarrier",
      "revision" : "2020-12-09",
      "namespace" : "urn:3gpp:sa5:_3gpp-nr-nrmnrnetwork-nrsectorcarrier",
      "location" : "http://emsadapter.com/modules/_3gppnr-nrm-nrsectorcarrier",
      "submodule" : [
      {
        "name" : "xxxx-module",
        "revision" : "2020-12-17",
        "namespace" : "urn:3gpp:sa5:xxx-module",
        "submodule" : [
        {
          ...
        }
        ]
      }
      ]
    },
    {
      "name" : "ietf-yang-library",
      "revision" : "2016-06-21",
      "namespace" : "urn:ietf:params:xml:ns:yang:ietfyang-library"
    }
    ]
  }