Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

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 B

As part of this release, CLI will focus on following functionalities, It will continue the support for those functionalities supported in Amsterdam release and in addition, it aims to cover VNF 

and closed-loop support, PNF support.


Model: Open Command Spec (OCS)

in Beijing release, following updates are made in OCS:

  1. context param is provided to make the communication channel between commands , which can share the run-time details from one command to another
  2. info is provided for CLI author to provide details about product, service and versions.
  3. service is moved under http profile
  4. snmp profile is added 
  5. restconf  profile is planned

Service Management

Helps to check the list of ONAP service deployed on a given setup and retrieve the health status. 

Discovery


s.noFeatureDescriptionDepends-on ProjectRelease
1Report 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

Amsterdam

Beijing

2Register a service

Helps to register a service into MSB, when that service is started.


MSB

Amsterdam

Beijing

3Unregister a serviceHelps to unregister a service into MSB, after that service is stopped.MSB

Amsterdam

Beijing

Health Check

s.noFeatureDescriptionDepends-on ProjectRelease
1Report health of registered servicesReports each service whether its up/down.MSBAmsterdam

Beijing

2Enable/Disable a registered servicesHelps to disable/enable a registered services for various situations such as maintenance.MSBAmsterdam

Beijing

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.noFeatureDescriptionDepends-on ProjectRelease
1Register cloudHelps to register a cloud such as OpenStack, VMWare, etc

A&AI/ESR

Amsterdam

Beijing

2Un-register cloudHelps to un-register the cloud from ONAP

A&AI/ESR

Amsterdam

Beijing

3Report registered clouds

Reports the complete details of cloud including endpoint, version

username, tenant, Region, etc.

A&AI/ESR

Amsterdam

Beijing

VNFM management

s.noFeatureDescriptionDepends-on ProjectRelease
1Register VNFMHelps to register a cloud such as vendor's VNFM

A&AI/ESR

Amsterdam

Beijing

2Un-register VNFMHelps to un-register the VNFM from ONAP

A&AI/ESR

Amsterdam

Beijing

3Report registered VNFMs

Reports the complete details of VNFM including username,

endpoint, etc.

A&AI/ESR

Amsterdam

Beijing

EMS management

s.noFeatureDescriptionDepends-on ProjectRelease
1Register EMSHelps to register a EMS such as Vendors EMS

A&AI/ESR

Amsterdam

Beijing

2Un-register EMSHelps to un-register the EMS from ONAP

A&AI/ESR

Amsterdam

Beijing

3Report registered EMSs

Reports complete deatils of EMS including version, endpoint,

etc

A&AI/ESR

Amsterdam

Beijing

PNF management

s.noFeatureDescriptionDepends-on ProjectRelease
1Register PNFHelps to register a PNFsuch as Vendors PNF

A&AI/ESR

Beijing

2Un-register PNFHelps to un-register the PNF from ONAP

A&AI/ESR

Beijing

3Report registered PNF

Reports complete deatils of PNF including version, endpoint,

etc

A&AI/ESR

Beijing

4attach PNF

associate PNF with service instance,

add appropriate link between PNF, interfaces and logical link

A&AIBeijing

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.noFeatureDescriptionDepends-on ProjectRelease
1Create Service TypeHelps to create a service like type like vFwAAI

Amsterdam

Beijing

2Deploy Service

Helps to deploy the service artifacts into various ONAP services. (like

SDC distribute all the service artifacts)

SO

Amsterdam

Beijing

3Report deployed servicesReports the deployed services detailsSO

Amsterdam

Beijing

4Launch ServiceHelps to launch the deployed serviceSO


Amsterdam

Beijing

5Report active servicesReports the services which are running/idelSO

Amsterdam

Beijing

6Undeploy service

Helps to undeploy all the service artifacts from the ONAP services.

SO

Amsterdam

Beijing

7Remove service typeHelps to remove the service type from AAIAAI

Amsterdam

Beijing

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.noFeatureDescriptionDepends-on ProjectRelease
1Report policiesHelps to retrieve the details of policies defined for a given service/VNFPolicyBeijing





Alarm management

s.noFeatureDescriptionDepends-on ProjectRelease
1Report Alarms

Helps to retrieve the alarms generated for a given service/VNF. (Strech goal)


DCAEBeijing





Analytics management


s.noFeatureDescriptionDepends-on ProjectRelease
1Report metricsHelps to retrieve the collected metrics for a given service/VNF (Strech goal)DCAEBeijing





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.noFeatureDescriptionDepends-on ProjectRelease
1Add customerCreates subscriberA&AI

Amsterdam

Beijing

2Delete CustomerRemoves subscriber from ONAPA&AI

Amsterdam

Beijing

3Reports registered customerHelps to find out the details of registered subscriberA&AI

Amsterdam

Beijing

Subscription management

s.noFeatureDescriptionDepends-on ProjectRelease
1Create SubscriptionSubscribe a customer for a service typeA&AI

Amsterdam

Beijing

2Delete SubscriptionUn-Subscribe a customer for a service typeA&AI

Amsterdam

Beijing

VSP Distribution

s.noFeatureDescriptionDepends-on ProjectRelease
1Manage Catalog serviceHelps to add, list and delete a catalog serviceSDC

Amsterdam

Beijing

2Manage resource of catalog serviceHelps to add, update and delete VNF packages of serviceSDC

Amsterdam

Beijing

3Manage service certificationCertify/uncertify the given serviceSDC

Amsterdam

Beijing

4Manage service distributionApprove/Disapprove distribution of a serviceSDC

Amsterdam

Beijing


Command management

Helps to discover/validate the installed ONAP Commands/schema

s.noFeatureDescriptionDepends-on ProjectRelease
1Open 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

Amsterdam

Beijing

2CLI HelperHelps to find the details of all supported commands by CLI projectCLI

Amsterdam

Beijing

3Dynamic Command discoveryHelps to dynamically discover the installed ONAL CLI commandsCLI

Amsterdam

Beijing

Deployment support

Helps to discover/validate the installed ONAP Commands/schema

s.noFeatureDescriptionDepends-on ProjectRelease
1Distribute CLI as docker container

Launch the CLI from OOM & demo using docker container

OOM / Integration /demo

Beijing

2Distribute CLI from nexusTo install CLI manually, provides the required installer from onap nexusCLI

Amsterdam

Beijing

3Access from ONAP portal

Provides the download option from ONAP portal

Also enable CLI app as integral portal application

CLI/Portal

Amsterdam

Beijing

User Authentication support

Helps to login/logout user. (Based on other services supporting with AAF)

s.noFeatureDescriptionDepends-on ProjectRelease
1Login

Login a user (Strech goal)

AAF

Beijing

2LogoutLogout current user (Strech goal)AAFBeijing

VNF support

Helps to login/logout user.

s.noFeatureDescriptionDepends-on ProjectRelease
1SNMP

Provides unified CLI for supporting SNMP to VNF

VNF/APPCBeijing
2RestconfProvides unified CLI for supporting Restconf to VNF.VNF/APPCBeijing
3VESProvides unified CLI for supporting VES to VNF. (Strech goal)VNFBeijing
4Standardizing CLIBring up an standard CLI for VNF, which every VNF could adopt to provide (Strech goal)CLI/VNFBeijing


S3P

Each of the feature defined above would be having the details of each command with following details

s.noFeatureDescriptionDepends-on ProjectRelease
1CIIProvide CII badging with 'passing'CLIBeijing
2HTTPSEnable CLI OCC with httpsCLIBeijing
3Horizontal scalingValidate Multiple simulatneous OCC session (with profile management)CLIBeijing
4loggingEnable loggine for debugging purposeCLIBeijing


CLI User management support

Helps to login/logout user.

s.noFeatureDescriptionDepends-on ProjectRelease
1CLI user level support

In CLI, users want to provide access control to those who wants to provides rights to read, execute and author new CLI YAML. its kind of command center where Operators are looking for it like AT&T. (streach goal)

CLIBeijing