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 for enabling the supported use cases (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 | |
| 2 | Un-register cloud | Helps to un-register the cloud from ONAP | MultiCloud, A&AI | |
| 3 | Report registered clouds | Reports the registered cloud details with name, endpoint | MultiCloud, A&AI | |
| 4 | Show registered cloud | Reports the complete details of cloud including username, tenant, Region, etc. | MultiCloud, A&AI |
VNFM management
TBD
EMS management
TBD
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
TBD
Closed loop Management
Helps to manage the policy, alarm and analytics aspect of an given service in ONAP.
Policy management
TBD
Alarm management
TBD
Analytics report
TBD
Customer Management
Helps to manage the subscriber, who like to use the services provided by ONAP.
Subscriber management
TBD
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.