DRAFT
Introduction
ONAP CLI helps to operate the ONAP functionalities from the Linux Operating system consoles and this page provides the details of the functionalities being supported for release A (VoLTE, vCPE)
Service Management
Helps to check the list of ONAP service deployed on a given setup and retrieve the health status.
Discovery
| s.no | Command | Description | Project | Approved by Project PTL/TSC |
|---|---|---|---|---|
| 1 | Report registered services | Reports the registered service details such as name, type, version. | MSB | |
| 2 | show registered service | Reports the registered service details such as name, type, version, Root context URI. In addition, it provides deployment deatils like host/ip, port. | MSB | |
| 3 | register a service | Helps to register a service into MSB, when that service is started. | MSB | |
| 4 | unregister a service | Helps to unregister a service into MSB, after that service is stopped. | MSB |
Health Check
| s.no | Command | Description | Project | Approved by Project PTL/TSC |
|---|---|---|---|---|
| 1 | Report health of registered services | Reports each service whether its up/down. | MSB | |
| 2 | Enable/Disable a registered services | Helps to disable/enable a registered services for various situations such as maintenance. | 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 | Command | Description | Project | Approved by Project PTL/TSC |
|---|---|---|---|---|
| 1 | Register cloud | Helps to register a cloud such as OpenStack, VMWare, etc | MultiCloud, A&AI/ESR | |
| 2 | Un-register cloud | Helps to un-register the cloud from ONAP | MultiCloud, A&AI/ESR | |
| 3 | Report registered clouds | Reports the registered cloud details with name, vendor | MultiCloud, A&AI/ESR | |
| 4 | Show registered cloud | Reports the complete details of cloud including endpoint, version username, tenant, Region, etc. | MultiCloud, A&AI/ESR |
VNFM management
| s.no | Command | Description | Project | Approved by Project PTL/TSC |
|---|---|---|---|---|
| 1 | Register VNFM | Helps to register a cloud such as vendor's VNFM | VFC, A&AI/ESR | |
| 2 | Un-register VNFM | Helps to un-register the VNFM from ONAP | VFC, A&AI/ESR | |
| 3 | Report registered VNFMs | Reports the registered VNFMdetails with name, vendor | VFC, A&AI/ESR | |
| 4 | Show registered VNFM | Reports the complete details of VNFM including username, endpoint, etc. | VFC, A&AI/ESR |
EMS management
| s.no | Command | Description | Project | Approved by Project PTL/TSC |
|---|---|---|---|---|
| 1 | Register EMS | Helps to register a EMS such as Vendors EMS | VFC, A&AI/ESR | |
| 2 | Un-register EMS | Helps to un-register the EMS from ONAP | VFC, A&AI/ESR | |
| 3 | Report registered EMSs | Reports the registered EMSdetails with name, vendor | VFC, A&AI/ESR | |
| 4 | Show registered EMS | Reports complete deatils of EMS including version, endpoint, etc | VFC, A&AI/ESR |
SDN controller management
TBD
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 | Command | Description | Project | Approved by Project PTL/TSC | Notes |
|---|---|---|---|---|---|
| 1 | Deploy Service | Helps to deploy the service artifacts into various ONAP services. (like SDC distribute all the service artifacts) | SDC | check the feasibility from SDC backed service | |
| 2 | Report deployed services | Reports the deployed services details | SDC | ||
| 3 | Launch Service | Helps to launch the deployed service | SO | ||
| 4 | Report active services | Reports the services which are running/idel | SO | ||
| 5 | Delete service | Helps to stop/remove the service | SO | ||
| 6 | Undeploy service | Helps to undeploy all the service artifacts from the ONAP services. | SDC |
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 | Command | Description | Project | Approved by Project PTL/TSC |
|---|---|---|---|---|
| 1 | Report policies | Helps to retrieve the details of policies defined for a given service/VNF | Policy | |
Alarm management
| s.no | Command | Description | Project | Approved by Project PTL/TSC |
|---|---|---|---|---|
| 1 | Report Alarms | Helps to retrieve the alarms generated for a given service/VNF. | Holmes | |
Analytics management
| s.no | Command | Description | Project | Approved by Project PTL/TSC |
|---|---|---|---|---|
| 1 | Report metrics | Helps to retrieve the collected metrics for a given service/VNF | DCAE | |
Customer Management
Helps to manage the subscriber, who like to use the services provided by ONAP.
Subscriber management
| s.no | Command | Description | Project | Approved by Project PTL/TSC |
|---|---|---|---|---|
| 1 | Add customer | Creates subscriber | VID, A&AI | |
| 2 | Delete Customer | Removes subscriber from ONAP | VID, A&AI | |
| 3 | Reports registered customer | Helps to find out the details of registered subscriber | VID, A&AI |
Template
Each of the feature defined above would be having the details of each command with following details
| s.no | Command | Description | Project | Approved by Project PTL/TSC |
|---|---|---|---|---|
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.