| State | Input | Behavior | Data | Notes |
---|
# | Data-Sync | Datastore parameter | Expected Resource-Path format | Accept-Header | Fields (filter) | Data Source | Included DataNodes (config) |
---|
1 | On | Not Specified | cpsPath | application/yang-data+json | N/A | Not supported | N/A | N/A |
| 2 | On | Not Specified | cpsPath | application/json | N/A | Not supported | N/A | N/A |
| 3 | Off | Not Specified | cpsPath | application/yang-data+json | N/A | Not supported | N/A | N/A |
| 4 | Off | Not Specified | cpsPath | N/A | N/A | Not supported | N/A | N/A | there are NO DataNode objects in CPS to output as JSON) | 5 | Off | Not Specified | other then cpsPath | N/A | N/A | Not supported | N/A | N/A | Not supported Since NCMP can only convert cpsPaths | 6 | On | Off | ncmp/passthrough-operational | NCMP does not parse | NCMP does not parse | depends on DMI-Plugin (supported in ONAP) | Resolve DMI plugin Forward request to plugin Output received response | DMI-Plugin | config + non-config | The DMI plugin may error if the RP or accept header are not supported. The DMI plugin may forward the request without processing too. | 7 | On | Off | ncmp/passthrough-running | NCMP does not parse | NCMP does not parse | depends on DMI-Plugin (supported in ONAP) | Resolve DMI plugin Forward request to plugin Output received response | DMI-Plugin | config-only |
| 8 | On | ncmp/operational | cpsPath | application/yang-data+json | Not supported in Istanbul releases | Read from cache output: application/yang-data+json | CPS-Core | config + non-config | NCMP/CPS-Core needs to remove DataNode wrapping
| 9 | On | ncmp/operational | cpsPath | application/json | Not supported in Istanbul releases | Read from cache output: application/json | CPS-Core | config + non-config |
| 10 | Off | ncmp/operational | cpsPath | application/yang-data+json | to be determined in spike, see issue #28
| Resolve DMI plugin Convert cpsPath to RESTConfPath Forward request to plugin | Read from DMI plugin Output application/yang-data+json | DMI-Plugin | config + non-config |
| 11 | On | Off | ncmp/running | cpsPath | application/yang-data+json | to be determined in spike, see issue #28 | Resolve DMI plugin Convert cpsPath to RESTConfPath Forward request to plugin | Read from DMI plugin Output application/yang-data+json | DMI-Plugin | config-only |
|
Read & Write API Example Expand |
---|
Scenario | Sample |
---|
Read all NRCellDU MOs with attributes userLabel and id under the |
Code Block | Scenario : Read all NRCellDU MOs with attributes userLabel and id under the _3gpp-nr-nrm-gnbdufunction:GNBDUFunction |
MO
Method : GET
URI MO
{ncmp-root}/ncmp/v1/ch/<cm-handle>/{data-resource-identifier}?fields={fields-expression} | 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 : Header : Accept : application/yang-data+json
|
HTTP/1.1 200 OK
Date: Thu, 26 Jan 2017 20:56:30 GMT
Server: example-server
Content-Type: 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"
|
{
{
{
{
}
}
]
}
]
| Create a data resource for the given cm handle {ncmp-root}/ncmp/v1/ch/<cm-handle>/data/{parent-data-resource-identifier} | Method : POST URI : {ncmp-root}/ncmp/v1/ch/sample-cm-handle/data/sample-parent-data-resource-identifier Header : Content-Type: application/yang-data+json Body : { "sample-parent-data-resource-identifier:parent-data-resource-identifier" :[ { "id" : 4 "cld" : 5 "attributes" : { "userLabel" : "SectorCar-4", "txDirection" : "DL_AND_UL", "configuredMaxTxPower" : "90", "arfcnDL" : "9999999", "arfcnUL" : "888888", "bSChannelBwDL" : "90", "bSChannelBwUL" : "80" } }] } |
|
Works Items for above. # | Description | Component | Enables |
---|
1 | Forward request from NCMP to CPS-Core | NCMP | 8,9 | 2 | Forward request from NCMP to DMI-Plugin | NCMP | 6,7 | 3 | Convert json (dataNode) to yang-data+json | CPS-Core/NCMP | 8 | 4 | Convert cpsPath to RESTConf Path | NCMP | 10,11 | 5 | Enhance &fields parameter where needed | NCMP | 10,11+fields option | 6 | NOT Supported | N/A | 1,2,3,4,5 |
- 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
| State | Input | Behavior | Notes |
---|
# | Data-Sync | Operation | Datastore parameter | Expected Resource-Path format | Content-Type |
---|
1 | On | Off | Create | ncmp/passthrough-running | NCMP does not parse | NCMP does not parse (needs to be valid JSON) | Resolve DMI plugin Forward request to plugin Output received response (success or failure) | The DMI plugin may error if the RP or content type are not supported. The DMI plugin may forward the request without processing too. | 2 | On | Off | Update | ncmp/passthrough-running | NCMP does not parse | NCMP does not parse (needs to be valid JSON) | Resolve DMI plugin Forward request to plugin Output received response (success or failure) | The DMI plugin may error if the RP or content type are not supported. The DMI plugin may forward the request without processing too. | 3 | On | Off | Delete | ncmp/passthrough-running | NCMP does not parse | N/A | Resolve DMI plugin Forward request to plugin Output received response (success or failure) | The DMI plugin may error if the RP or content type are not supported. The DMI plugin may forward the request without processing too. | 4 | On | Off | Patch | ncmp/passthrough-running | NCMP does not parse | NCMP does not parse (needs to be valid JSON) | Resolve DMI plugin Forward request to plugin Output received response (success or failure) | The DMI plugin may error if the RP or content type are not supported. The DMI plugin may forward the request without processing too. | 5 | On | Off | Create | ncmp/running | cpsPath | application/yang-data+json | Resolve DMI plugin Convert cpsPath to RESTConfPath Forward request to plugin Output received response (success or failure) |
| 6 | On | Off | Update | ncmp/running | cpsPath | application/yang-data+json | Resolve DMI plugin Convert cpsPath to RESTConfPath Forward request to plugin Output received response (success or failure) |
| 7 | On | Off | Delete | ncmp/running | cpsPath | N/A | Resolve DMI plugin Convert cpsPath to RESTConfPath Forward request to plugin Output received response (success or failure) |
| 8 | On | Off | Patch | ncmp/running | cpsPath | application/yang-data+json (*plain patch) | Resolve DMI plugin Convert cpsPath to RESTConfPath Forward request to plugin Output received response (success or failure) |
| 9 | On | Off | Patch | ncmp/running | cpsPath | application/yang-patch+json | Resolve DMI plugin Convert cpsPath to RESTConfPath Forward request to plugin Output received response (success or failure) |
|
|