# | Req/usecase | REST Method | URI | Request/Response Example |
---|
1 | Get all cmhandles that support a given
moduleDMI notifies NCMP of new , deleted or changed cmhandles DMI Plugin NCMP. Including initial registration | POST | {ncmpRoot}/ncmp/v1/ch/ | searches | | : Get the all cmhandles that support a given module
URI : : DMI notifies NCMP of new cmhandles Method : POST URI : {ncmpRoot}/ncmp/v1/ch/ | searches{
| Request Body
| "modules": Content-Type: application/json
Code Block |
---|
language | xml |
---|
title | Request Body |
---|
| Request Body : {
" |
| module-name | some-module"
}
}Header :
Accept: application/json
Response:
{
cmHandles : [ "ew534fe", "23ft4", "434fsdf", ... ]
}
2 | Request (trigger) Data Sync | POST | {ncmpRoot}/ncmp/v1/ch/<cmHandle>/syncData | Scenario : Client requests to sync a node URI : {ncmpRoot}/ncmp/v1/ch/node123/syncData Response : HTTP-Status code (only, no body) |
onap.dmi.plugin",
"createdCmHandles" : [ { "cmHandle" : "rf4er5454",
"cmHandleProperties" :
{ "subSystemId" : "system-001" }
}, {..} ],
"updatedCmHandles" : [ .. ],
"removedCmHandles" : [ "node-1", "node-2" , ... ]
} |
json attributes: - "dmiPlugin" 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
|
2 | Get all cm handles that support a given module | POST | {ncmpRoot}/ncmp/v1/ch/searches | Scenario : Get the all cmhandles that support a given module URI : {ncmpRoot}/ncmp/v1/ch/searches Request Body {
"modules": {
"module-name": "some-module"
}
}
Header : Accept: application/json Response: { cmHandles : [ "ew534fe", "23ft4", "434fsdf", ... ] } |
3 | Request (trigger) Data Sync | POST | {ncmpRoot}/ncmp/v1/ch/<cmHandle>/syncData | Scenario : Client requests to sync a node URI : {ncmpRoot}/ncmp/v1/ch/node123/syncData Response : HTTP-Status code (only, no body) |
4 | Get model info for CMHandle | GET | {ncmpRoot}/ncmp/v1/ch/{cmHandle}/modules | Scenario : Get the model data for CMHandle URI :{ncmpRoot}/ncmp/v1/ch/2334dedf/modules Header : Accept: application/json Response: [
{
"moduleName": "nc-notifications",
"revision": "2008-07-14",
},
{
"moduleName": "ietf-tls-server",
"revision": "2016-11-02",
},
{
"moduleName": "ietf-ssh-server",
"revision": "2016-11-02",
}
] |
5 | Get all the registered cmhandles for a given plugin | GET | 3 | Get model info for CMHandle | GET | {ncmpRoot}/ncmp/v1/ch/{cmHandle}/modules | Scenario : Get the model data for CMHandle URI :{ncmpRoot}/ncmp/v1/chdmiPlugins/2334dedf{pluginId}/moduleschHeader : Accept: application/json Response: | Scenario : Get all cmhandles from NCMP for a given dmiPlugin. May be used for conciliation Method : GET URI : {ncmpRoot}/ncmp/v1/dmiPlugins/{dmiPlugin}/ch Header : Content-Type: application/json Code Block |
---|
language | xml |
---|
title | Response Body |
---|
| Success Response :
HTTP/1.1 200 Ok
Date: Thu, 26 Jan 2021 20:56:30 GMT
Server: example-server
{ "cmHandles" : [ {
|
[
{
"moduleName": "nc-notifications",
"revision": "2008-07-14",
},
{
"moduleName": "ietf-tls-server",
"revision": "2016-11-02",
},
{
moduleNameietfssh-server1",
"cmHandleProperties " : { " |
revision201611-02",} ] |