References
...
The proposed interface changes required on the dmi-plugin interface are listed in the table in Interface Proposals below.
Interface Proposal
| Requirement | URI |
| Comment |
|---|
NCMP-008
Register or update public cmhandle properties
| {ncmpRoot}/ncmp/v1/ch/ | Scenario : DMI notifies NCMP of new, updated or removed cmhandles
Method : POST
URI : {ncmpRoot}/ncmp/v1/ch/
Header :
Content-Type: application/json
Request BodyRequest Body : {
"dmiPlugin" : "onap.dmi.plugin",
"createdCmHandles" : [ { "cmHandle" : "rf4er5454",
"cmHandleProperties" : {
"samplePropertyName1" : "samplePropertyValue1"
}
"publicCmHandleProperties" : {
"hostedBy" : "cmhandle-5678"
"samplePropertyName2" : "samplePropertyValue2
} },
{..}
],
"updatedCmHandles" : [
{
"cmHandle" : "ds4errr77",
"cmHandleProperties" : { # To remove a property, set the value to "NULL"
"samplePropertyName1" : "updatedSamplePropertyValue1",
"samplePropertyName2" : "NULL" # This property will be removed
}
"publicCmHandleProperties" : { # To remove a property, set the value to "NULL"
"hostedBy" : "cmhandle-11213",
"samplePublicPropertyName1" : "updatedSamplePublicPropertyValue2"
}
},
{..}
],
"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
| - Is the URI being updated to {ncmpRoot}/ncmpDmi/v2/ch ?
- Update to an existing interface
- New proposed additions in red
- To remove a property, suggest to set the value for the property to "NULL" in the updatedCmHandles section
- Note, the given properties like hostedBy are sample data only.
|