CLI Functionalities
- Former user (Deleted)
- 1 Introduction
- 2 Service Management
- 2.1 Discovery
- 2.2 Health Check
- 3 External Resource Management
- 3.1 VIM management
- 3.2 VNFM management
- 3.3 EMS management
- 4 Service Orchestration
- 4.1 Service Life-cycle management
- 4.2 Closed loop Management
- 4.2.1 Policy management
- 4.2.2 Alarm management
- 4.2.3 Analytics management
- 4.3 Limitation
- 5 Customer Management
- 6 VSP Distribution
- 7 Command management
- 8 Deployment support
- 9 User Authentication support
- 10 Template
Introduction
ONAP CLI helps to operate the ONAP functionalities from the Linux Operating system consoles. And this page provides the details of the minimum-required-functionalities for release A (VoLTE, vCPE).
Every functionalities provided here will be accomplished by discovering required service details from MSB with required authentication of the user using AAF.
Service Management
Helps to check the list of ONAP service deployed on a given setup and retrieve the health status.
Discovery
Feature | Description | Depends-on Project | |
|---|---|---|---|
1 | Report registered services | Reports the registered service details such as name, type, version, Root context URI. In addition, it provides deployment deatils like host/ip, port. | MSB |
2 | Register a service | Helps to register a service into MSB, when that service is started. | MSB |
3 | Unregister a service | Helps to unregister a service into MSB, after that service is stopped. | MSB |
Health Check
Feature | Description | Depends-on Project | |
|---|---|---|---|
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
Feature | Description | Depends-on Project | |
|---|---|---|---|
1 | Register cloud | Helps to register a cloud such as OpenStack, VMWare, etc | A&AI/ESR |
2 | Un-register cloud | Helps to un-register the cloud from ONAP | A&AI/ESR |
3 | Report registered clouds | Reports the complete details of cloud including endpoint, version username, tenant, Region, etc. | A&AI/ESR |
VNFM management
Feature | Description | Depends-on Project | |
|---|---|---|---|
1 | Register VNFM | Helps to register a cloud such as vendor's VNFM | A&AI/ESR |
2 | Un-register VNFM | Helps to un-register the VNFM from ONAP | A&AI/ESR |
3 | Report registered VNFMs | Reports the complete details of VNFM including username, endpoint, etc. | A&AI/ESR |
EMS management
Feature | Description | Depends-on Project | |
|---|---|---|---|
1 | Register EMS | Helps to register a EMS such as Vendors EMS | A&AI/ESR |
2 | Un-register EMS | Helps to un-register the EMS from ONAP | A&AI/ESR |
3 | Report registered EMSs | Reports complete deatils of EMS including version, endpoint, etc | A&AI/ESR |
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
Feature | Description | Depends-on Project | |
|---|---|---|---|
1 | Create Service Type | Helps to create a service like type like vFw | AAI |
2 | Deploy Service | Helps to deploy the service artifacts into various ONAP services. (like SDC distribute all the service artifacts) | SO |
3 | Report deployed services | Reports the deployed services details | SO |
4 | Launch Service | Helps to launch the deployed service | SO |
5 | Report active services | Reports the services which are running/idel | SO |
6 | Undeploy service | Helps to undeploy all the service artifacts from the ONAP services. | SO |
7 | Remove service type | Helps to remove the service type from AAI | AAI |
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
Feature | Description | Depends-on Project | |
|---|---|---|---|
1 | Report policies | Helps to retrieve the details of policies defined for a given service/VNF | Policy |
Alarm management
Feature | Description | Depends-on Project | |
|---|---|---|---|
1 | Report Alarms | Helps to retrieve the alarms generated for a given service/VNF. | DCAE |
Analytics management
Feature | Description | Depends-on Project | |
|---|---|---|---|
1 | Report metrics | Helps to retrieve the collected metrics for a given service/VNF | 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
Feature | Description | Depends-on Project | |
|---|---|---|---|
1 | Add customer | Creates subscriber | A&AI |
2 | Delete Customer | Removes subscriber from ONAP | A&AI |
3 | Reports registered customer | Helps to find out the details of registered subscriber | A&AI |
Subscription management
Feature | Description | Depends-on Project | |
|---|---|---|---|
1 | Create Subscription | Subscribe a customer for a service type | A&AI |
2 | Delete Subscription | Un-Subscribe a customer for a service type | A&AI |
VSP Distribution
Feature | Description | Depends-on Project | |
|---|---|---|---|
1 | Manage Catalog service | Helps to add, list and delete a catalog service | SDC |
2 | Manage resource of catalog service | Helps to add, update and delete VNF packages of service | SDC |
3 | Manage service certification | Certify/uncertify the given service | SDC |
4 | Manage service distribution | Approve/Disapprove distribution of a service | SDC |
Command management
Helps to discover/validate the installed ONAP Commands/schema
Feature | Description | Depends-on Project | |
|---|---|---|---|
1 | Open CLI schema validation | ONAP CLI provides onap-cli-schema v1.0 for writing the YAML template for each command and this feature helps to validate such YAML template | CLI |
2 | CLI Helper | Helps to find the details of all supported commands by CLI project | CLI |
3 | Dynamic Command discovery | Helps to dynamically discover the installed ONAL CLI commands | CLI |
Deployment support
Helps to discover/validate the installed ONAP Commands/schema
Feature | Description | Depends-on Project | |
|---|---|---|---|
1 | Distribute CLI as docker container | Launch the CLI from OOM & demo using docker container | OOM / Integration /demo |
2 | Distribute CLI from nexus | To install CLI manually, provides the required installer from onap nexus | CLI |
3 | Access from ONAP portal | Provides the download option from ONAP portal | CLI/Portal |
User Authentication support
Helps to login/logout user.
Feature | Description | Depends-on Project | |
|---|---|---|---|
1 | Login | Login a user | AAF |
2 | Logout | Logout current user | AAF |
Template
Each of the feature defined above would be having the details of each command with following details
s.no | Feature | Description | Depends-on Project |
|---|---|---|---|