Introduction
It provides the details of the REST API used for each of the command supported.
Service Management
Helps to check the list of ONAP service deployed on a given setup and retrieve the health status.
Discovery
| s.no | Feature | command | REST API | Depends-on Project |
|---|---|---|---|---|
| 1 | Report registered services | microservice-list microservice-show | GET on /api/microservices/v1/services GET on /api/microservices/v1/services/{serviceName}/version/{version}/ | MSB |
| 2 | Register a service | microservice-register | POST on /api/microservices/v1/services | MSB |
| 3 | Unregister a service | microservice-unregister | DELETE on /api/microservices/v1/services/{serviceName}/version/{version}/ | MSB |
Health Check
| s.no | Feature | command | REST API | Depends-on Project |
|---|---|---|---|---|
| 1 | Report health of registered services | microservice-status | NOT supported for Amesterdam release | MSB |
| 2 | Enable/Disable a registered services | microservice-enable microservice-disable | NOT supported for Amesterdam release | MSB |
External Resource Management
Helps to on-board the external system such as VIM, VNFM, EMS and SDNC and retrieve the current state of these resources.
VIM management
| s.no | Feature | Command | REST API | Depends-on Project |
|---|---|---|---|---|
| 1 | Register cloud | cloud-register | PUT on /api/aai-cloudInfrastructure/v1/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id} | |
| 2 | Un-register cloud | cloud-unregister | DELETE on /onapapi/aai/esr/v1/vims?cloudOwner=xxx&cloudRegionId=xxx | |
| 3 | Report registered clouds | cloud-list cloud-show | GET on /api/aai-cloudInfrastructure/v1/cloud-regions GET on /api/aai-cloudInfrastructure/v1/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id} |
VNFM management
| s.no | Feature | command | REST API | Depends-on Project |
|---|---|---|---|---|
| 1 | Register VNFM | vnfm-register | PUT on /api/aai-vnfm/v1/vnfms/vnfm/{vnfmId} | |
| 2 | Un-register VNFM | vnfm-unregister | DELETE on /api/aai-vnfm/v1/vnfms/vnfm/{vnfmId} | |
| 3 | Report registered VNFMs | vnfm-list vnfm-show | GET on /api/aai-vnfm/v1/vnfms GET on /api/aai-vnfm/v1/vnfms/vnfm/{vnfmId} |
EMS management
| s.no | Feature | Command | REST API | Depends-on Project |
|---|---|---|---|---|
| 1 | Register EMS | ems-register | POST on /api/aai-ems/v1/emses/ems | |
| 2 | Un-register EMS | ems-unregister | DELETE on /api/aai-ems/v1/emses/ems/{emsId} | |
| 3 | Report registered EMSs | ems-list ems-show | GET on /api/aai-ems/v1/emses/ems GET on /api/aai-ems/v1/emses/ems/{emsId} |
Service Orchestration
Helps to deploy, instantiate and destroy a given services such as VoLTE and vCPE services
Service Life-cycle management
Deploy → Launch → Delete → Undeploy
| s.no | Feature | Command | REST API | Depends-on Project |
|---|---|---|---|---|
| 1 | Create/show Service Type | service-type-register service-type-list | PUT on /service-design-and-creation/services/service/{service-id} GET on /service-design-and-creation/services | AAI |
| 2 | Deploy Service | service-deploy | PUT on /serviceInstances/v2 | SO |
| 3 | Report deployed services | service-list | NOT available | SO |
| 4 | Launch Service | service-create | POST /serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules | SO |
| 5 | Delete a service | service-delete | DELETE /serviceInstnaces/v2/{serviceInstanceId} | SO |
| 6 | Undeploy service | service-undeploy | DELETE POST /serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmodule-instance-id} | SO |
| 7 | Remove service type | service-type-unregister | DELETE on /service-design-and-creation/services/service/{service-id} | AAI |
** SO exposes APIs for VNF creation which will be used in VF module createion.
Closed loop Management
Helps to report the policy, alarm and analytics aspect of an given service in ONAP for auto-scaling and healing of them.
Policy management
| s.no | Feature | Command | REST API | Depends-on Project |
|---|---|---|---|---|
| 1 | Report policies | policy-list policy-show | NOT available | Policy |
Alarm management
| s.no | Feature | Command | REST API | Depends-on Project |
|---|---|---|---|---|
| 1 | Report Alarms | alarm-list alarm-show | NOT supported for Amesterdam release | DCAE |
Analytics management
| s.no | Feature | Command | REST API | Depends-on Project |
|---|---|---|---|---|
| 1 | Report metrics | metrics-list | NOT supported for Amesterdam release | DCAE |
Limitation
It does not support designing of the services as it involves studio. so its expected that design time artifact should be readily available for using the feature like service management.
Customer Management
Helps to manage the subscriber, who like to use the services provided by ONAP.
Customer management
| s.no | Feature | Command | REST API | Depends-on Project |
|---|---|---|---|---|
| 1 | Add customer | customer-add | PUT on /business/customers/customer/{global-customer-id} | AAI |
| 2 | Delete Customer | customer-delete | DELETE on /business/customers/customer/{global-customer-id} | AAI |
| 3 | Reports registered customer | customer-list customer-show | GET on /business/customers GET on /business/customers/customer/{global-customer-id} | AAI |
Subscription management
| s.no | Feature | Command | REST API | Depends-on Project |
|---|---|---|---|---|
| 1 | Create Subscription | subscription-create | PUT on /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type} | AAI |
| 2 | Delete Subscription | subscription-delete | DELETE on /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type} | AAI |
VSP Distribution
| s.no | Feature | Command | REST API | Depends-on Project |
|---|---|---|---|---|
| 1 | Manage Catalog service | vsp-list vsp-create vsp-upload vsp-checkin vsp-submit vsp-show | GET on /vendor-software-products POST on /vendor-software-products POST on /vendor-software-products/{VSP-ID}/upload PUT on /vendor-software-products/{VSP-ID}/actions PUT on /vendor-software-products/<VSP-ID>/actions GET on /vendor-software-products/{VSP-ID} | SDC |
| 2 | Manage service certification | catalog-service-verify catalog-service-unverify | TBD | SDC |
| 3 | Manage service distribution | catalog-service-distribute catalog-service-undistribute | TBD | SDC |
Command management
Helps to discover/validate the installed ONAP Commands/schema
| s.no | Feature | Command | Depends-on Project |
|---|---|---|---|
| 1 | Open CLI schema validation | schema-validate | CLI |
| 2 | CLI Helper | onap -h | CLI |
| 3 | Dynamic Command discovery | schema-refresh | CLI |
User Authentication support
Helps to login/logout user.
| s.no | Feature | Command | REST API | Depends-on Project |
|---|---|---|---|---|
| 1 | Login | service→auth: aaf | NOT available | AAF |
| 2 | Logout | service→auth: aaf | NOT available | AAF |