ONAP CLI
One Command to command whole ONAP !
Introduction
Both Information and Communication Technology customers prefer Command Line Interface (CLI) over Graphical user interface (GUI) in many situations such as automation, Devops, CI&CD. So CLI is always been as integral part of software products and platforms.
ONAP CLI is built using industry first CLI platform Open CLI Platform (OCLIP) and provides the commands for following ONAP functionalities:
Micro-service discovery
External system and VNF cloud on-boarding
Customer and subscription management
Product and service management
Network service life-cycle management
Policy management
VNF/PNF management
Table of contents
Following guidelines provides detailed information about CLI.
CLI cook-book
To Run OCLIP on local docker machine
Login to docker repository:
docker login -u docker -p docker nexus3.onap.org:10001
Pull cli docker image and run locally:
docker run -d --name oclip -e OPEN_CLI_MODE=daemon -p 9090:8080 -p 8080:80 nexus3.onap.org:10001/onap/cli:2.0-STAGING-latest
Access the CLI console
Web command console:
http://localhost:9090
Linux console:
docker exec -it oclip oclip
How to run OCLIP on ubuntu server
Download install script:
wget -O ~/oclip-install.sh https://gerrit.onap.org/r/gitweb?p=cli.git;a=blob_plain;f=deployment/zip/installer/install-latest.sh;h=71488dae78a3ecbb27711c95475b4568883f799f;hb=refs/heads/master
Set execution mode and run installer:
cd ~ chmod +x oclip-install.sh ./oclip-install.sh
verify the installation, by running:
oclip --version NOTE: Make sure OPEN_CLI_HOME is set to /opt/oclip, type echo $OPEN_CLI_HOME
Setup profile
Run oclip console:
oclipCreate a profile:
profile <name>
Add basic parameters in to profile:
set <service-name>:<parameter-name> Example: To set the host url for service AAI in ONAP, type 'set AAI:host-url=https://192.168.17.35:30233'
For ONAP beijing version, OCLIP provides default profile named onap-beijing. To use this profile, type:
profile onap-beijing set aai:host-url=<AAI service URL> set msb:host-url=<MSB service URL> set sdc:host-url=<SDC service URL> set so:host-url=<SO service URL> NOTE: This step is not applicable for other products, so it could be skipped.
Exit console:
exit
Use the existing profile
In console mode, type:
profile <profile-name>
In scripting mode, type:
oclip -c <profile-name> <command name> Example: To list the VNF cloud registered in the ONAP, type 'oclip -c onap-beijing cloud-list'.
How to configure OCLIP to use for given product version
In console mode
Identify the available and current product version, type:
version It will report as below: CLI version : 2.0.0 [2018-03-21 11:04 UTC] Available products: [open-cli, onap-beijing, onap-amsterdam, sample-helloworld] Enabled product : open-cli
To enable a product say onap-beijing, type:
use onap-beijing
List available commands, type:
help
In scripting mode
Identify the available and current product version, type:
oclip --version It will report as below: CLI version : 2.0.0 [2018-03-21 11:04 UTC] Available products: [open-cli, onap-beijing, onap-amsterdam, sample-helloworld] Enabled product : open-cli
To enable a product say onap-beijing, set environment variable OPEN_CLI_PRODUCT_IN_USE:
export OPEN_CLI_PRODUCT_IN_USE=onap-beijing
List available commands, type:
oclip --help
CLI Console
Please install the CLI by following guidelines provided in CLI deployment using OOM and HEAT
After installation, CLI can be used in following form:
Linux Command Shell
It is available when user has access to the server where CLI is installed using zip or docker container. In this mode, user can use CLI in scripting mode or interactive mode as mentioned in user_guide
Web Command Console
Once CLI is installed using docker container, user could access the web console by using the url http:<<cli-host-server>:30260
Here, <cli-host-server> is the IP address of server where CLI container is installed.
CLI architecture
Following diagram shows the high-level architecture of OCLIP.
Command Registrar : Registrar keeps track of the commands registered in OCLIP and when user invokes the command,
it identifies the corresponding command and helps to invoke the corresponding command plug-in.
Command Discoverer : Discoverer discovers the commands both in plug-in format and YAML and automatically register
them into Registrar.
Command Plug-in : Implement the command as plug-in. More details CLI developer guide
HTTP Command : Plug-in for implementing all Rest based command as YAML without any coding.
SNMP Command : Plug-in for implementing all SNMP based command as YAML without any coding.
Command Shell : Provides the interactive command line console from Linux
Web Command Console : Provides the interactive command line console from web-browser
Cache : Provides persistent storage for discoverer to store the meta-data about the discovered Commands.
open cli schemas : Set of command YAML provides the CLI definitions.
CLI developer guide
OCLI provides following approaches for developing CLI:
As a Plug-in
The plug-in approach is useful for implementing commands for products that do not support REST APIs. It uses this approach to provide the commands for its platform-related operations and provides the following commands as plug-ins:
Schema-validate : To validate the OCS YAML
Schema-refresh: To enable the newly added commands
It also offers the flexibility to implement any kind of command. For example, a specific plug-in command is provided in the CLI to handle HTTP commands, which helps to develop commands by No coding, just by texting
Follow the steps below to implement new plug-in commands for ONAP:
Create a new mvn module (ex: demo) under plugins project.
Use the plugins/sample project as a reference and update the new module demo project pom.xml file.
Add new command YAML with a unique name under ‘src/main/resources/open-cli-schema’.
To implement a command as a plug-in, create a new plug-in class as follows:
package org.onap.cli.sample; import java.util.Map; import org.onap.cli.fw.OnapCommand; import org.onap.cli.fw.OnapCommandSchema; import org.onap.cli.fw.error.OnapCommandException; import org.onap.cli.fw.input.OnapCommandParameter; /** * Hello world. */ @OnapCommandSchema(name = "hello-world", version = "sample-1.0", schema = "hello-world.yaml") public class OnapHelloWorldCommand extends OnapCommand { @Override protected void run() throws OnapCommandException { //Read the input arguments Map<String, OnapCommandParameter> paramMap = getParametersMap(); OnapCommandParameter nameP = paramMap.get("name"); String name = String.valueOf(nameP.getValue()); //Process command String output = "Hello " + name; //Populate outputs this.getResult().getRecordsMap().get("output").getValues().add(output); } }
Note the following points:
‘org.onap.cli.sample.OnapHelloWorldCommand’ extends ‘OnapCommand’ and is annotated with OnapCommandSchema, which carries the command name, product version and schema file name, and is placed under the ‘src/main/resources/onap-cli-schema’ folder.
getParametersMap() helps to get the arguments value given for a command before executing it
getResult().getRecordsMap() helps to set the attributes values of command after executing it
Add the new plug-in class package path into the ‘src/main/resources/META-INF/services/org.onap.cli.fw.OnapCommand’ file
Now the command is ready. Build the project by running ‘mvn clean install’. OCLIP framework automatically delivers these commands as part of the OCLIP zip file as part of this build.
To test this command, run the command ‘oclip hello-world –name amsterdam’
As a YAML
All OCLIP commands can be implemented as YAML using HTTP profile.
Follow the steps below to implement new commands for ONAP using YAML:
Install the latest OCLIP using the guide CLI installation guide.
Under the open-cli-schema folder, add a new YAML file by referring to Open Command Line Interface (CLI) Schema Version (OCS) 1.0.
Use the command ‘oclip schema-validate’ to validate the YAML before testing its functionality.
Run ‘oclip schema-refresh’ command to take the new YAML file. We recommended validating the YAML before running this command.
To test this command, run the command ‘oclip CMD-NAME –help’.
Sample YAML
Find more details about YAML specification at Open Command Line Interface (CLI) Schema Version (OCS) 1.0.
Sample hello-world YAML
open_cli_schema_version: 1.0
name: hello-world-http
description: First cmd hello world using http running under lighttpd in cli at http://<cli-ip>:8080/version.json
version: sample-1.0
parameters:
- name: name
description: name of the person
long_option: name
short_option: b
default_value: ${DEMO_NAME}
type: string
is_optional: false
results:
direction: landscape
attributes:
- name: output
description: hello world output
type: string
scope: short
http:
request:
uri: /version.json
method: GET
service:
name: sample-service
version: v1
auth: none
mode: direct
success_codes:
- 200
- 201
result_map:
output: Hello ${name}, You are running on $b{$.name} $b{$.version}
CLI user guide
One Command to command whole Onap !!
Provides unified commands to operate any products from Linux console and web command console. Configure the following environment variables, before using it:
OPEN_CLI_HOST_URL - Catalog or service URL
OPEN_CLI_HOST_USERNAME - Service user name
OPEN_CLI_HOST_PASSWORD - Service user password
To Run a command
Type oclip <command> from linux console.
To Run in Interactive mode
Type oclip from linux/web console.
And use the directive set to set the values for following parameters:
host-url - Catalog or service URL
host-username - Service user name
host-password - Service user password
Set the product version
CLI framework is enhanced to handle multiple product versions at same time. so to choose the product version, set environment variable OPEN_CLI_PROUDCT_IN_USE.
NOTE: In interactive mode, product version can be selected using typing use <product-version>
Run oclip [-v|–version] to see the CLI and available product version details
Profiling arguments
In interactive mode, user can use profiles for for “set arguments value once and use it ever”.
Please follow the steps given below for setting profiles:
Open the CLI interactive console
2. Create the profile, say ‘onap-deployment-1’ by running ‘profile onap-deployment-1’ There is no limit in number of profiles. OCLIP will create a profile if not exist already, otherwise on typing ‘profile’ on the console, corresponding profiles will be effective. So you can switch across profiles by using this directive ‘profile’.
For example, to add the credentials, Run following steps:
set host-url=<aai-url>
set host-username=AAI
set host-pasword=AAI
Type ‘set’ to print all these arguments stored so far.
NOTE: Profiles are not limited to set only credentials, you can set any frequently using common arguments, which are listed in command help.
NOTE: For setting service specific parameters, use in the form of <service-name>:<param-name>=<param-value>. For example, following setting will be used only for aai service:
set aai:host-url=<aai-url>
set aai:host-username=AAI
set aai:host-pasword=AAI
4. You can override these stored arguments by providing them as arguments directly while running the CLI.
5. Profile information is persisted, so when you disconnect and connect again the CLI console, you can start use the same profile again.
NOTE: Use the directive ‘set’ for setting the values for parameters and ‘unset’ for resetting the values.
In Beijing release, new default profile named as ‘onap-beijing’ is delivered with all default ONAP service credentials. so user could use this profile to avoid setting the credentials every time.
Batching support & Parameter file
For a given scenario where, user wants to run a command with different set of inputs, this feature could be used.
For example, in ONAP, user wants to register multiple clouds at a given time, so user can create a parameter file as given below and capture inputs for one or more clouds:
parameter file name: /usr/mrkanag/cloud-list.yaml
- cloud-1:
name: cloud-region-1
description: Provides the test cloud environment
- cloud-2:
name: cloud-region-2
description: Provides the production cloud environment
To register all these clouds in ONAP execute the cloud-register command with parameter file in inputs as below:
onap -p /usr/mrkanag/cloud-list.yaml cloud-register
Now OCLIP will iterate the command cloud-register for every cloud mentioned in the parameter file /usr/mrkanag/cloud-list.yaml. When user use this approach to execute the command with multiple entries in parameter file is called as batching.
Help
oclip [-h|–help] oclip <command> [-h|–help]
Debug Mode
To run in debug mode, set following environment variables:
OPEN_CLI_CLI_DEBUG - By default its false, otherwise Set to true
OPEN_CLI_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number
More details
Command usage guide
Following documents provide the usage for each commands supported in different releases.
NOTE: Command marked with EXPERIMENTAL is only for testing purpose. Its not recommended to use in production environment
open-cli
[1] basic-login
usage: oclip basic-login
Provides HTTP basic authorization support.
Product: open-cli Service: basic-auth Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
Authorization Authorization and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[2] basic-logout
usage: oclip basic-logout
Provides HTTP basic authorization support. As part of logout, it invalidates authorization key generated while login.
Product: open-cli Service: basic-auth Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[3] catalog
usage: oclip catalog
Provides catalog discovery support to find the base api path for given service from product’s catalog service. If any product wants to support catalog, it could derive from this command. Currently ONAP uses it and creates derived command by using ONAP MSB service.
Product: open-cli Service: catalog Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options:
[-m | --host-url] [-C | --no-catalog] [-l | --catalog-service-name]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-s | --long] [-D | --context] [-i | --catalog-service-version]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-l | --catalog-service-name service name registered in catalog service. It is
of type STRING. By default, it is .
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-i | --catalog-service-version service version registered in catalog service. It
is of type STRING. By default, it is .
Results:
catalog-service-host-url Service connection url and is of type STRING.
catalog-service-base-path service base path, to append with host-url for
connecting the service. and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[4] execution-list
usage: oclip execution-list
List the executions of the given command so far
Product: open-cli Service: execution Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options:
[-e | --request-id] [-b | --service] [-f | --format]
[-h | --help] [-t | --no-title] [-d | --debug]
[-x | --start-time] [-v | --version] [-n | --command]
[-l | --product] [-y | --end-time] [-s | --long]
[-D | --context] [-c | --profile]
where:
-e | --request-id Request id. It is of type STRING. It is optional.
By default, it is .
-b | --service For a given service. It is of type STRING. It is
optional. By default, it is .
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-x | --start-time From start time. It is of type STRING. It is
optional. By default, it is .
-v | --version print service version. It is of type BOOL.
-n | --command For a given command. It is of type STRING. It is
optional. By default, it is .
-l | --product For a given product version. It is of type
STRING. It is optional. By default, it is .
-y | --end-time Till end time. It is of type STRING. It is
optional. By default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-c | --profile For a given profile. It is of type STRING. It is
optional. By default, it is .
Results:
request-id Request id and is of type STRING.
execution-id Execution id and is of type STRING.
product Product and is of type STRING.
service service and is of type STRING.
command command and is of type STRING.
profile Profile and is of type STRING.
status Execution status and is of type STRING.
start-time Command execution starting Time and is of type
STRING.
end-time Command execution finishing Time and is of type
STRING.
input Input and is of type STRING.
output Output and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[5] execution-show
usage: oclip execution-show
Show the complete executions for the given request id
Product: open-cli Service: execution Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options:
[-l | --execution-id] [-D | --context] [-s | --long]
[-h | --help] [-f | --format] [-t | --no-title]
[-d | --debug] [-v | --version]
where:
-l | --execution-id Execution id. It is of type STRING. By default,
it is .
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-h | --help print help message. It is of type BOOL.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
Results:
request-id Request id and is of type STRING.
product Product and is of type STRING.
service service and is of type STRING.
command command and is of type STRING.
profile Profile and is of type STRING.
input Input and is of type STRING.
status Execution status and is of type STRING.
start-time Command execution starting Time and is of type
STRING.
end-time Command execution finishing Time and is of type
STRING.
output Output and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[6] product-list
usage: oclip product-list
List available products registered in OCLIP
Product: open-cli Service: product Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options:
[-D | --context] [-s | --long] [-h | --help]
[-f | --format] [-t | --no-title] [-d | --debug]
[-v | --version]
where:
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-h | --help print help message. It is of type BOOL.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
Results:
product Product name and is of type STRING.
description Product description and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[8] schema-list
usage: oclip schema-list
OCLIP command to list available schema
Product: open-cli Service: schema Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options:
[-l | --product] [-D | --context] [-s | --long]
[-h | --help] [-f | --format] [-t | --no-title]
[-d | --debug] [-v | --version] [-n | --service]
where:
-l | --product For a given product version. It is of type
STRING. By default, it is .
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-h | --help print help message. It is of type BOOL.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-n | --service For a given service in a product. It is of type
STRING. It is optional. By default, it is .
Results:
command Command name and is of type STRING.
schema Schema name and is of type STRING.
service Service name and is of type STRING.
ocs-version Schema version and is of type STRING.
type Command type and is of type STRING.
enabled Command is enabled or not and is of type STRING.
rpc Command is executed remotely and is of type
STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[9] schema-refresh
usage: oclip schema-refresh
OCLIP command to refresh schemas stored in open-cli-schema folders.
Product: open-cli Service: schema Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options:
[-D | --context] [-s | --long] [-h | --help]
[-f | --format] [-t | --no-title] [-d | --debug]
[-v | --version]
where:
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-h | --help print help message. It is of type BOOL.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
Results:
command Command name and is of type STRING.
product Command product version and is of type STRING.
schema Schema name and is of type STRING.
ocs-version Schema version and is of type STRING.
type Command type and is of type STRING.
enabled Command is enabled or not and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[10] schema-show
usage: oclip schema-show
OCLIP command to show available schema in JSON format
Product: open-cli Service: schema Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options:
[-l | --product] [-D | --context] [-s | --long]
[-h | --help] [-f | --format] [-t | --no-title]
[-d | --debug] [-x | --service] [-v | --version]
[-n | --command]
where:
-l | --product For a given product version. It is of type
STRING. By default, it is .
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-h | --help print help message. It is of type BOOL.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-x | --service For a given service. It is of type STRING. It is
optional. By default, it is .
-v | --version print service version. It is of type BOOL.
-n | --command Schema details to fetch. It is of type STRING. By
default, it is .
Results:
schema Scheam json and is of type JSON.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[11] schema-switch
usage: oclip schema-switch
OCLIP command to switch the given command enable/disable
Product: open-cli Service: schema Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options:
[-l | --name] [-i | --product] [-D | --context]
[-s | --long] [-h | --help] [-f | --format]
[-t | --no-title] [-d | --debug] [-v | --version]
where:
-l | --name Command name. It is of type STRING. By default,
it is .
-i | --product Product name. It is of type STRING. By default,
it is .
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-h | --help print help message. It is of type BOOL.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[12] schema-validate
usage: oclip schema-validate
OCLIP command to validate schema
Product: open-cli Service: schema Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options:
[-D | --context] [-s | --long] [-h | --help]
[-b | --ocs-version] [-f | --format] [-t | --no-title]
[-d | --debug] [-v | --version] [-l | --schema-location]
[-i | --internal-schema]
where:
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-h | --help print help message. It is of type BOOL.
-b | --ocs-version OCS version. It is of type STRING. It is optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-l | --schema-location Schema file location. It is of type URL. By
default, it is .
-i | --internal-schema Validate existing schema file. It is of type BOOL.
Results:
error Schema validation error and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[13] service-list
usage: oclip service-list
List the services in given product registered in OCLIP
Product: open-cli Service: product Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options:
[-l | --product] [-D | --context] [-s | --long]
[-h | --help] [-f | --format] [-t | --no-title]
[-d | --debug] [-v | --version]
where:
-l | --product For a given product version. It is of type
STRING. By default, it is .
-D | --context command context. It is of type MAP. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-h | --help print help message. It is of type BOOL.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
Results:
service Service name and is of type STRING.
description Product description and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
onap-dublin
[1] basic-login
usage: oclip basic-login
ONAP basic login auth command
Product: onap-dublin Service: basic-auth Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
Authorization Authorization and is of type STRING.
X-TransactionId X-TransactionId and is of type STRING.
X-FromAppId X-FromAppId and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[2] basic-logout
usage: oclip basic-logout
ONAP basic logout auth command
Product: onap-dublin Service: basic-auth Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[3] catalog
usage: oclip catalog
ONAP catalog command to find the base path for service.
Product: onap-dublin Service: msb Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-l | --catalog-service-name]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-i | --catalog-service-versions] [-s | --long] [-D | --context]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-l | --catalog-service-name service name registered in catalog service. It is
of type STRING. By default, it is .
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-i | --catalog-service-versions service version registered in catalog service. It
is of type STRING. By default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
Results:
catalog-service-host-url Service connection url and is of type STRING.
catalog-service-base-path service base path, to append with host-url for
connecting the service. and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[4] cloud-create
usage: oclip cloud-create
Create a cloud region in Onap
Product: onap-dublin Service: aai Author: Intel ONAP HPA integration team (itohan.ukponmwan@intel.com)
Options:
[-e | --esr-id] [-V | --verify] [-f | --format]
[-h | --help] [-t | --no-title] [-v | --version]
[-c | --cloud-domain] [-s | --long] [-b | --user-name]
[-r | --owner-type] [-S | --sriov-automation] [-I | --extra-info]
[-x | --cloud-owner] [-Q | --system-type] [-y | --region-name]
[-j | --password] [-a | --no-auth] [-w | --cloud-region-version]
[-p | --host-password] [-m | --host-url] [-C | --no-catalog]
[-i | --identity-url] [-d | --debug] [-g | --cloud-zone]
[-l | --default-tenant] [-url | --service-url] [-n | --complex-name]
[-q | --cloud-type] [-D | --context] [-z | --ssl-insecure]
[-k | --system-status] [-u | --host-username]
where:
-e | --esr-id id for esr system (arbitrary UUID e.g
5c85ce1f-aa78-4ebf-8d6f-4b62773e9bc8). It is of
type UUID.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-t | --no-title whether to print title or not. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-c | --cloud-domain cloud domain, default is Default. It is of type
STRING. By default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-b | --user-name cloud user name. It is of type STRING. By
default, it is .
-r | --owner-type owner defined type. It is of type STRING. By
default, it is .
-S | --sriov-automation sriov automation, default is false. It is of type
BOOL. It is optional.
-I | --extra-info extra info to register cloud , generally string
with region id e.g
{\"openstack-region-id\":\"region-id\"}, enter as
{\\"openstack-region-id\\":\\"ONAP-POD-01-Rail-07\
\"} with CLI. It is of type STRING. By default,
it is .
-x | --cloud-owner Onap cloud owner. It is of type STRING. By
default, it is .
-Q | --system-type system type for cloud e.g VIM. It is of type
STRING. By default, it is .
-y | --region-name Onap region name. It is of type STRING. By
default, it is .
-j | --password cloud password. It is of type STRING. By default,
it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-w | --cloud-region-version cloud region version e.g titanium_cloud. It is of
type STRING. By default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-i | --identity-url Onap identity-url, updated by multicloud if
multicloud is used. It is of type STRING. By
default, it is .
-d | --debug Enable debug output. It is of type BOOL.
-g | --cloud-zone Onap cloud zone. It is of type STRING. By
default, it is .
-l | --default-tenant default cloud tenant to use. It is of type
STRING. By default, it is .
-url | --service-url service-url i.e keystone url for openstack. It is
of type STRING. By default, it is .
-n | --complex-name Onap complex-name. It is of type STRING. By
default, it is .
-q | --cloud-type Cloud type e.g openstack. It is of type STRING.
By default, it is .
-D | --context command context. It is of type MAP. It is
optional.
-z | --ssl-insecure to use ssl insecure or not, default is true. It
is of type BOOL.
-k | --system-status status of the cloud, default is active. It is of
type STRING. By default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[5] cloud-delete
usage: oclip cloud-delete
Delete a cloud region from Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --cloud-name]
[-z | --resource-version] [-s | --long] [-D | --context]
[-y | --region-name] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --cloud-name Onap cloud name. It is of type STRING. By
default, it is .
-z | --resource-version Onap cloud region version. It is of type UUID. It
is optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-y | --region-name Onap cloud region name. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[6] cloud-flavor-list
usage: oclip cloud-flavor-list
List the flavors in a cloud region and its capabilities including HPA with -s option
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-y | --cloud-owner] [-u | --host-username]
[-a | --no-auth] [-x | --name] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-y | --cloud-owner Name of cloud owner. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-x | --name Name of cloud region. It is of type STRING. By
default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
flavor Name of Flavor and is of type STRING.
resource-version Resource version of the Flavor and is of type
STRING.
vcpus Number of VCPUs and is of type STRING.
ram-size RAM Size for flavor and is of type STRING.
disk-size Disk size for flavor and is of type STRING.
ID flavor ID in cloud and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[7] cloud-list
usage: oclip cloud-list
List the configured clouds and Onap service subscriptions
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
cloud Onap cloud and is of type STRING.
region Onap cloud region and is of type STRING.
tenant Onap cloud tenat and is of type STRING.
tenant-id Onap cloud tenat id and is of type STRING.
customer Onap cloud customer and is of type STRING.
service Onap cloud service and is of type STRING.
resource-version Onap cloud resource version and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[8] complex-associate
usage: oclip complex-associate
Associate a cloud region with a cloud complex
Product: onap-dublin Service: aai Author: Intel ONAP HPA integration team (itohan.ukponmwan@intel.com)
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-y | --cloud-region] [-x | --complex-name]
[-z | --cloud-owner] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-y | --cloud-region name of registered cloud-region. It is of type
STRING. By default, it is .
-x | --complex-name name of cloud complex. It is of type STRING. By
default, it is .
-z | --cloud-owner name of cloud-owner. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[9] complex-create
usage: oclip complex-create
Create a cloud complex in Onap
Product: onap-dublin Service: aai Author: Intel ONAP HPA integration team (itohan.ukponmwan@intel.com)
Options:
[-V | --verify] [-f | --format] [-h | --help]
[-t | --no-title] [-j | --street2] [-v | --version]
[-r | --physical-location-type] [-s | --long] [-lt | --latitude]
[-x | --physical-location-id] [-y | --data-center-code] [-a | --no-auth]
[-l | --region] [-p | --host-password] [-m | --host-url]
[-C | --no-catalog] [-i | --street1] [-lo | --longitude]
[-d | --debug] [-S | --state] [-la | --lata]
[-D | --context] [-g | --city] [-w | --postal-code]
[-z | --complex-name] [-k | --country] [-o | --elevation]
[-u | --host-username] [-q | --identity-url]
where:
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-t | --no-title whether to print title or not. It is of type BOOL.
-j | --street2 name of street 2 for complex. It is of type
STRING. By default, it is .
-v | --version print service version. It is of type BOOL.
-r | --physical-location-type complex physical location type. It is of type
STRING. By default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-lt | --latitude latitude of complex location. It is of type
STRING. By default, it is .
-x | --physical-location-id id of physical location. It is of type STRING. By
default, it is .
-y | --data-center-code datacenter name. It is of type STRING. By
default, it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-l | --region region complex is located. It is of type STRING.
By default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-i | --street1 name of street 1 for complex. It is of type
STRING. By default, it is .
-lo | --longitude longitude of complex location. It is of type
STRING. By default, it is .
-d | --debug Enable debug output. It is of type BOOL.
-S | --state state complex is located in. It is of type
STRING. By default, it is .
-la | --lata lata of complex. It is of type STRING. By
default, it is .
-D | --context command context. It is of type MAP. It is
optional.
-g | --city city complex is located in. It is of type STRING.
By default, it is .
-w | --postal-code postal code for complex. It is of type STRING. By
default, it is .
-z | --complex-name complex name. It is of type STRING. By default,
it is .
-k | --country country complex is located. It is of type STRING.
By default, it is .
-o | --elevation elevation of complex location. It is of type
STRING. By default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-q | --identity-url identity url for complex. It is of type STRING.
By default, it is .
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[10] complex-delete
usage: oclip complex-delete
Delete a complex from Onap
Product: onap-dublin Service: aai Author: ONAP HPA Integration Team (itohan.ukponmwan@intel.com)
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-y | --resource-version]
[-s | --long] [-D | --context] [-x | --complex-name]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --resource-version Onap complex region version. It is of type UUID.
It is optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-x | --complex-name Onap complex name. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[11] complex-list
usage: oclip complex-list
List the configured complexes
Product: onap-dublin Service: aai Author: ONAP HPA Integration Team (itohan.ukponmwan@intel.com)
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
complex-name onap complex and is of type STRING.
physical-location-id onap complex location id and is of type STRING.
data-center-code data center code and is of type STRING.
identity-url identity url and is of type STRING.
resource-version complex resource version and is of type STRING.
physical-location-type physical location type and is of type STRING.
street1 onap complex street1 and is of type STRING.
street2 onap complex street2 and is of type STRING.
city onap complex city and is of type STRING.
state onap complex state and is of type STRING.
postal-code onap complex postal code and is of type STRING.
country onap complex country and is of type STRING.
region onap complex region and is of type STRING.
latitude onap complex latitude and is of type STRING.
longitude onap complex longitude and is of type STRING.
elevation onap complex elevation and is of type STRING.
lata onap complex lata and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[12] complex-update
usage: oclip complex-update
Update a cloud complex in Onap
Product: onap-dublin Service: aai Author: Intel ONAP HPA integration team (itohan.ukponmwan@intel.com)
Options:
[-V | --verify] [-f | --format] [-h | --help]
[-t | --no-title] [-j | --street2] [-v | --version]
[-r | --physical-location-type] [-R | --resource-version] [-s | --long]
[-lt | --latitude] [-x | --physical-location-id] [-y | --data-center-code]
[-a | --no-auth] [-l | --region] [-p | --host-password]
[-m | --host-url] [-C | --no-catalog] [-i | --street1]
[-lo | --longitude] [-d | --debug] [-S | --state]
[-la | --lata] [-D | --context] [-g | --city]
[-w | --postal-code] [-z | --complex-name] [-k | --country]
[-o | --elevation] [-u | --host-username] [-q | --identity-url]
where:
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-t | --no-title whether to print title or not. It is of type BOOL.
-j | --street2 name of street 2 for complex. It is of type
STRING. By default, it is .
-v | --version print service version. It is of type BOOL.
-r | --physical-location-type complex physical location type. It is of type
STRING. By default, it is .
-R | --resource-version resource version of complex to be updated. It is
of type UUID.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-lt | --latitude latitude of complex location. It is of type
STRING. By default, it is .
-x | --physical-location-id id of physical location. It is of type STRING. By
default, it is .
-y | --data-center-code datacenter name. It is of type STRING. By
default, it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-l | --region region complex is located. It is of type STRING.
By default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-i | --street1 name of street 1 for complex. It is of type
STRING. By default, it is .
-lo | --longitude longitude of complex location. It is of type
STRING. By default, it is .
-d | --debug Enable debug output. It is of type BOOL.
-S | --state state complex is located in. It is of type
STRING. By default, it is .
-la | --lata lata of complex. It is of type STRING. By
default, it is .
-D | --context command context. It is of type MAP. It is
optional.
-g | --city city complex is located in. It is of type STRING.
By default, it is .
-w | --postal-code postal code for complex. It is of type STRING. By
default, it is .
-z | --complex-name complex name. It is of type STRING. By default,
it is .
-k | --country country complex is located. It is of type STRING.
By default, it is .
-o | --elevation elevation of complex location. It is of type
STRING. By default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-q | --identity-url identity url for complex. It is of type STRING.
By default, it is .
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[13] csar-create
usage: oclip csar-create
Uploads the CSARs in marketplace
Product: onap-dublin Service: marketplace Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --csar-file]
[-s | --long] [-D | --context]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --csar-file CSAR File path. It is of type BINARY. By default,
it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
Results:
csarId CSAR id and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[14] csar-delete
usage: oclip csar-delete
Delete CSARs in marketplace
Product: onap-dublin Service: marketplace Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --csar-id]
[-s | --long] [-D | --context]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --csar-id Onap CSAR id. It is of type STRING. By default,
it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[15] csar-list
usage: oclip csar-list
Lists the CSARs in marketplace
Product: onap-dublin Service: marketplace Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
Results:
csarId CSAR Id and is of type STRING.
name CSAR Name and is of type STRING.
size CSAR size and is of type URL.
downloadUri CSAR download URL and is of type URL.
provider CSAR Provider and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[16] csar-show
usage: oclip csar-show
Show details of the CSARs in marketplace
Product: onap-dublin Service: marketplace Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --csar-id]
[-s | --long] [-D | --context]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --csar-id Onap CSAR id. It is of type STRING. By default,
it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
Results:
name CSAR Name and is of type STRING.
size CSAR size and is of type URL.
downloadUri CSAR download URL and is of type URL.
provider CSAR Provider and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[17] customer-create
usage: oclip customer-create
Create a customer in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-y | --subscriber-name] [-C | --no-catalog]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-x | --customer-name] [-s | --long] [-D | --context]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-y | --subscriber-name Onap subscriber name. It is of type STRING. By
default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --customer-name Onap customer name. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[18] customer-delete
usage: oclip customer-delete
Delete a customer from Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-y | --resource-version]
[-s | --long] [-D | --context] [-x | --customer-id]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --resource-version Onap customer resource version. It is of type
UUID.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-x | --customer-id Onap customer id. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[19] customer-list
usage: oclip customer-list
Lists the registered customers in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
name Onap customer name and is of type STRING.
resource-version Onap customer resource version and is of type
STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[20] customer-show
usage: oclip customer-show
Retrieves the given registered customer in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --customer-name]
[-s | --long] [-D | --context] [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --customer-name Onap customer name. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
name Onap customer name and is of type STRING.
subscriber-name Onap subscriber name and is of type STRING.
resource-version Onap subscriber resource version and is of type
STRING.
subscriber-type Onap subscriber type and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[21] ems-create
usage: oclip ems-create
Register a EMS in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-e | --vendor] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-c | --type] [-s | --long] [-D | --context]
[-q | --ems-version] [-j | --password] [-b | --name]
[-i | --username] [-u | --host-username] [-g | --url]
[-x | --remote-path] [-a | --no-auth] [-z | --ems-id]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-e | --vendor Onap EMS vendor. It is of type STRING. By
default, it is .
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-c | --type Onap EMS type. It is of type STRING. By default,
it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-q | --ems-version Onap EMS version. It is of type STRING. By
default, it is .
-j | --password Onap EMS password. It is of type STRING. By
default, it is .
-b | --name Onap EMS name. It is of type STRING. By default,
it is .
-i | --username Onap EMS username. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-g | --url Onap EMS URL. It is of type STRING. By default,
it is .
-x | --remote-path Onap EMS remote-path. It is of type STRING. By
default, it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-z | --ems-id Onap EMS unique id. It is of type UUID.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[22] ems-delete
usage: oclip ems-delete
Un-register a EMS in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-y | --resource-version]
[-x | --ems-id] [-s | --long] [-D | --context]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --resource-version Onap EMS resource version. It is of type STRING.
It is optional. By default, it is .
-x | --ems-id Onap EMS unique id. It is of type UUID.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[23] ems-list
usage: oclip ems-list
List the configured ems
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
ems-id Onap ems id and is of type STRING.
resource-version Onap ems resource version and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[24] ems-show
usage: oclip ems-show
Show the details of configured ems
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --ems-id]
[-s | --long] [-D | --context] [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --ems-id Onap EMS unique id. It is of type UUID.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
name Onap ems name and is of type STRING.
type Onap ems type and is of type STRING.
vendor Onap ems vendor and is of type STRING.
version Onap ems version and is of type STRING.
url Onap ems url and is of type STRING.
username Onap ems username and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[25] get-resource-module-name
usage: oclip get-resource-module-name
Get resource module name
Product: onap-dublin Service: sdc Author: ONAP HPA Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
service-model-vsp name of vsp in service model and is of type
STRING.
resource-module-name system name of vsp and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[26] microservice-create
usage: oclip microservice-create
Register microservice into Onap
Product: onap-dublin Service: msb Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] <create-or-update> [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-c | --path] [-y | --service-version] <node-ip>
<node-port> [-s | --long] [-D | --context]
[-x | --service-name] [-r | --service-url] [-b | --enable-ssl]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
create-or-update Onap service create or update. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-c | --path Onap service path. It is of type STRING. It is
optional. By default, it is .
-y | --service-version Onap service version. It is of type STRING. By
default, it is .
node-ip Onap service running node IP. It is of type
STRING. By default, it is .
node-port Onap service running node port. It is of type
STRING. By default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-x | --service-name Onap service name. It is of type STRING. By
default, it is .
-r | --service-url Onap service base url. It is of type URL. By
default, it is .
-b | --enable-ssl Onap service is enabled with https or not. It is
of type STRING. It is optional. By default, it is
.
Results:
name Onap service name and is of type STRING.
version Onap service version and is of type STRING.
url Onap service base url and is of type URL.
status Onap service status and is of type DIGIT.
nodes Onap service running nodes and is of type STRING.
enable-ssl Onap service is enabled with https or not and is
of type STRING.
path Onap service path and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[27] microservice-delete
usage: oclip microservice-delete
Deletes the micro service from Onap
Product: onap-dublin Service: msb Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-y | --service-version]
[-s | --long] [-D | --context] [-x | --service-name]
[-i | --node-ip] [-r | --node-port]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --service-version Onap service version. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-x | --service-name Onap service name. It is of type STRING. By
default, it is .
-i | --node-ip Onap service running node IP. It is of type
STRING. By default, it is .
-r | --node-port Onap service running node port. It is of type
STRING. By default, it is .
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[28] microservice-list
usage: oclip microservice-list
Lists the registetred micro services in Onap
Product: onap-dublin Service: msb Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
Results:
name Onap service name and is of type STRING.
version Onap service version and is of type STRING.
url Onap service base url and is of type URL.
status Onap service status and is of type DIGIT.
nodes Onap service running nodes and is of type JSON.
enable-ssl Onap service is enabled with https or not and is
of type STRING.
path Onap service path and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[29] microservice-show
usage: oclip microservice-show
Details the registered microservice in Onap
Product: onap-dublin Service: msb Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-y | --service-version]
[-s | --long] [-D | --context] [-x | --service-name]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --service-version Onap service version. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-x | --service-name Onap service name. It is of type STRING. By
default, it is .
Results:
name Onap service name and is of type STRING.
version Onap service version and is of type STRING.
url Onap service base url and is of type URL.
status Onap service status and is of type DIGIT.
nodes Onap service running nodes and is of type JSON.
enable-ssl Onap service is enabled with https or not and is
of type STRING.
path Onap service path and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[30] multicloud-cloud-delete
usage: oclip multicloud-cloud-delete
Deletes a cloud region, can be used to directly delete cloud referenced by other resources
Product: onap-dublin Service: multicloud Author: ONAP HPA Integration Team (itohan.ukponmwan@intel.com)
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-y | --cloud-owner] [-x | --cloud-region]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-y | --cloud-owner Onap Cloud Owner name. It is of type STRING. By
default, it is .
-x | --cloud-region Onap Cloud region name. It is of type STRING. By
default, it is .
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[31] multicloud-register-cloud
usage: oclip multicloud-register-cloud
Register a cloud region with multicloud plugin
Product: onap-dublin Service: multicloud Author: ONAP HPA Integration Team (itohan.ukponmwan@intel.com)
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-y | --cloud-owner] [-x | --cloud-region]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-y | --cloud-owner Onap Cloud Owner name. It is of type STRING. By
default, it is .
-x | --cloud-region Onap Cloud region name. It is of type STRING. By
default, it is .
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[32] owning-entity-list
usage: oclip owning-entity-list
Lists the Owning Entities in Onap
Product: onap-dublin Service: aai Author: ONAP HPA Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
name Owning entity name and is of type STRING.
Id Owning entity Id and is of type STRING.
resource-version Owning entity resource version and is of type
STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[33] policy-basic-login
usage: oclip policy-basic-login
ONAP basic login auth command
Product: onap-dublin Service: policy-basic-auth Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
Authorization Authorization and is of type STRING.
Environment Environment and is of type STRING.
ClientAuth Client Auth and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[34] policy-create-outdated
usage: oclip policy-create-outdated
Create a policy in PAP
Product: onap-dublin Service: policy Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-T | --policy--config-type]
[-b | --policy-config-body] [-s | --long] [-D | --context]
[-u | --host-username] [-x | --policy-name] [-a | --no-auth]
[-S | --policy-scope] [-o | --onap-name] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-T | --policy--config-type Policy config type. It is of type STRING. By
default, it is .
-b | --policy-config-body Policy config body. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-x | --policy-name Onap policy Name. It is of type STRING. By
default, it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-S | --policy-scope Policy scope. It is of type STRING. By default,
it is .
-o | --onap-name Onap name. It is of type STRING. By default, it
is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[35] policy-delete-pap
usage: oclip policy-delete-pap
Delete config policy in PAP
Product: onap-dublin Service: policy Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-c | --delete-condition]
[-s | --long] [-D | --context] [-y | --policy-component]
[-u | --host-username] [-x | --policy-name] [-a | --no-auth]
[-b | --policy-type] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-c | --delete-condition Delete condition. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-y | --policy-component Component of the policy. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-x | --policy-name Onap policy Name. It is of type STRING. By
default, it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-b | --policy-type Policy config type. It is of type STRING. By
default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[36] policy-delete-pdp
usage: oclip policy-delete-pdp
Delete config policy in PDP
Product: onap-dublin Service: policy Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-y | --policy-component] [-u | --host-username]
[-x | --policy-name] [-a | --no-auth] [-b | --policy-type]
[-g | --pdp-group] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-y | --policy-component Component of the policy. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-x | --policy-name Onap policy Name. It is of type STRING. By
default, it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-b | --policy-type Policy config type. It is of type STRING. By
default, it is .
-g | --pdp-group PDP group name. It is of type STRING. By default,
it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[37] policy-delete-type
usage: oclip policy-delete-type
Delete all versions of a policy type
Product: onap-dublin Service: policy Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-x | --policy-type-id] [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-x | --policy-type-id Policy type ID. It is of type STRING. By default,
it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[38] policy-delete-type-with-version
usage: oclip policy-delete-type-with-version
Delete one version of a policy type
Product: onap-dublin Service: policy Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-y | --version-id]
[-s | --long] [-D | --context] [-x | --policy-type-id]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --version-id Policy type version ID. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-x | --policy-type-id Policy type ID. It is of type STRING. By default,
it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[39] policy-list-outdated
usage: oclip policy-list-outdated
List policies
Product: onap-dublin Service: policy Author: ONAP HPA Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-A | --config-attributes]
[-s | --long] [-D | --context] [-u | --host-username]
[-x | --policy-name] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-A | --config-attributes Configuration Attributes. It is of type JSON.
It's recommended to input the complete path of
the file, which is having the value for it. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-x | --policy-name ONAP policy name. It is of type STRING.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
name Policy Name and is of type STRING.
type Policy type and is of type STRING.
config Policy configuration and is of type JSON.
version Policy version and is of type STRING.
rules Policy rules and is of type JSON.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[40] policy-push-outdated
usage: oclip policy-push-outdated
Push a policy to PDP
Product: onap-dublin Service: policy Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-c | --policy-group] [-u | --host-username]
[-x | --policy-name] [-a | --no-auth] [-b | --policy-type]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-c | --policy-group Policy pdp group. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-x | --policy-name Onap policy Name. It is of type STRING. By
default, it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-b | --policy-type Policy type. It is of type STRING. By default, it
is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[41] policy-type-create
usage: oclip policy-type-create
Create a policy type
Product: onap-dublin Service: policy Author: ONAP HPA Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --policy-type-body]
[-s | --long] [-D | --context] [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --policy-type-body Configuration of the new policy type. It is of
type JSON. It's recommended to input the complete
path of the file, which is having the value for
it.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
Response Response message and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[42] policy-type-list
usage: oclip policy-type-list
Retrieve existing policy types
Product: onap-dublin Service: policy Author: ONAP HPA Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] <policy-type-id> [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
policy-type-id Policy type ID. It is of type STRING. By default,
it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
Type properties Policy type properties and is of type JSON.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[43] policy-type-list-all
usage: oclip policy-type-list-all
Retrieve existing policy types
Product: onap-dublin Service: policy Author: ONAP HPA Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
Type properties Policy type properties and is of type JSON.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[44] policy-type-list-with-version
usage: oclip policy-type-list-with-version
Retrieve one particular version of a policy type
Product: onap-dublin Service: policy Author: ONAP HPA Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] <version-id>
[-s | --long] [-D | --context] <policy-type-id>
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
version-id Policy type version ID. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
policy-type-id Policy type ID. It is of type STRING. By default,
it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
Type properties Policy type properties and is of type JSON.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[45] policy-update-outdated
usage: oclip policy-update-outdated
Update a policy in PAP
Product: onap-dublin Service: policy Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-T | --policy--config-type]
[-b | --policy-config-body] [-s | --long] [-D | --context]
[-u | --host-username] [-x | --policy-name] [-a | --no-auth]
[-S | --policy-scope] [-o | --onap-name] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-T | --policy--config-type Policy config type. It is of type STRING. By
default, it is .
-b | --policy-config-body Policy config body. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-x | --policy-name Onap policy Name. It is of type STRING. By
default, it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-S | --policy-scope Policy scope. It is of type STRING. By default,
it is .
-o | --onap-name Onap name. It is of type STRING. By default, it
is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[46] sdc-basic-login
usage: oclip sdc-basic-login
ONAP basic login auth command
Product: onap-dublin Service: sdc-basic-auth Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
Authorization Authorization and is of type STRING.
X-TransactionId X-TransactionId and is of type STRING.
X-FromAppId X-FromAppId and is of type STRING.
USER_ID USER_ID for sdc and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[47] sdnc-create
usage: oclip sdnc-create
Register a SDNC in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-g | --ip-address] [-e | --vendor] [-V | --verify]
[-f | --format] [-h | --help] [-t | --no-title]
[-v | --version] [-y | --sdnc-id] [-s | --long]
[-j | --password] [-b | --name] [-a | --no-auth]
[-p | --host-password] [-m | --host-url] [-C | --no-catalog]
[-d | --debug] [-k | --port] [-c | --type]
[-q | --sdnc-version] [-D | --context] [-r | --protocal]
[-z | --product-name] [-i | --username] [-u | --host-username]
[-x | --location]
where:
-g | --ip-address Onap SDNC ip address. It is of type STRING. By
default, it is .
-e | --vendor Onap SDNC vendor. It is of type STRING. By
default, it is .
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-t | --no-title whether to print title or not. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --sdnc-id Onap SDNC unique id. It is of type UUID.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-j | --password Onap SDNC password. It is of type STRING. By
default, it is .
-b | --name Onap SDNC name. It is of type STRING. By default,
it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-d | --debug Enable debug output. It is of type BOOL.
-k | --port Onap SDNC port. It is of type STRING. By default,
it is .
-c | --type Onap SDNC type. It is of type STRING. By default,
it is .
-q | --sdnc-version Onap SDNC version. It is of type STRING. By
default, it is .
-D | --context command context. It is of type MAP. It is
optional.
-r | --protocal Onap SDNC protocal. It is of type STRING. By
default, it is .
-z | --product-name Onap SDNC product-name. It is of type STRING. By
default, it is .
-i | --username Onap SDNC username. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-x | --location Onap SDNC unique id. It is of type UUID.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[48] sdnc-delete
usage: oclip sdnc-delete
Un-register a VNFM in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --sdnc-id]
[-r | --resource-version] [-s | --long] [-D | --context]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --sdnc-id Onap sdnc unique id. It is of type STRING. By
default, it is .
-r | --resource-version Onap resource version. It is of type UUID. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[49] sdnc-list
usage: oclip sdnc-list
List the configured sdnc
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
sdnc-id Onap sdnc id and is of type STRING.
resource-version Onap sdnc resource version and is of type STRING.
location Onap sdnc location and is of type STRING.
product-name Onap sdnc product name and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[50] service-create
0x7006::In service-create-schema-dublin.yaml, Parameter option t is in conflict, only one option is allowed with given name
[51] service-create-vcpe
0x7006::In service-create-vcpe-schema-dublin.yaml, Parameter option t is in conflict, only one option is allowed with given name
[52] service-delete
usage: oclip service-delete
Delete a service instance using SO
Product: onap-dublin Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-e | --model-name] [-C | --no-catalog]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-b | --model-invariant-id] [-j | --cloud-region] [-x | --service-instace-id]
[-r | --requestor-id] [-i | --model-uuid] [-c | --customer-name]
[-s | --long] [-D | --context] [-g | --model-version]
[-k | --tenant-id] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-e | --model-name model name available in SDC catalog. It is of
type STRING. By default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-b | --model-invariant-id model invariant id for service in SDC catalog. It
is of type STRING. By default, it is .
-j | --cloud-region cloud region id. It is of type STRING. By
default, it is .
-x | --service-instace-id unique id for service instance. It is of type
STRING. By default, it is .
-r | --requestor-id requestor ID. It is of type STRING. By default,
it is .
-i | --model-uuid model uuid for service in SDC catalog. It is of
type STRING. By default, it is .
-c | --customer-name unique id for customer. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-g | --model-version model version of service (eg. 1.0). It is of type
STRING. By default, it is .
-k | --tenant-id tenant id. It is of type STRING. By default, it
is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[53] service-list
usage: oclip service-list
List all service instances from SO
Product: onap-dublin Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
name Onap service name and is of type STRING.
version Onap service version and is of type STRING.
url Onap service base url and is of type URL.
status Onap service status and is of type DIGIT.
nodes Onap service running nodes and is of type JSON.
enable-ssl Onap service is enabled with https or not and is
of type STRING.
path Onap service path and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[54] service-model-add-vf
usage: oclip service-model-add-vf
Helps to add VF into service models in SDC
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --service-model-id]
[-b | --vf-version] [-y | --vf-id] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-z | --vf-name] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --service-model-id Onap Service Name. It is of type STRING. By
default, it is .
-b | --vf-version VF version. It is of type STRING. It is optional.
By default, it is .
-y | --vf-id VF ID. It is of type STRING. It is optional. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-z | --vf-name VF ID. It is of type STRING. It is optional. By
default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
ID Service ID and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[55] service-model-approve
usage: oclip service-model-approve
Approves the Service model in SDC
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-b | --service-model-uuid]
[-r | --remarks] [-s | --long] [-D | --context]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-b | --service-model-uuid Service model UUID (can be found by running
service-model-list). It is of type STRING. By
default, it is .
-r | --remarks approval remarks. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[56] service-model-checkin
usage: oclip service-model-checkin
Checkin Service model in SDC
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-b | --service-model-uuid]
[-r | --remarks] [-s | --long] [-D | --context]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-b | --service-model-uuid Service model UUID (can be found by running
service-model-list). It is of type STRING. By
default, it is .
-r | --remarks checkin remarks. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[57] service-model-checkout
usage: oclip service-model-checkout
Checkout Service model in SDC
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-b | --service-model-uuid]
[-s | --long] [-D | --context] [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-b | --service-model-uuid Service model UUID (can be found from
service-model-list). It is of type STRING. It is
optional. By default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[58] service-model-create
usage: oclip service-model-create
Create Service model in SDC
Product: onap-dublin Service: sdc Author: ONAP HPA Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-z | --project-code]
[-y | --description] [-e | --icon-id] [-c | --category-display-name]
[-s | --long] [-D | --context] [-x | --service-name]
[-u | --host-username] [-a | --no-auth] [-b | --category]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-z | --project-code Project code. It is of type STRING. It is
optional. By default, it is .
-y | --description Description for Service. It is of type STRING. It
is optional. By default, it is .
-e | --icon-id Service Icon id (options are
"network_l_4","network_l_1-3"[use this icon for
"Network L1-3","E2E Service","Network
Service"],"mobility","call_controll"). It is of
type STRING. It is optional.
-c | --category-display-name Service category display name (Options are
"Network L4+","Network L1-3","E2E
Service","Network Service","Mobility","VoIP Call
Control"). It is of type STRING. It is optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-x | --service-name Onap Service Name. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-b | --category Service category (options are "network
l4+","network l1-3","e2e
service","mobility","network service","voip call
control"). It is of type STRING. It is optional.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
ID Service ID and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[59] service-model-distribute
usage: oclip service-model-distribute
Distributes the Service model in SDC
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-b | --service-model-uuid]
[-s | --long] [-D | --context] [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-b | --service-model-uuid Service model UUID (can be found from
service-model-list). It is of type STRING. It is
optional. By default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[60] service-model-list
usage: oclip service-model-list
List the service model in SDC
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
uuid UUID and is of type STRING.
invariant-uuid Invariant UUID and is of type STRING.
name Name and is of type STRING.
version version and is of type STRING.
status status and is of type STRING.
distribution-status status and is of type STRING.
description description and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[61] service-model-test-accept
usage: oclip service-model-test-accept
Accepts the Service model test in SDC
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-r | --test-remark] [-b | --service-model-id]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-r | --test-remark Remarks when accepting test. It is of type
STRING. By default, it is .
-b | --service-model-id Service model ID. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[62] service-model-test-reject
usage: oclip service-model-test-reject
Rejects the Service model test in SDC
Product: onap-dublin Service: sdc Author: ONAP HPA Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-r | --test-remark] [-b | --service-model-id]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-r | --test-remark Remarks when rejecting test. It is of type
STRING. By default, it is .
-b | --service-model-id Service model ID. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[63] service-model-test-request
usage: oclip service-model-test-request
Request the certification of Service model in SDC
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-r | --remark]
[-s | --long] [-D | --context] [-b | --service-model-id]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-r | --remark Remarks when submitting for testing. It is of
type STRING. By default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-b | --service-model-id Service model ID. It is of type STRING. It is
optional. By default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[64] service-model-test-start
usage: oclip service-model-test-start
Starts the testing of a Service model in SDC
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-b | --service-model-id] [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-b | --service-model-id Service model ID. It is of type STRING. It is
optional. By default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[65] service-model-undocheckout
usage: oclip service-model-undocheckout
Undo Checkout of Service model in SDC
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-b | --service-model-uuid]
[-s | --long] [-D | --context] [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-b | --service-model-uuid Service model UUIID (check service-model-list).
It is of type STRING. It is optional. By default,
it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[66] service-show
0x7006::In service-show-schema-dublin.yaml, Parameter option s is in conflict, only one option is allowed with given name
[67] service-show-resource-module-name
0x7006::In service-show-resource-module-name-schema-dublin.yaml, Parameter option s is in conflict, only one option is allowed with given name
[68] service-type-create
usage: oclip service-type-create
Add a service type in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-x | --service-type]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-y | --service-type-id] [-s | --long] [-D | --context]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-x | --service-type Onap service type. It is of type STRING. By
default, it is .
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --service-type-id Onap service type uuid. It is of type UUID. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[69] service-type-delete
usage: oclip service-type-delete
Delete a service type from Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-y | --resource-version]
[-x | --service-type-id] [-s | --long] [-D | --context]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --resource-version Onap service resource version. It is of type
UUID. It is optional.
-x | --service-type-id Onap service type uuid. It is of type UUID. It is
optional.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[70] service-type-list
usage: oclip service-type-list
List the service types configured in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
service-type-id Onap cloud service and is of type STRING.
service-type Onap cloud service and is of type STRING.
resource-version Onap cloud service resource version and is of
type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[71] service-update
usage: oclip service-update
Update a service instance using SO
Product: onap-dublin Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-V | --verify] [-f | --format] [-h | --help]
[-t | --no-title] [-l | --cloud-region] [-w | --service-type]
[-v | --version] [-i | --model-name] [-c | --customer]
[-q | --requestor-id] [-s | --long] [-b | --tenant-id]
[-k | --instance-name] [-r | --supress-rollback] [-a | --no-auth]
[-n | --model-version-id] [-p | --host-password] [-m | --host-url]
[-C | --no-catalog] [-e | --model-invariant-id] [-d | --debug]
[-x | --service-instace-id] [-D | --context] [-j | --model-version]
[-u | --host-username] [-g | --model-uuid]
where:
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-t | --no-title whether to print title or not. It is of type BOOL.
-l | --cloud-region cloud region identifier. It is of type STRING. By
default, it is .
-w | --service-type subscription service type. It is of type STRING.
By default, it is .
-v | --version print service version. It is of type BOOL.
-i | --model-name model name as provided in ASDC design time. It is
of type STRING. By default, it is .
-c | --customer unique id for customer. It is of type STRING. By
default, it is .
-q | --requestor-id requestor ID. It is of type STRING. By default,
it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-b | --tenant-id tenant id. It is of type STRING. By default, it
is .
-k | --instance-name service instance name. It is of type STRING. By
default, it is .
-r | --supress-rollback rollback changes if instantiation fails. It is of
type BOOL. It is optional.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-n | --model-version-id model-version-id. It is of type STRING. By
default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-e | --model-invariant-id model invariant id generated by ASDC. It is of
type STRING. By default, it is .
-d | --debug Enable debug output. It is of type BOOL.
-x | --service-instace-id unique id for service instance. It is of type
STRING. By default, it is .
-D | --context command context. It is of type MAP. It is
optional.
-j | --model-version model-version. It is of type STRING. By default,
it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-g | --model-uuid model uuid generated by ASDC. It is of type
STRING. By default, it is .
Results:
service-id instance id for the created service. and is of
type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[72] service2vf-model-list
usage: oclip service2vf-model-list
List the VF in a given service model in SDC
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-z | --service-model-id]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-s | --long] [-D | --context] [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-z | --service-model-id Service model uuid. It is of type STRING. By
default, it is .
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
vf-uuid UUID and is of type STRING.
vf-name name and is of type STRING.
vf-customization-uuid customization UUID and is of type STRING.
vf-version version and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[73] subscription-cloud-add
usage: oclip subscription-cloud-add
Add a new cloud region to a customer subscription
Product: onap-dublin Service: aai Author: Intel ONAP HPA integration team (itohan.ukponmwan@intel.com)
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --customer-name]
[-c | --cloud-tenant-id] [-s | --long] [-D | --context]
[-z | --cloud-owner] [-e | --service-type] [-u | --host-username]
[-a | --no-auth] [-y | --tenant-name] [-r | --cloud-region]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --customer-name Onap customer name. It is of type STRING. By
default, it is .
-c | --cloud-tenant-id Onap cloud tenant id. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-z | --cloud-owner Onap cloud owner name. It is of type STRING. By
default, it is .
-e | --service-type Onap service type. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-y | --tenant-name name of tenant to use in the cloud region. It is
of type STRING. By default, it is .
-r | --cloud-region Onap cloud region. It is of type STRING. By
default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[74] subscription-cloud-delete
usage: oclip subscription-cloud-delete
Delete a cloud region from a customer subscription
Product: onap-dublin Service: aai Author: Intel ONAP HPA integration team (onap-discuss@lists.onap.org)
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --customer-name]
[-c | --cloud-tenant-id] [-s | --long] [-D | --context]
[-z | --cloud-owner] [-e | --service-type] [-u | --host-username]
[-a | --no-auth] [-y | --tenant-name] [-r | --cloud-region]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --customer-name Onap customer name. It is of type STRING. By
default, it is .
-c | --cloud-tenant-id Onap cloud tenant id. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-z | --cloud-owner Onap cloud owner name. It is of type STRING. By
default, it is .
-e | --service-type Onap service type. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-y | --tenant-name name of tenant to use in the cloud region. It is
of type STRING. By default, it is .
-r | --cloud-region Onap cloud region. It is of type STRING. By
default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[75] subscription-create
usage: oclip subscription-create
Create a subscription of a customer for given service in specific cloud region in Onap
Product: onap-dublin Service: aai Author: Intel ONAP HPA integration team (itohan.ukponmwan@intel.com)
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --customer-name]
[-c | --cloud-tenant-id] [-s | --long] [-D | --context]
[-z | --cloud-owner] [-e | --service-type] [-u | --host-username]
[-a | --no-auth] [-y | --tenant-name] [-r | --cloud-region]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --customer-name Onap customer name. It is of type STRING. By
default, it is .
-c | --cloud-tenant-id Onap cloud tenant id. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-z | --cloud-owner Onap cloud owner name. It is of type STRING. By
default, it is .
-e | --service-type Onap service type. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-y | --tenant-name name of tenant to use in the cloud region. It is
of type STRING. By default, it is .
-r | --cloud-region Onap cloud region. It is of type STRING. By
default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[76] subscription-delete
usage: oclip subscription-delete
Delete the subscription for a given customer in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --customer-name]
[-y | --service-type] [-s | --long] [-D | --context]
[-g | --resource-version] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --customer-name Onap customer name. It is of type STRING. By
default, it is .
-y | --service-type Onap subscribtion id. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-g | --resource-version Onap subscription resource version. It is of type
STRING. It is optional. By default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[77] subscription-list
usage: oclip subscription-list
Lists the subscription for a given customer in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --customer-name]
[-s | --long] [-D | --context] [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --customer-name Onap customer name. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
service-type Onap service type and is of type STRING.
resource-version Onap subscription resource version and is of type
STRING.
tenant Onap tenant name and is of type STRING.
region Onap region name and is of type STRING.
cloud Onap cloud name and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[78] tenant-create
usage: oclip tenant-create
Create a tenant under given cloud region in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --cloud]
[-z | --tenant-id] [-y | --region] [-s | --long]
[-D | --context] [-r | --tenant-name] [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --cloud Onap cloud. It is of type STRING. By default, it
is .
-z | --tenant-id Onap cloud tenant id. It is of type UUID.
-y | --region Onap cloud region. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-r | --tenant-name Onap cloud tenant name. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[79] tenant-delete
usage: oclip tenant-delete
Delete tenant under given cloud region in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --cloud]
[-z | --tenant-id] [-r | --resource-version] [-y | --region]
[-s | --long] [-D | --context] [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --cloud Onap cloud. It is of type STRING. By default, it
is .
-z | --tenant-id Onap cloud tenant id. It is of type STRING. By
default, it is .
-r | --resource-version Onap cloud tenant version. It is of type UUID. It
is optional.
-y | --region Onap cloud region. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[80] tenant-list
usage: oclip tenant-list
Lists the tenants under given cloud region in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --cloud]
[-y | --region] [-s | --long] [-D | --context]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --cloud Onap cloud. It is of type STRING. By default, it
is .
-y | --region Onap cloud region. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
tenant-id Onap tenant-id and is of type STRING.
tenant-name Onap tenant name and is of type STRING.
resource-version Onap tenant resource version and is of type
STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[81] vf-model-certify
usage: oclip vf-model-certify
Certify a Virtual function
Product: onap-dublin Service: sdc Author: ONAP HPA Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-b | --vf-id]
[-r | --remarks] [-s | --long] [-D | --context]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-b | --vf-id VF ID. It is of type STRING. By default, it is .
-r | --remarks certification remarks. It is of type STRING. It
is optional. By default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[82] vf-model-create
usage: oclip vf-model-create
Create Virtual function from Vendor Software Product
Product: onap-dublin Service: sdc Author: ONAP HPA Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-y | --description]
[-g | --vsp-version] [-x | --name] [-s | --long]
[-D | --context] [-z | --vendor-name] [-u | --host-username]
[-a | --no-auth] [-b | --vsp-id] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --description Description for VF. It is of type STRING. It is
optional. By default, it is .
-g | --vsp-version VSP version. It is of type STRING. By default, it
is .
-x | --name Onap VF Name. It is of type STRING. By default,
it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-z | --vendor-name Vendor name. It is of type STRING. By default, it
is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-b | --vsp-id VSP ID. It is of type STRING. By default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
ID VF ID and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[83] vf-model-list
usage: oclip vf-model-list
List the VF resource model in SDC
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
uuid UUID and is of type STRING.
uniqueid UUID and is of type STRING.
invariant-uuid Invariant UUID and is of type STRING.
name Name and is of type STRING.
version version and is of type STRING.
status status and is of type STRING.
description description and is of type STRING.
vsp-uuid VSP uuid and is of type STRING.
vsp-version VSP version and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[84] vf-module-create
usage: oclip vf-module-create
Create a VF Module
Product: onap-dublin Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-w | --tenant-id] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-y | --vnf-instace-id] [-z | --parenet-service-model] [-x | --service-instace-id]
[-l | --lcp-cloudregion-id] [-s | --long] [-D | --context]
[-i | --instance-name] [-u | --host-username] [-r | --supress-rollback]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-w | --tenant-id openstack tenant id (uuid). It is of type STRING.
By default, it is .
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --vnf-instace-id vnf instance id. It is of type STRING. By
default, it is .
-z | --parenet-service-model parent service model name. It is of type STRING.
By default, it is .
-x | --service-instace-id unique id for service instance. It is of type
STRING. By default, it is .
-l | --lcp-cloudregion-id AIC LCP node location identifier. It is of type
STRING. By default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-i | --instance-name service instance name. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-r | --supress-rollback rollback changes if instantiation fails. It is of
type BOOL. It is optional.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[85] vf-module-list
usage: oclip vf-module-list
List all VF Modules
Product: onap-dublin Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-w | --tenant-id] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-y | --vnf-instace-id] [-z | --parenet-service-model] [-x | --service-instace-id]
[-l | --lcp-cloudregion-id] [-s | --long] [-D | --context]
[-i | --instance-name] [-u | --host-username] [-r | --supress-rollback]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-w | --tenant-id openstack tenant id (uuid). It is of type STRING.
By default, it is .
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --vnf-instace-id vnf instance id. It is of type STRING. By
default, it is .
-z | --parenet-service-model parent service model name. It is of type STRING.
By default, it is .
-x | --service-instace-id unique id for service instance. It is of type
STRING. By default, it is .
-l | --lcp-cloudregion-id AIC LCP node location identifier. It is of type
STRING. By default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-i | --instance-name service instance name. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-r | --supress-rollback rollback changes if instantiation fails. It is of
type BOOL. It is optional.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[86] vf-module-show
usage: oclip vf-module-show
Show a VF Module
Product: onap-dublin Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
name Onap service name and is of type STRING.
version Onap service version and is of type STRING.
url Onap service base url and is of type URL.
status Onap service status and is of type DIGIT.
nodes Onap service running nodes and is of type JSON.
enable-ssl Onap service is enabled with https or not and is
of type STRING.
path Onap service path and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[87] vf-module-update
usage: oclip vf-module-update
Update a VF Module
Product: onap-dublin Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-w | --tenant-id] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-y | --vnf-instace-id] [-z | --parenet-service-model] [-x | --service-instace-id]
[-l | --lcp-cloudregion-id] [-s | --long] [-D | --context]
[-i | --instance-name] [-u | --host-username] [-r | --supress-rollback]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-w | --tenant-id openstack tenant id (uuid). It is of type STRING.
By default, it is .
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --vnf-instace-id vnf instance id. It is of type STRING. By
default, it is .
-z | --parenet-service-model parent service model name. It is of type STRING.
By default, it is .
-x | --service-instace-id unique id for service instance. It is of type
STRING. By default, it is .
-l | --lcp-cloudregion-id AIC LCP node location identifier. It is of type
STRING. By default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-i | --instance-name service instance name. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-r | --supress-rollback rollback changes if instantiation fails. It is of
type BOOL. It is optional.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[88] vf-preload
usage: oclip vf-preload
Preload SDNC with parameter values for a VF module in ONAP
Product: onap-dublin Service: sdnc Author: Intel ONAP HPA integration team (itohan.ukponmwan@intel.com)
Options:
[-m | --host-url] [-C | --no-catalog] [-y | --preload-file]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-s | --long] [-D | --context] [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-y | --preload-file File containing preload values. It is of type
TEXT. By default, it is .
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[89] vfc-catalog-delete-ns
usage: oclip vfc-catalog-delete-ns
vfc delete onboard ns from catalog of vfc
Product: onap-dublin Service: vfc Author: ONAP HPA Integration Team (haibin.huang@intel.com)
Options:
[-m | --host-url] [-c | --ns-csar-uuid] [-C | --no-catalog]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-s | --long] [-D | --context]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-c | --ns-csar-uuid ns's uuid of csar file. It is of type STRING. By
default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
Results:
job-id job-id and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[90] vfc-catalog-delete-vnf
usage: oclip vfc-catalog-delete-vnf
vfc delete onboard vnf to catalog of vfc
Product: onap-dublin Service: vfc Author: ONAP HPA Integration Team (haibin.huang@intel.com)
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-c | --vnf-csar-uuid]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-c | --vnf-csar-uuid vnf's uuid of csar file. It is of type STRING. By
default, it is .
Results:
job-id job-id and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[91] vfc-catalog-get-ns
usage: oclip vfc-catalog-get-ns
vfc get onboard ns status
Product: onap-dublin Service: vfc Author: ONAP HPA Integration Team (haibin.huang@intel.com)
Options:
[-m | --host-url] [-c | --ns-csar-uuid] [-C | --no-catalog]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-s | --long] [-D | --context]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-c | --ns-csar-uuid ns's uuid of csar file. It is of type STRING. By
default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
Results:
nsd-invariant-id nsd-invariant-id and is of type STRING.
ns-package-id ns-package-id and is of type STRING.
nsd-provider nsd-provider and is of type STRING.
nsd-id nsd-id and is of type STRING.
download-url download-url and is of type STRING.
csar-name csar-name and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[92] vfc-catalog-get-vnf
usage: oclip vfc-catalog-get-vnf
vfc get onboard vnf status
Product: onap-dublin Service: vfc Author: ONAP HPA Integration Team (haibin.huang@intel.com)
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-c | --vnf-csar-uuid]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-c | --vnf-csar-uuid vnf's uuid of csar file. It is of type STRING. By
default, it is .
Results:
vnfd-id vnfd-id and is of type STRING.
vnf-package-id vnf-package-id and is of type STRING.
vnfd-provider vnfd-provider and is of type STRING.
vnfd-version vnfd-version and is of type STRING.
vnf-version vnf-version and is of type STRING.
csar-name csar-name and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[93] vfc-catalog-onboard-ns
usage: oclip vfc-catalog-onboard-ns
vfc onboard ns to catalog of vfc
Product: onap-dublin Service: vfc Author: ONAP HPA Integration Team (haibin.huang@intel.com)
Options:
[-m | --host-url] [-c | --ns-csar-uuid] [-C | --no-catalog]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-s | --long] [-D | --context]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-c | --ns-csar-uuid ns's uuid of csar file. It is of type STRING. By
default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
Results:
status status and is of type STRING.
status-desc status-desc and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[94] vfc-catalog-onboard-vnf
usage: oclip vfc-catalog-onboard-vnf
vfc onboard vnf to catalog of vfc
Product: onap-dublin Service: vfc Author: ONAP HPA Integration Team (haibin.huang@intel.com)
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-c | --vnf-csar-uuid]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-c | --vnf-csar-uuid vnf's uuid of csar file. It is of type STRING. By
default, it is .
Results:
job-id job-id and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[95] vfc-nslcm-create
usage: oclip vfc-nslcm-create
vfc nslcm create ns
Product: onap-dublin Service: vfc Author: ONAP HPA Integration Team (haibin.huang@intel.com)
Options:
[-n | --ns-csar-name] [-m | --host-url] [-c | --ns-csar-uuid]
[-C | --no-catalog] [-f | --format] [-h | --help]
[-V | --verify] [-t | --no-title] [-d | --debug]
[-v | --version] [-s | --long] [-D | --context]
where:
-n | --ns-csar-name ns's name of csar. It is of type STRING. By
default, it is .
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-c | --ns-csar-uuid ns's uuid of csar file. It is of type STRING. By
default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
Results:
ns-instance-id ns-instance-id and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[96] vfc-nslcm-delete
usage: oclip vfc-nslcm-delete
vfc nslcm delete ns
Product: onap-dublin Service: vfc Author: ONAP HPA Integration Team (haibin.huang@intel.com)
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-c | --ns-instance-id]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-c | --ns-instance-id ns's instance id. It is of type STRING. By
default, it is .
Results:
status status and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[97] vfc-nslcm-get
usage: oclip vfc-nslcm-get
vfc nsclm get the status of creating ns
Product: onap-dublin Service: vfc Author: ONAP HPA Integration Team (haibin.huang@intel.com)
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-c | --ns-instance-id]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-c | --ns-instance-id ns's instance id. It is of type STRING. By
default, it is .
Results:
ns-instance-id ns-instance-id and is of type STRING.
ns-name ns-name and is of type STRING.
description description and is of type STRING.
nsd-id nsd-id and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[98] vfc-nslcm-instantiate
usage: oclip vfc-nslcm-instantiate
vfc nslcm instantiate ns
Product: onap-dublin Service: vfc Author: ONAP HPA Integration Team (haibin.huang@intel.com)
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-c | --location-constraints]
[-s | --long] [-D | --context] [-i | --ns-instance-id]
[-n | --sdn-controller-id]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-c | --location-constraints localtion constraints. It is of type JSON. It's
recommended to input the complete path of the
file, which is having the value for it.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-i | --ns-instance-id ns's instance id. It is of type STRING. By
default, it is .
-n | --sdn-controller-id sdn controller id. It is of type STRING. By
default, it is .
Results:
job-id job id and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[99] vfmodule-delete
usage: oclip vfmodule-delete
delete a VF module (experimental)
Product: onap-dublin Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-l | --cloud-region]
[-j | --service-id] [-z | --tenant-id] [-y | --vf-id]
[-k | --vf-model-invariant-id] [-s | --long] [-D | --context]
[-g | --vfmodule-version] [-x | --vfmodule-id] [-e | --vfmodule-name]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-l | --cloud-region cloud region identifier. It is of type STRING. By
default, it is .
-j | --service-id unique id for service. It is of type STRING. By
default, it is .
-z | --tenant-id openstack tenant id. It is of type STRING. By
default, it is .
-y | --vf-id unique id for related VF. It is of type STRING.
By default, it is .
-k | --vf-model-invariant-id vf model invariant id. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-g | --vfmodule-version vf module version. It is of type STRING. By
default, it is .
-x | --vfmodule-id VF module Id. It is of type STRING. By default,
it is .
-e | --vfmodule-name vfmodule model name. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[100] vfn-create
usage: oclip vfn-create
Create a VNF
Product: onap-dublin Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-j | --service-model-invariant-id] [-q | --service-model-name] [-k | --service-model-uuid]
[-V | --verify] [-f | --format] [-h | --help]
[-t | --no-title] [-l | --cloud-region] [-v | --version]
[-y | --service-instance-id] [-z | --tenant-id] [-r | --requestor-id]
[-c | --vf-model-uuid] [-o | --instance-name] [-s | --long]
[-e | --vf-model-name] [-g | --vf-model-version] [-b | --vf-model-invariant-id]
[-n | --service-model-version] [-a | --no-auth] [-p | --host-password]
[-m | --host-url] [-i | --vf-model-customization-id] [-C | --no-catalog]
[-d | --debug] [-D | --context] [-w | --product-family]
[-u | --host-username]
where:
-j | --service-model-invariant-id model invariant id. It is of type STRING. By
default, it is .
-q | --service-model-name service model name. It is of type STRING. By
default, it is .
-k | --service-model-uuid model name version id. It is of type STRING. By
default, it is .
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-t | --no-title whether to print title or not. It is of type BOOL.
-l | --cloud-region cloud region identifier. It is of type STRING. By
default, it is .
-v | --version print service version. It is of type BOOL.
-y | --service-instance-id unique id for service instance. It is of type
STRING. By default, it is .
-z | --tenant-id openstack tenant id. It is of type STRING. By
default, it is .
-r | --requestor-id requestor ID. It is of type STRING. By default,
it is .
-c | --vf-model-uuid model uuid for vf. It is of type STRING. By
default, it is .
-o | --instance-name service instance name. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-e | --vf-model-name vf model name. It is of type STRING. By default,
it is .
-g | --vf-model-version vf model version. It is of type STRING. By
default, it is .
-b | --vf-model-invariant-id vf model invariant id. It is of type STRING. By
default, it is .
-n | --service-model-version service model version. It is of type STRING. By
default, it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-i | --vf-model-customization-id vf model customization id. It is of type STRING.
By default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-d | --debug Enable debug output. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-w | --product-family service type for serivce (e.g. vLB). It is of
type STRING. By default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
Results:
vf-id id for the created vnf and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[101] vim-create
usage: oclip vim-create
Register a VIM under a given cloud region in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-e | --vendor] [-V | --verify] [-f | --format]
[-h | --help] [-t | --no-title] [-x | --cloud-name]
[-v | --version] [-s | --long] [-k | --ssl-cacert]
[-y | --region-name] [-j | --password] [-b | --name]
[-a | --no-auth] [-n | --cloud-domain] [-z | --vim-id]
[-p | --host-password] [-m | --host-url] [-C | --no-catalog]
[-d | --debug] [-q | --vim-version] [-l | --ssl-insecure]
[-c | --type] [-o | --default-tenant] [-D | --context]
[-i | --username] [-u | --host-username] [-g | --url]
where:
-e | --vendor Onap VIM vendor. It is of type STRING. By
default, it is .
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-t | --no-title whether to print title or not. It is of type BOOL.
-x | --cloud-name Onap cloud name. It is of type STRING. By
default, it is .
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-k | --ssl-cacert Onap VIM SSL certificate. It is of type TEXT. It
is optional. By default, it is .
-y | --region-name Onap region name. It is of type STRING. By
default, it is .
-j | --password Onap VIM password. It is of type STRING. By
default, it is .
-b | --name Onap VIM name. It is of type STRING. By default,
it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-n | --cloud-domain Onap VIM cloud domain. It is of type STRING. By
default, it is .
-z | --vim-id Onap VIM unique id. It is of type UUID.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-d | --debug Enable debug output. It is of type BOOL.
-q | --vim-version Onap VIM version. It is of type STRING. By
default, it is .
-l | --ssl-insecure Onap VIM insecure. It is of type BOOL. It is
optional.
-c | --type Onap VIM type. It is of type STRING. By default,
it is .
-o | --default-tenant Onap VIM default tenant. It is of type STRING. By
default, it is .
-D | --context command context. It is of type MAP. It is
optional.
-i | --username Onap VIM username. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-g | --url Onap VIM URL. It is of type STRING. By default,
it is .
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[102] vim-delete
usage: oclip vim-delete
Un-register a VIM under from cloud region in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --cloud-name]
[-s | --long] [-D | --context] [-y | --region-name]
[-u | --host-username] [-a | --no-auth] [-z | --vim-id]
[-p | --host-password] [-b | --resource-version]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --cloud-name Onap cloud name. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-y | --region-name Onap region name. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-z | --vim-id Onap VIM unique id. It is of type UUID.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
-b | --resource-version Onap vim resource version. It is of type STRING.
It is optional. By default, it is .
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[103] vim-list
usage: oclip vim-list
List the configured vims
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --cloud-name]
[-s | --long] [-D | --context] [-y | --region-name]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --cloud-name Onap cloud name. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-y | --region-name Onap region name. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
vim-id Onap vim id and is of type STRING.
name Onap vim name and is of type STRING.
type Onap vim type and is of type STRING.
vendor Onap vim vendor and is of type STRING.
version Onap vim version and is of type STRING.
url Onap vim url and is of type STRING.
username Onap vim username and is of type STRING.
cloud-domain Onap vim cloud domain and is of type STRING.
default-tenant Onap vim tenant and is of type STRING.
resource-version Onap vim resource version and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[104] vlm-aggreement-create
usage: oclip vlm-aggreement-create
Create license aggreement
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-y | --vlm-id] [-C | --no-catalog]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-z | --description] [-x | --name] [-g | --vlm-feature-group-id]
[-s | --long] [-D | --context] [-u | --host-username]
[-a | --no-auth] [-e | --vlm-version] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-y | --vlm-id License Model ID. It is of type STRING. By
default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-z | --description Description for aggreement. It is of type STRING.
By default, it is .
-x | --name aggreement name. It is of type STRING. By
default, it is .
-g | --vlm-feature-group-id VLM feature group. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-e | --vlm-version License Model version. It is of type STRING. By
default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
ID aggreement ID and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[105] vlm-create
usage: oclip vlm-create
Create License Model
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-y | --description]
[-s | --long] [-D | --context] [-x | --vendor-name]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --description Description for License Model. It is of type
STRING. It is optional. By default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-x | --vendor-name vendor name. It is of type STRING. By default, it
is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
ID License Model ID and is of type UUID.
version License Model version and is of type UUID.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[106] vlm-delete
usage: oclip vlm-delete
Delete License Model (certified vlms cannot be deleted)
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-y | --vlm-id] [-C | --no-catalog]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-s | --long] [-D | --context] [-x | --vendor-name]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-y | --vlm-id vlm id. It is of type STRING. By default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-x | --vendor-name vendor name. It is of type STRING. By default, it
is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[107] vlm-entitlement-pool-create
usage: oclip vlm-entitlement-pool-create
Create Entitlement Pool
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-y | --vlm-id] [-C | --no-catalog]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-z | --description] [-k | --manufacture-reference-number] [-g | --expiryDate]
[-x | --name] [-s | --long] [-D | --context]
[-l | --startDate] [-u | --host-username] [-a | --no-auth]
[-e | --vlm-version] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-y | --vlm-id License Model ID. It is of type STRING. By
default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-z | --description Description for Entitlement Pool. It is of type
STRING. By default, it is .
-k | --manufacture-reference-number Manufature Reference Number. It is of type
STRING. By default, it is .
-g | --expiryDate License end date (MM/DD/YYYY). It is of type
STRING. By default, it is .
-x | --name Entitlement Pool name. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-l | --startDate License start date (MM/DD/YYYY). It is of type
STRING. By default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-e | --vlm-version License Model version. It is of type STRING. By
default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
ID Entitlement Pool ID and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[108] vlm-feature-group-create
usage: oclip vlm-feature-group-create
Create feature group Pool
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-y | --vlm-id] [-C | --no-catalog]
[-f | --format] [-h | --help] [-c | --part-number]
[-V | --verify] [-t | --no-title] [-d | --debug]
[-v | --version] [-z | --description] [-b | --vlm-entitle-pool-id]
[-x | --name] [-g | --vlm-key-group-id] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-e | --vlm-version] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-y | --vlm-id License Model ID. It is of type STRING. By
default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-c | --part-number Part number. It is of type STRING. By default, it
is .
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-z | --description Description for feature group. It is of type
STRING. By default, it is .
-b | --vlm-entitle-pool-id VLM Entitlement pool. It is of type STRING. By
default, it is .
-x | --name Feature group name. It is of type STRING. By
default, it is .
-g | --vlm-key-group-id VLM keygroup. It is of type STRING. By default,
it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-e | --vlm-version License Model version. It is of type STRING. By
default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
ID Feature group ID and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[109] vlm-key-group-create
usage: oclip vlm-key-group-create
Create License Key Group
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-z | --description]
[-x | --name] [-y | --type] [-s | --long]
[-D | --context] [-c | --vlm-id] [-u | --host-username]
[-a | --no-auth] [-e | --vlm-version] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-z | --description Description for License Key Group. It is of type
STRING. It is optional. By default, it is .
-x | --name name. It is of type STRING. By default, it is .
-y | --type type of group (Universal, unique, one-time). It
is of type STRING.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-c | --vlm-id License Model Id. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-e | --vlm-version License Model version. It is of type STRING. By
default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
ID License Model ID and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[110] vlm-list
usage: oclip vlm-list
List the vendor license models in ONAP
Product: onap-dublin Service: sdc Author: ONAP HPA Integration Team (itohan.ukponmwan@intel.com)
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
vlm-name name of the vendor license model and is of type
STRING.
vlm-id ID of the vendor license model and is of type
STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[111] vlm-submit
usage: oclip vlm-submit
Submit Vendor License Model
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-y | --vlm-version]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-x | --vlm-id] [-s | --long] [-D | --context]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-y | --vlm-version VLM version. It is of type STRING. By default, it
is .
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --vlm-id Onap VLM ID. It is of type STRING. By default, it
is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[112] vnf-delete
usage: oclip vnf-delete
Delete a VNF
Product: onap-dublin Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-e | --model-name] [-C | --no-catalog]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-l | --cloud-region] [-b | --model-invariant-id] [-y | --service-instance-id]
[-z | --tenant-id] [-s | --long] [-D | --context]
[-g | --model-version] [-c | --model-uuid] [-u | --host-username]
[-a | --no-auth] [-x | --vf-id] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-e | --model-name model name available in SDC catalog. It is of
type STRING. By default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-l | --cloud-region Cloud region ID. It is of type STRING. By
default, it is .
-b | --model-invariant-id model invariant id for service in SDC catalog. It
is of type STRING. By default, it is .
-y | --service-instance-id unique id for service instance. It is of type
STRING. By default, it is .
-z | --tenant-id openstack tenant id (uuid). It is of type STRING.
By default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-g | --model-version model version of service (eg. 1.0). It is of type
STRING. By default, it is .
-c | --model-uuid model uuid for service in SDC catalog. It is of
type STRING. By default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-x | --vf-id id for vnf. It is of type STRING. By default, it
is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[113] vnf-list
usage: oclip vnf-list
List all VNFs
Product: onap-dublin Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-j | --service-model-invariant-id] [-q | --service-model-name] [-k | --service-model-uuid]
[-V | --verify] [-f | --format] [-h | --help]
[-t | --no-title] [-l | --cloud-region] [-v | --version]
[-y | --service-instance-id] [-z | --tenant-id] [-r | --requestor-id]
[-c | --vf-model-uuid] [-o | --instance-name] [-s | --long]
[-e | --vf-model-name] [-g | --vf-model-version] [-b | --vf-model-invariant-id]
[-n | --service-model-version] [-a | --no-auth] [-p | --host-password]
[-m | --host-url] [-i | --vf-model-customization-id] [-C | --no-catalog]
[-d | --debug] [-D | --context] [-w | --product-family]
[-u | --host-username]
where:
-j | --service-model-invariant-id model invariant id. It is of type STRING. By
default, it is .
-q | --service-model-name service model name. It is of type STRING. By
default, it is .
-k | --service-model-uuid model name version id. It is of type STRING. By
default, it is .
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-t | --no-title whether to print title or not. It is of type BOOL.
-l | --cloud-region cloud region identifier. It is of type STRING. By
default, it is .
-v | --version print service version. It is of type BOOL.
-y | --service-instance-id unique id for service instance. It is of type
STRING. By default, it is .
-z | --tenant-id openstack tenant id. It is of type STRING. By
default, it is .
-r | --requestor-id requestor ID. It is of type STRING. By default,
it is .
-c | --vf-model-uuid model uuid for vf. It is of type STRING. By
default, it is .
-o | --instance-name service instance name. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-e | --vf-model-name vf model name. It is of type STRING. By default,
it is .
-g | --vf-model-version vf model version. It is of type STRING. By
default, it is .
-b | --vf-model-invariant-id vf model invariant id. It is of type STRING. By
default, it is .
-n | --service-model-version service model version. It is of type STRING. By
default, it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-i | --vf-model-customization-id vf model customization id. It is of type STRING.
By default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-d | --debug Enable debug output. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-w | --product-family service type for serivce (e.g. vLB). It is of
type STRING. By default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
Results:
vf-id id for the created vnf and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[114] vnf-show
usage: oclip vnf-show
Show a VNF
Product: onap-dublin Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-j | --service-model-invariant-id] [-q | --service-model-name] [-k | --service-model-uuid]
[-V | --verify] [-f | --format] [-h | --help]
[-t | --no-title] [-l | --cloud-region] [-v | --version]
[-y | --service-instance-id] [-z | --tenant-id] [-r | --requestor-id]
[-c | --vf-model-uuid] [-o | --instance-name] [-s | --long]
[-e | --vf-model-name] [-g | --vf-model-version] [-b | --vf-model-invariant-id]
[-n | --service-model-version] [-a | --no-auth] [-p | --host-password]
[-m | --host-url] [-i | --vf-model-customization-id] [-C | --no-catalog]
[-d | --debug] [-D | --context] [-w | --product-family]
[-u | --host-username]
where:
-j | --service-model-invariant-id model invariant id. It is of type STRING. By
default, it is .
-q | --service-model-name service model name. It is of type STRING. By
default, it is .
-k | --service-model-uuid model name version id. It is of type STRING. By
default, it is .
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-t | --no-title whether to print title or not. It is of type BOOL.
-l | --cloud-region cloud region identifier. It is of type STRING. By
default, it is .
-v | --version print service version. It is of type BOOL.
-y | --service-instance-id unique id for service instance. It is of type
STRING. By default, it is .
-z | --tenant-id openstack tenant id. It is of type STRING. By
default, it is .
-r | --requestor-id requestor ID. It is of type STRING. By default,
it is .
-c | --vf-model-uuid model uuid for vf. It is of type STRING. By
default, it is .
-o | --instance-name service instance name. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-e | --vf-model-name vf model name. It is of type STRING. By default,
it is .
-g | --vf-model-version vf model version. It is of type STRING. By
default, it is .
-b | --vf-model-invariant-id vf model invariant id. It is of type STRING. By
default, it is .
-n | --service-model-version service model version. It is of type STRING. By
default, it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-i | --vf-model-customization-id vf model customization id. It is of type STRING.
By default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-d | --debug Enable debug output. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-w | --product-family service type for serivce (e.g. vLB). It is of
type STRING. By default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
Results:
vf-id id for the created vnf and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[115] vnf-update
usage: oclip vnf-update
Update a VNF
Product: onap-dublin Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-j | --service-model-invariant-id] [-q | --service-model-name] [-k | --service-model-uuid]
[-V | --verify] [-f | --format] [-h | --help]
[-t | --no-title] [-l | --cloud-region] [-v | --version]
[-y | --service-instance-id] [-z | --tenant-id] [-r | --requestor-id]
[-c | --vf-model-uuid] [-o | --instance-name] [-s | --long]
[-e | --vf-model-name] [-g | --vf-model-version] [-b | --vf-model-invariant-id]
[-n | --service-model-version] [-a | --no-auth] [-p | --host-password]
[-m | --host-url] [-i | --vf-model-customization-id] [-C | --no-catalog]
[-d | --debug] [-D | --context] [-w | --product-family]
[-u | --host-username]
where:
-j | --service-model-invariant-id model invariant id. It is of type STRING. By
default, it is .
-q | --service-model-name service model name. It is of type STRING. By
default, it is .
-k | --service-model-uuid model name version id. It is of type STRING. By
default, it is .
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-t | --no-title whether to print title or not. It is of type BOOL.
-l | --cloud-region cloud region identifier. It is of type STRING. By
default, it is .
-v | --version print service version. It is of type BOOL.
-y | --service-instance-id unique id for service instance. It is of type
STRING. By default, it is .
-z | --tenant-id openstack tenant id. It is of type STRING. By
default, it is .
-r | --requestor-id requestor ID. It is of type STRING. By default,
it is .
-c | --vf-model-uuid model uuid for vf. It is of type STRING. By
default, it is .
-o | --instance-name service instance name. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-e | --vf-model-name vf model name. It is of type STRING. By default,
it is .
-g | --vf-model-version vf model version. It is of type STRING. By
default, it is .
-b | --vf-model-invariant-id vf model invariant id. It is of type STRING. By
default, it is .
-n | --service-model-version service model version. It is of type STRING. By
default, it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-i | --vf-model-customization-id vf model customization id. It is of type STRING.
By default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-d | --debug Enable debug output. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-w | --product-family service type for serivce (e.g. vLB). It is of
type STRING. By default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
Results:
vf-id id for the created vnf and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[116] vnfm-create
usage: oclip vnfm-create
Register a VNFM in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-e | --vendor] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-y | --vnfm-id] [-c | --type] [-x | --vim-id]
[-s | --long] [-D | --context] [-j | --password]
[-b | --name] [-i | --username] [-u | --host-username]
[-g | --url] [-a | --no-auth] [-q | --vnfm-version]
[-z | --certificate-url] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-e | --vendor Onap VNFM vendor. It is of type STRING. By
default, it is .
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --vnfm-id Onap VNFM unique id. It is of type UUID.
-c | --type Onap VNFM type. It is of type STRING. By default,
it is .
-x | --vim-id Onap VIM unique id. It is of type UUID.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-j | --password Onap VNFM password. It is of type STRING. By
default, it is .
-b | --name Onap VNFM name. It is of type STRING. By default,
it is .
-i | --username Onap VNFM username. It is of type STRING. By
default, it is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-g | --url Onap VNFM URL. It is of type STRING. By default,
it is .
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-q | --vnfm-version Onap VNFM version. It is of type STRING. By
default, it is .
-z | --certificate-url Onap VNFM certificate-url. It is of type STRING.
It is optional. By default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[117] vnfm-delete
usage: oclip vnfm-delete
Un-register a VNFM in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-y | --resource-version]
[-x | --vnfm-id] [-s | --long] [-D | --context]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --resource-version Onap vim resource version. It is of type STRING.
It is optional. By default, it is .
-x | --vnfm-id Onap VNFM unique id. It is of type UUID.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[118] vnfm-list
usage: oclip vnfm-list
List the configured vnfm
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
vnfm-id Onap vnfm id and is of type STRING.
vim-id Onap vnfm id and is of type STRING.
certificate-url Onap vnfm certificate-url and is of type STRING.
resource-version Onap vnfm resource version and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[119] vnfm-show
usage: oclip vnfm-show
Show the VNFM in Onap
Product: onap-dublin Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --vnfm-id]
[-s | --long] [-D | --context] [-u | --host-username]
[-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --vnfm-id Onap VNFM unique id. It is of type UUID.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
name Onap vnfm name and is of type STRING.
type Onap vnfm type and is of type STRING.
vendor Onap vnfm vendor and is of type STRING.
version Onap vnfm version and is of type STRING.
url Onap vnfm url and is of type STRING.
username Onap vnfm username and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[120] vnftest-list
usage: oclip vnftest-list
Lists the VNF test cases in VNF Test Platform (VTP)
Product: onap-dublin Service: vtp Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
Results:
tescase Testcase name and is of type STRING.
testsuite Test suite name and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[121] vnftest-run
usage: oclip vnftest-run
Runs the VNF test cases in VNF Test Platform (VTP)
Product: onap-dublin Service: vtp Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-y | --param]
[-x | --name] [-s | --long] [-D | --context]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-y | --param VNFtest case name params, and can be repeated. It
is of type MAP. It is optional.
-x | --name VNFtest case name. It is of type STRING. By
default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
Results:
executionId Testcase execution Id and is of type STRING.
status Test status and is of type STRING.
startTime Testcase startTime and is of type STRING.
endTime Testcase endTime and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[122] vsp-add-artifact
usage: oclip vsp-add-artifact
Upload the CSAR/ZIP file to VSP
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --vsp-id]
[-s | --long] [-D | --context] [-y | --vsp-version]
[-z | --vsp-file]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --vsp-id Onap VSP ID. It is of type STRING. By default, it
is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-y | --vsp-version Onap VSP version. It is of type STRING. By
default, it is .
-z | --vsp-file CSAR File path. It is of type BINARY. By default,
it is .
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[123] vsp-create
usage: oclip vsp-create
Create Vendor Software Product
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-j | --vlm-feature-group-id] [-C | --no-catalog]
[-f | --format] [-h | --help] [-V | --verify]
[-t | --no-title] [-d | --debug] [-v | --version]
[-o | --onboarding-method] [-e | --vlm-vendor] [-x | --vsp-name]
[-y | --vsp-description] [-s | --long] [-D | --context]
[-i | --vlm-agreement-id] [-c | --vlm-version] [-u | --host-username]
[-a | --no-auth] [-g | --vlm-id] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-j | --vlm-feature-group-id Feature Group ID. It is of type STRING. By
default, it is .
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-o | --onboarding-method Method to be used for onboarding (Manual or
NetworkPackage). It is of type STRING. By
default, it is .
-e | --vlm-vendor License Model vendor. It is of type STRING. By
default, it is .
-x | --vsp-name Onap VSP Name. It is of type STRING. By default,
it is .
-y | --vsp-description Description for VSP. It is of type STRING. It is
optional. By default, it is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-i | --vlm-agreement-id License Agreement ID. It is of type STRING. By
default, it is .
-c | --vlm-version License version. It is of type STRING. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-g | --vlm-id License Model ID. It is of type STRING. By
default, it is .
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
ID VSP ID and is of type STRING.
version VSP Model version and is of type UUID.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[124] vsp-list
usage: oclip vsp-list
List of the Vendor Software Products
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-s | --long]
[-D | --context] [-u | --host-username] [-a | --no-auth]
[-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
ID VSP ID and is of type STRING.
name VSP Name and is of type STRING.
vendor-name Vendor name and is of type STRING.
version Version and is of type STRING.
status status and is of type STRING.
license-id license aggreement and is of type STRING.
license-version license version and is of type STRING.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[125] vsp-package
usage: oclip vsp-package
Package Vendor Software Product
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --vsp-id]
[-s | --long] [-D | --context] [-y | --vsp-version]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --vsp-id Onap VSP ID. It is of type STRING. By default, it
is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-y | --vsp-version VSP version. It is of type STRING. By default, it
is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[126] vsp-submit
usage: oclip vsp-submit
Submit Vendor Software Product
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --vsp-id]
[-s | --long] [-D | --context] [-y | --vsp-version]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --vsp-id Onap VSP ID. It is of type STRING. By default, it
is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-y | --vsp-version VSP version. It is of type STRING. By default, it
is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
[127] vsp-validate
usage: oclip vsp-validate
Validate the uploaded Vendor Software Product
Product: onap-dublin Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org
Options:
[-m | --host-url] [-C | --no-catalog] [-f | --format]
[-h | --help] [-V | --verify] [-t | --no-title]
[-d | --debug] [-v | --version] [-x | --vsp-id]
[-s | --long] [-D | --context] [-y | --vsp-version]
[-u | --host-username] [-a | --no-auth] [-p | --host-password]
where:
-m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
OPEN_CLI_HOST_URL.
-C | --no-catalog Whether to use given host-url directly or
discover it from catalog, it will override the
service->mode. It is of type BOOL. It is
optional.
-f | --format Output formats, supported formats such as table,
csv, json, yaml. It is of type STRING.
-h | --help print help message. It is of type BOOL.
-V | --verify Helps to verify the command using samples
provides under open-cli-samples directory. By
default, it goes with mock.To enable the
verification of samples in real time, set
DISABLE_MOCKING=true in the context parameter. It
is of type BOOL. It is optional.
-t | --no-title whether to print title or not. It is of type BOOL.
-d | --debug Enable debug output. It is of type BOOL.
-v | --version print service version. It is of type BOOL.
-x | --vsp-id Onap VSP ID. It is of type STRING. By default, it
is .
-s | --long whether to print all attributes or only short
attributes. It is of type BOOL.
-D | --context command context. It is of type MAP. It is
optional.
-y | --vsp-version VSP version. It is of type STRING. By default, it
is .
-u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
OPEN_CLI_HOST_USERNAME.
-a | --no-auth Whether to authenticate user or not. It is of
type BOOL.
-p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
OPEN_CLI_HOST_PASSWORD. Secured.
Results:
status Validation status and is of type STRING.
errors Validation messages and is of type JSON.
Error:
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
Command Samples
Following document provides the samples for every commands supported.
open-cli
schema-validate
input:
-l /tmp/hello-world.yaml
output:
+--------+--------+
|sl-no |error |
+--------+--------+
| | |
+--------+--------+
schema-refresh
output:
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|sl-no |command |product-version |schema |version |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|1 |vfmodule-create |onap-amsterdam |vfmodule-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|2 |schema-validate |open-cli |schema-validate.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|3 |schema-refresh |open-cli |schema-refresh.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|4 |cloud-list |onap-amsterdam |cloud-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|5 |sdnc-list |onap-amsterdam |sdnc-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|6 |sdnc-register |onap-amsterdam |sdnc-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|7 |sdnc-unregister |onap-amsterdam |sdnc-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|8 |vnfm-show |onap-amsterdam |vnfm-show-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|9 |vnfm-unregister |onap-amsterdam |vnfm-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|10 |vnfm-register |onap-amsterdam |vnfm-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|11 |vnfm-list |onap-amsterdam |vnfm-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|12 |vim-register |onap-amsterdam |vim-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|13 |vim-unregister |onap-amsterdam |vim-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|14 |vim-list |onap-amsterdam |vim-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|15 |ems-list |onap-amsterdam |ems-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|16 |ems-register |onap-amsterdam |ems-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|17 |ems-show |onap-amsterdam |ems-show-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|18 |cloud-delete |onap-amsterdam |cloud-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|19 |ems-unregister |onap-amsterdam |ems-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|20 |subscription-list |openecomp |subscription-list-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|21 |subscription-create |openecomp |subscription-create-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|22 |subscription-list |onap-amsterdam |subscription-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|23 |subscription-create |onap-amsterdam |subscription-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|24 |subscription-delete |onap-amsterdam |subscription-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|25 |customer-show |openecomp |customer-show-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|26 |customer-show |onap-amsterdam |customer-show-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|27 |customer-list |openecomp |customer-list-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|28 |customer-delete |openecomp |customer-delete-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|29 |customer-create |openecomp |customer-create-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|30 |customer-create |onap-amsterdam |customer-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|31 |customer-delete |onap-amsterdam |customer-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|32 |customer-list |onap-amsterdam |customer-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|33 |vf-list |onap-amsterdam |vf-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|34 |service-list |onap-amsterdam |service-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|35 |vf-show |onap-amsterdam |vf-show-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|36 |tenant-create |onap-amsterdam |tenant-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|37 |tenant-list |onap-amsterdam |tenant-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|38 |tenant-delete |onap-amsterdam |tenant-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|39 |service-type-create |openecomp |service-type-create-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|40 |service-type-list |onap-amsterdam |service-type-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|41 |service-type-create |onap-amsterdam |service-type-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|42 |service-type-delete |openecomp |service-type-delete-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|43 |service-type-list |openecomp |service-type-list-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|44 |service-type-delete |onap-amsterdam |service-type-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|45 |cloud-create |onap-amsterdam |cloud-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|46 |cloud-list |openecomp |cloud-list-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|47 |microservice-delete |onap-amsterdam |microservice-delete-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|48 |microservice-list |onap-amsterdam |microservice-list-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|49 |microservice-show |onap-amsterdam |microservice-show-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|50 |microservice-create |onap-amsterdam |microservice-create-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|51 |hello-world |sample-1.0 |hello-world.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|52 |hello-world-http |sample-1.0 |hello-world-http.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|53 |vlm-checkin |onap-amsterdam |vlm-checkin-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|54 |license-group-create |openecomp |license-group-create-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|55 |vlm-key-group-create |onap-amsterdam |vlm-key-group-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|56 |vlm-aggreement-list |onap-amsterdam |vlm-aggreement-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|57 |vlm-key-group-list |onap-amsterdam |vlm-key-group-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|58 |vlm-create |onap-amsterdam |vlm-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|59 |vlm-entitlement-pool-create |onap-amsterdam |vlm-entitlement-pool-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|60 |ep-show |openecomp |license-entitlement-pool-show-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|61 |license-model-create |openecomp |license-model-create-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|62 |license-group-show |openecomp |license-group-show-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|63 |vsp-upload |openecomp |vsp-upload-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|64 |vsp-package |onap-amsterdam |vsp-package-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|65 |vsp-submit |onap-amsterdam |vsp-submit-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|66 |vsp-checkout |onap-amsterdam |vsp-checkout-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|67 |vsp-create |openecomp |vsp-create-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|68 |vsp-list |openecomp |vsp-list-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|69 |vsp-show |onap-amsterdam |vsp-show-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|70 |vsp-show |openecomp |vsp-show-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|71 |vsp-submit |openecomp |vsp-submit-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|72 |vsp-create |onap-amsterdam |vsp-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|73 |vsp-add-artifact |onap-amsterdam |vsp-add-artifact-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|74 |vsp-revert |onap-amsterdam |vsp-revert-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|75 |vsp-checkin |openecomp |vsp-checkin-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|76 |vsp-checkout |onap-amsterdam |vsp-checkout-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|77 |vsp-validate |onap-amsterdam |vsp-validate-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|78 |vsp-list |onap-amsterdam |vsp-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|79 |vsp-checkin |onap-amsterdam |vsp-checkin-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|80 |service-model-checkin |onap-amsterdam |service-model-checkin-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|81 |service-model-distribute |onap-amsterdam |service-model-distribute-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|82 |service-model-list |onap-amsterdam |service-model-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|83 |service-model-certify-start |onap-amsterdam |service-model-certify-start-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|84 |service-model-add-vf |onap-amsterdam |service-model-add-vf-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|85 |service-model-certify-request |onap-amsterdam |service-model-certify-request-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|86 |service-model-revert |onap-amsterdam |service-model-checkout-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|87 |service-model-checkout |onap-amsterdam |service-model-revert-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|88 |service-model-certify-complete |onap-amsterdam |service-model-certify-complete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|89 |service2vf-model-list |onap-amsterdam |service2vf-model-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|90 |service-model-create |onap-amsterdam |service-model-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|91 |service-model-approve |onap-amsterdam |service-model-approve-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|92 |vf-model-create |onap-amsterdam |vf-model-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|93 |vf-model-checkin |onap-amsterdam |vf-model-checkin-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|94 |vlm-revert |onap-amsterdam |vlm-revert-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|95 |vlm-feature-group-create |onap-amsterdam |vlm-feature-group-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|96 |vlm-submit |onap-amsterdam |vlm-submit-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|97 |license-model-show |openecomp |license-model-show-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|98 |vf-model-certify-start |onap-amsterdam |vf-model-certify-start-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|99 |vf-model-list |onap-amsterdam |vf-model-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|100 |vlm-entitlement-pool-list |onap-amsterdam |vlm-entitlement-pool-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|101 |vlm-feature-group-list |onap-amsterdam |vlm-feature-group-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|102 |vlm-checkout |onap-amsterdam |vlm-checkout-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|103 |vlm-list |onap-amsterdam |vlm-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|104 |vlm-aggreement-create |onap-amsterdam |vlm-aggreement-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|105 |vf-model-certify-request |onap-amsterdam |vf-model-certify-request-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|106 |ep-create |openecomp |license-entitlement-pool-create-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|107 |vf2vfmodule-model-list |onap-amsterdam |vf2vfmodule-model-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|108 |vf-model-certify-complete |onap-amsterdam |vf-model-certify-complete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|109 |service-delete |onap-amsterdam |service-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|110 |vfmodule-delete |onap-amsterdam |vf-module-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|111 |vfmodule-create |onap-amsterdam |vfmodule-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|112 |service-create |onap-amsterdam |service-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|113 |vf-delete |onap-amsterdam |vf-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|114 |vf-create |onap-amsterdam |vf-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
onap-amsterdam
NOTE: EOL 01-Aug-2018
cloud-delete
input:
--cloud-name huawei-cloud-test --region-name bangalore-test --resource-version 1509027982352
cloud-create
input:
--cloud-name huawei-cloud --region-name bangalore
cloud-list
output:
+--------------+------------+------------------+
|cloud |region |resource-version |
+--------------+------------+------------------+
|huawei-cloud |bangalore |1509027332165 |
+--------------+------------+------------------+
|Rackspace |RegionOne |1508827902543 |
+--------------+------------+------------------+
vnfm-list
output:
+--------------------------------------+--------------------------------------+------------------+------------------+
|vnfm-id |vim-id |certificate-url |resource-version |
+--------------------------------------+--------------------------------------+------------------+------------------+
|c0ecd788-22f4-49a4-a969-68051cd517e7 |acc5e14e-1320-4ab5-97fe-b7cc82ad03f2 | |1509094328901 |
+--------------------------------------+--------------------------------------+------------------+------------------+
vnfm-unregister
input:
--vnfm-id c0ecd788-22f4-49a4-a969-68051cd517e7 --resource-version 1509094328901
vnfm-show
input:
--vnfm-id c0ecd788-22f4-49a4-a969-68051cd517e7
output:
+----------+------------------+
|property |value |
+----------+------------------+
|name |vnfm1 |
+----------+------------------+
|type |OpenStack |
+----------+------------------+
|vendor |ONAP |
+----------+------------------+
|version |1.0 |
+----------+------------------+
|url |http://10.0.1.1 |
+----------+------------------+
vnfm-register
input:
--vim-id acc5e14e-1320-4ab5-97fe-b7cc82ad03f2 --name vnfm1 --type OpenStack --vendor ONAP --vnfm-version 1.0 --url http://10.0.1.1 --username admin --password password
vim-list
input:
--cloud-name huawei-cloud --region-name bangalore --long
output:
+--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+
|vim-id |name |type |vendor |version |url |username |cloud-domain |default-tenant |resource-version |
+--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+
|acc5e14e-1320-4ab5-97fe-b7cc82ad03f2 |RegionOne |OpenStack |Devstack |newton |http://192.168.16.149/identity |onap |default |onap |1509093477505 |
+--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+
|810edb5a-42e9-462d-9587-96bc9272ac27 |vim1 |OpenStack |Devstack |newton |http://192.168.16.149/identity |onap |default |onap |1509093590932 |
+--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+
vim-register
input:
--cloud-name huawei-cloud --region-name bangalore --name vim1 --type OpenStack --vendor Devstack --vim-version newton --url http://192.168.16.149/identity --username onap --password onap --cloud-domain default --default-tenant onap
vim-unregister
input:
--vim-id 810edb5a-42e9-462d-9587-96bc9272ac27 --cloud-name huawei-cloud --region-name bangalore --resource-version 1509093590932
ems-register
input:
--name ems1 --type ems --vendor boco --ems-version 1.0 --url http://10.0.0.1 --username admin --password password --remote-path sample
ems-unregister
input:
--ems-id 51a480ed-649c-4c47-a84b-f966dc4f9554 --resource-version 1509095358658
ems-list
output:
+--------------------------------------+------------------+
|ems-id |resource-version |
+--------------------------------------+------------------+
|51a480ed-649c-4c47-a84b-f966dc4f9554 |1509095358658 |
+--------------------------------------+------------------+
ems-show
input:
--ems-id 51a480ed-649c-4c47-a84b-f966dc4f9554
output:
+------+------+--------+----------+------------------+
|name |type |vendor |version |url |
+------+------+--------+----------+------------------+
|ems1 |ems |boco |1.0 |http://10.0.0.1 |
+------+------+--------+----------+------------------+
subscription-delete
input:
--customer-name kanag --service-type vFW-kanag --resource-version 1509079144326
subscription-list
input:
--customer-name kanag
output:
+--------------+------------------+
|service-type |resource-version |
+--------------+------------------+
|vFW-kanag |1509079144326 |
+--------------+------------------+
subscription-create
input:
--customer-name kanag --cloud-name huawei-cloud --cloud-region bangalore --cloud-tenant-id e18173e6-6a13-4614-a13c-3859e7321103 --service-type vFW-kanag
customer-delete
input:
--customer-name test --resource-version 1509029022293
customer-show
input:
--customer-name kanag --long
output:
+--------+------------------+------------------+------------------+
|name |subscriber-name |resource-version |subscriber-type |
+--------+------------------+------------------+------------------+
|kanag |kanag |1509029007060 |INFRA |
+--------+------------------+------------------+------------------+
customer-create
input:
--customer-name test --subscriber-name test
customer-list
output:
+----------------+------------------+
|name |resource-version |
+----------------+------------------+
|test |1509029022293 |
+----------------+------------------+
|kanag |1509029007060 |
+----------------+------------------+
|Demonstration |1508827908763 |
+----------------+------------------+
vf-show
input:
--vf-id 1a667ce8-8b8b-4f59-ba5c-b162ae462fef -m https://192.168.17.111:8443 -u AAI -p AAI
output:
+------------------------+--------------------------------------+
|property |value |
+------------------------+--------------------------------------+
|vf-id |1a667ce8-8b8b-4f59-ba5c-b162ae462fef |
+------------------------+--------------------------------------+
|vf-name |vlb-cli-sample-8 |
+------------------------+--------------------------------------+
|vf-type |demoVLB/null |
+------------------------+--------------------------------------+
|model-invariant-id |cc34cd54-dd7c-44cd-8847-f9577c6f1a49 |
+------------------------+--------------------------------------+
|model-uuid |8b1f63f3-e0cc-4c27-8903-fafe2f25bfbe |
+------------------------+--------------------------------------+
|model-customization-id |cf893f5a-1bb1-4e32-a92b-2456e12178f8 |
+------------------------+--------------------------------------+
|service-id |2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee |
+------------------------+--------------------------------------+
service-list
input:
-x Demonstration -y vLB --long
output:
+--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+
|service-id |service-name |model-invariant-id |model-uuid |description |
+--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+
|1db042a9-6b28-4290-baba-872d32eeecf2 |sample-instance |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | |
+--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+
|9244629b-4ae4-48a0-bac0-b76937105ec7 |demo-vlb-vid |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | |
+--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+
|912d6d8d-9534-41d0-9323-289e81d4e399 |sample-instance-3 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | |
+--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+
|26b4ea72-d119-4345-95c8-568b08a093aa |sample-service-onap-cli-2 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | |
+--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+
|b2ebdb88-cfa5-496f-93a5-d535accbf56a |sample-instance-1 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | |
+--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+
|01eb6e59-5c28-4c76-85c7-a6b1e48058b9 |sample-service-onap-cli-4 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | |
+--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+
|03acb854-647b-4cf9-bfd8-a76083bb7266 |sample-service-onap-cli-3 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | |
+--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+
|14a9d485-63de-4ce2-b763-133ec3ce3d23 |sample-service-onap-cli-8 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | |
+--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+
|fdb98970-9de8-48a3-a321-d02693d2d1ad |sample-service-onap-cli-9 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | |
+--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+
|50de14d5-73d6-458e-880e-de8278b6f944 |test |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | |
+--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+
|2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee |sample-instance-cli-10 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | |
+--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+
|4415727d-dc2a-4378-a3a7-bc4411d391c7 |sample-service-onap-cli-5 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | |
+--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+
vf-list
input:
-x Demonstration -y vLB --service-id 2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee
output:
+--------------------------------------+--------------------+
|vf-id |vf-name |
+--------------------------------------+--------------------+
|1a667ce8-8b8b-4f59-ba5c-b162ae462fef |vlb-cli-sample-8 |
+--------------------------------------+--------------------+
|048c2c4a-ee30-41a1-bb55-c4e7fe1a9a0d |vlb-cli-sample-11 |
+--------------------------------------+--------------------+
|c37c401f-a839-4b6e-9c65-33e023c412ee |vlb-cli-sample-10 |
+--------------------------------------+--------------------+
|b544f164-97c9-483a-98eb-eafd1f808e79 |vlb-cli-sample-5 |
+--------------------------------------+--------------------+
|5ef95bd9-4d7a-4d06-879e-0c7964f9de65 |vlb-cli-sample-4 |
+--------------------------------------+--------------------+
|eb29edb5-0a9f-4bc6-a7bf-3211341fffc2 |vlb-cli-sample-9 |
+--------------------------------------+--------------------+
|2a152730-f6eb-4dc6-9b81-7a6f6f263d71 |vlb-cli-sample-1 |
+--------------------------------------+--------------------+
|f53cd512-e172-410e-87b4-37064b5b5f8c |vlb-cli-sample-7 |
+--------------------------------------+--------------------+
|f4bfcd6a-2ea1-42ab-853a-5d863b150c40 |vlb-cli-sample-3 |
+--------------------------------------+--------------------+
|4bb4beaa-5b6b-414e-97d8-53949bbb5c5e |vlb-cli-sample-6 |
+--------------------------------------+--------------------+
service-type-list
output:
+--------------------------------------+--------------+------------------+
|service-type-id |service-type |resource-version |
+--------------------------------------+--------------+------------------+
|2733fe6f-8725-48fa-8609-092a34106dba |vIMS |1508827920395 |
+--------------------------------------+--------------+------------------+
|bc549d9d-2335-4b07-9f03-3a85439c0bbb |vFW-kanag |1509029699189 |
+--------------------------------------+--------------+------------------+
|de1fa33f-f676-42e5-b79a-a39825c19b1d |test |1509029708094 |
+--------------------------------------+--------------+------------------+
|1482d2f2-b9e6-4421-a2f6-31959278db6f |vCPE |1508827919819 |
+--------------------------------------+--------------+------------------+
|4426c557-e012-47eb-85cc-6128fa4f55c1 |vLB |1508827918467 |
+--------------------------------------+--------------+------------------+
|dd04cc4b-6283-480d-8c5a-2c7bba8497ea |vFW |1508827917148 |
+--------------------------------------+--------------+------------------+
service-type-delete
input:
--service-type-id de1fa33f-f676-42e5-b79a-a39825c19b1d --resource-version 1509029708094
service-type-create
input:
--service-type test
microservice-create
input:
--service-name test --service-version v1 --service-url /test --path /test 10.0.0.1 8080
output:
+----------+--------------+
|property |value |
+----------+--------------+
|name |test |
+----------+--------------+
|version |v1 |
+----------+--------------+
|url |/test |
+----------+--------------+
|status |1 |
+----------+--------------+
microservice-list
input:
--long
output:
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|name |version |url |status |nodes |enable-ssl |path |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-actions |v11 |/aai/v11/actions |1 |10.0.1.1:8443 |true | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-actions-deprecated |v11 |/aai/v11/actions |1 |10.0.1.1:8443 |true |/aai/v11/actions |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-business |v11 |/aai/v11/business |1 |10.0.1.1:8443 |true | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-business-deprecated |v11 |/aai/v11/business |1 |10.0.1.1:8443 |true |/aai/v11/business |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-cloudInfrastructure |v11 |/aai/v11/cloud-infrastructure |1 |10.0.1.1:8443 |true | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-cloudInfrastructure-deprecated |v11 |/aai/v11/cloud-infrastructure |1 |10.0.1.1:8443 |true |/aai/v11/cloud-infrastructure |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-esr-gui |v1 |/esr-gui |1 |10.0.14.1:9519 |false |/iui/aai-esr-gui |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-esr-server |v1 |/api/aai-esr-server/v1 |1 |172.17.0.5:9518 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-externalSystem |v11 |/aai/v11/external-system |1 |10.0.14.1:9518 |true | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-externalSystem-deprecated |v11 |/aai/v11/external-system |1 |10.0.1.1:8443 |true |/aai/v11/external-system |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-network |v11 |/aai/v11/network |1 |10.0.1.1:8443 |true | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-network-deprecated |v11 |/aai/v11/network |1 |10.0.1.1:8443 |true |/aai/v11/network |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-search |v11 |/aai/v11/search |1 |10.0.1.1:8443 |true | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-search-deprecated |v11 |/aai/v11/search |1 |10.0.1.1:8443 |true |/aai/v11/search |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-service-design-and-creation |v11 |/aai/v11/service-design-and-creation |1 |10.0.1.1:8443 |true | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|aai-service-design-and-creation-deprecated |v11 |/aai/v11/service-design-and-creation |1 |10.0.1.1:8443 |true |/aai/v11/service-design-and-creation |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|activiti |v1 |/api/activiti/v1 |1 |10.0.1.1:8443 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|activiti-rest |v1 |/activiti-rest |1 |10.0.14.1:8804 |false |/activiti-rest |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|catalog |v1 |/api/catalog/v1 |1 |10.0.14.1:8804 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|emsdriver |v1 |/api/emsdriver/v1 |1 |172.17.0.15:8806 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|gvnfmdriver |v1 |/api/gvnfmdriver/v1 |1 |10.0.14.1:8806 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|huaweivnfmdriver |v1 |/api/huaweivnfmdriver/v1 |1 |10.0.14.1:8206 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|jujuvnfmdriver |v1 |/api/jujuvnfmdriver/v1 |1 |172.17.0.17:8484 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|multicloud |v0 |/api/multicloud/v0 |1 |10.0.14.1:8484 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|multicloud-ocata |v0 |/api/multicloud-ocata/v0 |1 |10.0.14.1:8482 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|multicloud-titanium_cloud |v0 |/api/multicloud-titanium_cloud/v0 |1 |10.0.14.1:8483 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|multicloud-vio |v0 |/api/multicloud-vio/v0 |1 |10.0.14.1:9001 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|nokia-vnfm-driver |v1 |/api/nokiavnfmdriver/v1 |1 |10.0.14.1:9006 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|nokiavnfmdriver |v1 |/api/nokiavnfmdriver/v1 |1 |10.0.14.1:9005 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|nslcm |v1 |/api/nslcm/v1 |1 |10.0.14.1:9004 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|policy-pdp |v1 |/pdp |1 |172.17.0.27:8486 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|policy-pdp-deprecated |v1 |/pdp |1 |10.0.14.1:8485 |false |/pdp |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|portal |v2 |/ |1 |172.17.0.20:8403 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|resmgr |v1 |/api/resmgr/v1 |1 |10.0.14.1:8403 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|sdc |v1 |/sdc/v1 |1 |10.0.6.1:8081 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|sdc-deprecated |v1 |/sdc/v1 |1 |10.0.6.1:8081 |false |/sdc/v1 |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|sdnc |v1 |/restconf |1 |10.0.9.1:8989 |false |/restconf |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|so |v1 |/ecomp/mso/infra |1 |10.0.14.1:8480 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|so-deprecated |v1 |/ecomp/mso/infra |1 |10.0.3.1:8080 |false |/ecomp/mso/infra |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|usecase-ui |v1 |/usecase-ui |1 |10.0.3.1:8080 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|usecaseui |v1 |/api/usecaseui/server/v1 |1 |10.0.7.1:8282 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|usecaseui-gui |v1 |/iui/usecaseui |1 |10.0.5.1:8080 |false |/iui/usecaseui |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|vnflcm |v1 |/api/vnflcm/v1 |1 |10.0.5.1:8080 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|vnfmgr |v1 |/api/vnfmgr/v1 |1 |172.17.0.11:8080 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|vnfres |v1 |/api/vnfres/v1 |1 |10.0.14.1:8901 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|workflow |v1 |/api/workflow/v1 |1 |10.0.14.1:8900 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|ztesdncdriver |v1 |/api/ztesdncdriver/v1 |1 |10.0.14.1:8801 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
|ztevmanagerdriver |v1 |/api/ztevmanagerdriver/v1 |1 |172.17.0.22:8801 |false | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
| | | | |172.17.0.23:8803 | | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
| | | | |10.0.14.1:8803 | | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
| | | | |172.17.0.24:8802 | | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
| | | | |10.0.14.1:8802 | | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
| | | | |10.0.14.1:8805 | | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
| | | | |172.17.0.25:8411 | | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
| | | | |10.0.14.1:8411 | | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
| | | | |10.0.14.1:8410 | | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
| | | | |172.17.0.26:8410 | | |
+--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+
microservice-show
input:
--service-name test --service-version v1 --long
output:
+------------+----------------+
|property |value |
+------------+----------------+
|name |test |
+------------+----------------+
|version |v1 |
+------------+----------------+
|url |/test |
+------------+----------------+
|status |1 |
+------------+----------------+
|nodes |10.0.0.1:8080 |
+------------+----------------+
|enable-ssl |false |
+------------+----------------+
|path |/test |
+------------+----------------+
microservice-delete
input:
--service-name test --service-version v1 --host-url http://192.168.17.23:80 --node-ip 23.14.15.156 --node-port 80
vlm-feature-group-list
input:
--vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0
output:
+----------------------------------+--------------+
|ID |name |
+----------------------------------+--------------+
|3a2fb75b52a54e9c8093e7c154210f9e |kanag-cli-fg |
+----------------------------------+--------------+
vlm-submit
input:
--vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 1.1
vlm-revert
input:
--vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 0.1
vlm-entitlement-pool-list
input:
--vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0
output:
+----------------------------------+--------------------------+
|ID |name |
+----------------------------------+--------------------------+
|dae0a02f2173444e82bfa765601abcc9 |797153a1-d8f6-4eb0-abfc |
+----------------------------------+--------------------------+
|aa61080fd965455ba5edbf60f4e375ef |kanag-cli-ep |
+----------------------------------+--------------------------+
vlm-checkout
input:
--vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 0.1
vlm-aggreement-create
input:
--name kanag-cli-la --description kanag cli la --vlm-feature-group-id 3a2fb75b52a54e9c8093e7c154210f9e --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 1.1
output:
+----------+----------------------------------+
|property |value |
+----------+----------------------------------+
|ID |77e151d0503b45ecb7e40f5f5f1a887e |
+----------+----------------------------------+
vlm-key-group-create
input:
--vlm-id cf2d907d998e44698ce3b4cded5f66a7 --name kanag-cli-kg --description Kanag CLI key group -d --vlm-version 0.1
output:
|property |value |
+----------+----------------------------------+
|ID |c37a1f205f444161a573f55dfec5f170 |
+----------+----------------------------------+
vlm-feature-group-create
input:
--name kanag-cli-fg --description Kanag cli feature group --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 0.1 --vlm-key-group-id c37a1f205f444161a573f55dfec5f170 --vlm-entitle-pool-id aa61080fd965455ba5edbf60f4e375ef --part-number 123455 --manufacture-reference-number mkr123456
output:
+----------+----------------------------------+
|property |value |
+----------+----------------------------------+
|ID |3a2fb75b52a54e9c8093e7c154210f9e |
+----------+----------------------------------+
vlm-create
input:
--vendor-name kanag-cli --description First License created from CLI
output:
+----------+----------------------------------+
|property |value |
+----------+----------------------------------+
|ID |cf2d907d998e44698ce3b4cded5f66a7 |
+----------+----------------------------------+
vlm-entitlement-pool-create
input:
--name kanag-cli-ep --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --description kanag vlm ep --manufacture-reference-number mkr123456 -d --vlm-version 0.1
output:
+----------+----------------------------------+
|property |value |
+----------+----------------------------------+
|ID |aa61080fd965455ba5edbf60f4e375ef |
+----------+----------------------------------+
vlm-checkin
input:
--vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 1.1
vlm-key-group-list
input:
--vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0
output:
+----------------------------------+----------------------+
|ID |name |
+----------------------------------+----------------------+
|c37a1f205f444161a573f55dfec5f170 |kanag-cli-kg |
+----------------------------------+----------------------+
|f0a684fa680b44979edee03fcc12ca85 |kanag-cli-key-group |
+----------------------------------+----------------------+
vlm-aggreement-list
input:
--vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0
output:
+----------------------------------+--------------+
|ID |name |
+----------------------------------+--------------+
|1e2edfccaca847f896070d0fac26667a |sf |
+----------------------------------+--------------+
|77e151d0503b45ecb7e40f5f5f1a887e |kanag-cli-la |
+----------------------------------+--------------+
vlm-list
input:
--long
output:
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|id |vendor-name |vlm-version |status |description |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|b5ea95a60e3b483da03d0911968cd778 |ciLicensef008e06a |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|84352b5d014c4d5382ce856d7597aebf |ciLicense5c11752c |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|8e13a8b2e1f34374ad578edc9c912f11 |ciLicenseaf880546 |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|9f7053ae1aa04b8c9fa3d991f944a49b |ciLicensecce293bb |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|3f47950121bf4e31a058b4870020bc2f |ciLicense7d28e221 |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|6fc132eca87d4e49b56357b9d83843a5 |ciLicense02ddba7e |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|0094601590ec4e709e560e928c44232a |ciLicense9acc959f |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|8f82813eb6304957911955e077d9be6f |ciLicensee5394ee2 |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|b620898b5e5e4231a30a2ccecd39927e |ciLicense3eed3665 |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|12cce4998b874d5e8096070f9c5d7395 |ciLicense372060ea |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|78fd596a39534d51953e867adaef78f6 |ciLicense36e962a4 |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|651180d666c54887880b673884e03481 |ciLicensef9a1b52b |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|dd10e18e3af54234a20897ad65bfa311 |ciLicense76f62092 |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|cf2d907d998e44698ce3b4cded5f66a7 |kanag-cli |2.0 |Final |First License created from CLI |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|144497a1b7924e0fa73004573730e1b8 |Test |0.1 |Locked |test |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|9af398f516da4e63b4ec8d344866533b |4718de22-00d3-4607-b666 |1.0 |Final |vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|1173c7be5fea4db799b1a5ef9512e57e |Kanag |4.0 |Final |Kanagaraj M @ HTIPL |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|fc0fdcc825a54ca3b08e40f473b72d05 |test-vendor |1.0 |Final |test |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|b66c5e1b4af3432ca2f6cd05adf72340 |0138a2e2-52bf-4f0b-81cd |1.0 |Final |vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|34c2c72e992742e3b7ceb78bfcd21ebb |48fa02ef-e79b-4707-895e |1.0 |Final |vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|4bbd11c581ce4bb187a0a37131e5bb60 |1e5d1422-1f5f-42fe-a98e |1.0 |Final |vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|1329476d73014587839fd3ede08c3103 |3029be5e-9135-4083-bd2e |1.0 |Final |vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|2ca684a9805b40f9993239e77b82fb52 |c6ba2ef6-fe82-4f32-ad50 |1.0 |Final |vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|1a49df7b78654777a71f64f2c6c2468f |01eb54a1-f1ff-41a2-aafc |1.0 |Final |vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|5e571e8a25c8404da04f2a0ec179f576 |a920b10d-c516-4380-835a |1.0 |Final |vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|4b1e1efd8bb944bdbc0c3e74a9402967 |ciLicense7d8bbcab |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|816c04fd4ee849f2b80435e0944189fa |ciLicense09c55d35 |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|9408208f5b6d4eb997dff1b901f1fb95 |ciLicense6bfd9421 |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|eda4e9d1cae14cad95befc1728629574 |ciLicense81acf730 |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|022140c2dc4e40bbae096aa1fb5cfbe9 |ciLicensef3f5a4fa |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|19f92b345cae423ab4ea6c5527d55ef6 |ciLicense9fddd8db |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|492d9259fc3e493d8fa6afd488054508 |ciLicense9a46fd22 |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|a5da3e50ed72483fbfb134bac84b31f6 |ciLicensed955b6d7 |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
|9ff65b0b943141a7b99481bbcaedc294 |ciLicensef21d8db3 |1.0 |Final |new vendor license model |
+----------------------------------+--------------------------+--------------+--------+--------------------------------+
vsp-show
input:
--vsp-id a8cd007fa101470e98516cd4549c568f --vsp-version 1.0 --long
output:
+--------------+----------------------------------+
|property |value |
+--------------+----------------------------------+
|name |847cb26a-59a6-475a-94dd |
+--------------+----------------------------------+
|ID |a8cd007fa101470e98516cd4549c568f |
+--------------+----------------------------------+
|description |vendor software product |
+--------------+----------------------------------+
|vendor-name |01eb54a1-f1ff-41a2-aafc |
+--------------+----------------------------------+
|vendor-id |1a49df7b78654777a71f64f2c6c2468f |
+--------------+----------------------------------+
|version |1.0 |
+--------------+----------------------------------+
|status |Final |
+--------------+----------------------------------+
|license-id |99e3783033de443db69d05996341e28d |
+--------------+----------------------------------+
vsp-checkin
input:
--vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1
vsp-submit
input:
--vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1
vsp-create
input:
--vsp-name kanag-cli-VLB --vsp-description VLB created from CLI --vlm-agreement-id 77e151d0503b45ecb7e40f5f5f1a887e --vlm-version 2.0 --vlm-feature-group-id 3a2fb75b52a54e9c8093e7c154210f9e --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-vendor Kanag-cli
output:
+----------+----------------------------------+
|property |value |
+----------+----------------------------------+
|ID |f19cad8343794e93acb9cda2e4126281 |
+----------+----------------------------------+
vsp-list
output:
+----------------------------------+----------------------------------------------------+----------+------------+
|ID |name |version |status |
+----------------------------------+----------------------------------------------------+----------+------------+
|f19cad8343794e93acb9cda2e4126281 |kanag-cli-VLB |2.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|ff5bba2672a44654b186d70cf6bc9d95 |kanagVLB |0.1 |Locked |
+----------------------------------+----------------------------------------------------+----------+------------+
|aa1f969cf1ae4897aed5fe08d4d19a5a |ciVFOnboarded-vCSCF_aligned-08dc1256 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|f22e285e6b354033bd9a2c1cf9268a6e |ciVFOnboarded-Huawei_vMME-2b29f653 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|3430c70e504c45d59cd7ccb4a388f26d |ciVFOnboarded-Huawei_vPCRF_aligned_fixed-51f1da14 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|c1ec9ea4fbd240cd9e69070a7ac17ee8 |ciVFOnboarded-vSBC_aligned-7260da5f |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|4668d80cbca64beb98423c924b35d3ac |ciVFOnboarded-Huawei_vHSS-79402346 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|10e8667c8b3d4e86a406e806430b989e |ciVFOnboarded-vLB-6265cbc3 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|9de86126015f4349a41e5a5f5e3eacf4 |ciVFOnboarded-base_vfw-199667fb |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|9641f81b61504fa8af6885818b1ee34b |ciVFOnboarded-vgmux-a195f793 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|dea92da0ad90419c8f437222680a2333 |ciVFOnboarded-vgw-abaa9d6d |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|9e4654364fe04d9ebe2a2485d67d6676 |ciVFOnboarded-infra-fceb5908 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|93b5df6c2f3d4a7dae362b111b0ed047 |ciVFOnboarded-vbrgemu-bcfb002c |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|9c9a9000fc714e9d8a6baf495418ab96 |ciVFOnboarded-base_vvg-07839bb9 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|63898b542cdd46b6b15ac771abda86cb |ciVFOnboarded-vbng-008f4205 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|5ca119e2326045d1857ae3f04a816434 |kanag-cli-vfw |0.2 |Available |
+----------------------------------+----------------------------------------------------+----------+------------+
|e65baf44883e4868ba96f9faed9ba97a |600a2ebf-1f94-4a4c-b18d |0.3 |Available |
+----------------------------------+----------------------------------------------------+----------+------------+
|61bad2139ee742cf891ca6ecc5f39972 |test-vsp-123 |0.2 |Locked |
+----------------------------------+----------------------------------------------------+----------+------------+
|77527347f94947589431cb7c1938da2e |05a0dd09-c3d0-4534-93ab |0.3 |Locked |
+----------------------------------+----------------------------------------------------+----------+------------+
|8f08a17b9a4c4538b51a3064468baec0 |test-vsp |0.3 |Locked |
+----------------------------------+----------------------------------------------------+----------+------------+
|b1caa2ec31ba4b738cbe5aab362b35aa |Kanag-VSP |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|03774c7cfcac4054bdab346142214533 |ef35d3c9-a8c6-457c-a115 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|54bc478b7a9847db82156edad5d1f79f |5d11dda4-fb32-4df6-86eb |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|5f5121f701df4fe588c966002a342fdf |136ab241-88ff-443a-88e8 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|0cefd6ef5ad84d2995d66d0a24d2e92e |8fd2e5c8-981d-4a14-ba77 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|c212437049004e74b4ef0afb25ba41b8 |74361ede-ef8c-43f1-9d82 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|a8cd007fa101470e98516cd4549c568f |847cb26a-59a6-475a-94dd |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|59c07e069c7642e9afbc6117965a6c2f |ciVFOnboarded-vLB-3fbbe6d0 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|65b7b4b564f34b5689b3786386600e5a |ciVFOnboarded-vCSCF_aligned-a5e83f2c |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|a75d123c802e465db80ae7c8e5a0b4d0 |ciVFOnboarded-base_vfw-548fb561 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|1f33fcc682cb484a952b96326f549aff |ciVFOnboarded-vgmux-5e7cab8c |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|bafdf7192a73436588044296aa225ed4 |ciVFOnboarded-vgw-8b2ea35e |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|c34167a92e5c4c3392badd5a2da2a267 |ciVFOnboarded-infra-0766a3d1 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|b160564a4b754a9e8a19d2fa924f3f96 |ciVFOnboarded-vbrgemu-806fb59e |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|c5ccbc48510240318b698a4f1e1cb620 |ciVFOnboarded-vbng-c9fa1c07 |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
|34ac9b3e990f4ce093d2dd1b8e0f73d6 |ciVFOnboarded-base_vvg-e8b8c6ca |1.0 |Final |
+----------------------------------+----------------------------------------------------+----------+------------+
vsp-upload
input:
--vsp-id E563CB23A6BE49AF9A84CF579DAFB929 --vsp-file /home/user/vFW.zip
vsp-package
input:
--vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.2
vsp-checkout
input:
--onap-username cs0008 --onap-password demo123456! --host-url http://localhost:8080 --vsp-id E563CB23A6BE49AF9A84CF579DAFB929
vsp-validate
input:
--vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1
output:
+----------+----------------------------------------------------+
|property |value |
+----------+----------------------------------------------------+
|status |Success |
+----------+----------------------------------------------------+
|errors |{dnsscaling.yaml=[{"level":"WARNING","message":"WA |
| |RNING: Port 'Fixed_IPS' Parameter Name not |
| |aligned with Guidelines, Parameter Name |
| |[vlb_private_net_id], Resource ID |
| |[vdns_2_private_0_port]. As a result, VF\/VFC |
| |Profile may miss this information"},{"level":"WARN |
| |ING","message":"WARNING: Port 'Fixed_IPS' |
| |Parameter Name not aligned with Guidelines, |
| |Parameter Name [onap_private_subnet_id], Resource |
| |ID [vdns_2_private_1_port]. As a result, VF\/VFC |
| |Profile may miss this information"},{"level":"WARN |
| |ING","message":"WARNING: Nova Server naming |
| |convention in image, flavor and name properties |
| |is not consistent, Resource ID [vdns_2]"}], base_v |
| |lb.yaml=[{"level":"WARNING","message":"WARNING: |
| |Port 'Fixed_IPS' Parameter Name not aligned with |
| |Guidelines, Parameter Name |
| |[onap_private_subnet_id], Resource ID |
| |[vlb_private_1_port]. As a result, VF\/VFC |
| |Profile may miss this information"},{"level":"WARN |
| |ING","message":"WARNING: Port 'Fixed_IPS' |
| |Parameter Name not aligned with Guidelines, |
| |Parameter Name [onap_private_subnet_id], Resource |
| |ID [vdns_private_1_port]. As a result, VF\/VFC |
| |Profile may miss this information"},{"level":"WARN |
| |ING","message":"WARNING: Port 'Fixed_IPS' |
| |Parameter Name not aligned with Guidelines, |
| |Parameter Name [onap_private_subnet_id], Resource |
| |ID [vpg_private_1_port]. As a result, VF\/VFC |
| |Profile may miss this information"},{"level":"WARN |
| |ING","message":"WARNING: A resource is connected |
| |twice to the same network role, Network Role |
| |[vdns_0], Resource ID [onap_private]"},{"level":"W |
| |ARNING","message":"WARNING: Nova Server naming |
| |convention in image, flavor and name properties |
| |is not consistent, Resource ID |
| |[vdns_0]"},{"level":"WARNING","message":"WARNING: |
| |Missing Nova Server Metadata property, Resource |
| |ID |
| |[vpg_0]"},{"level":"WARNING","message":"WARNING: |
| |A resource is connected twice to the same network |
| |role, Network Role [vpg_0], Resource ID [onap_priv |
| |ate]"},{"level":"WARNING","message":"WARNING: |
| |Nova Server naming convention in image, flavor |
| |and name properties is not consistent, Resource |
| |ID [vpg_0]"}]} |
+----------+----------------------------------------------------+
vsp-revert
input:
--vsp-id e65baf44883e4868ba96f9faed9ba97a --vsp-version 0.2
vsp-checkout
input:
--vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1
service-model-checkin
input:
--service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584
service-model-certify-request
input:
--service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584
service2vf-model-list
input:
--service-model-id 0f4203a8-a314-47bb-9a7d-28157652cec4
output:
+--------------------------------------+--------------------------+--------------------------------------+------------+
|vf-uuid |vf-name |vf-customization-uuid |vf-version |
+--------------------------------------+--------------------------+--------------------------------------+------------+
|047b9ff8-2414-45b7-b753-26342369f160 |847cb26a-59a6-475a-94dd |cf893f5a-1bb1-4e32-a92b-2456e12178f8 |1.0 |
+--------------------------------------+--------------------------+--------------------------------------+------------+
service-model-certify-start
input:
--service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584
service-model-add-vf
input:
--service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 --vf-id 828be6cf-c11b-4759-ac37-b1b79f86a4b4 --vf-name kanag-cli-VLB --vf-version 1.0 -d
output:
+----------+----------------------------------------------------+
|property |value |
+----------+----------------------------------------------------+
|ID |7b427dbf-685b-4ba9-8838-a9b3b3c8e584.828be6cf-c11b |
| |-4759-ac37-b1b79f86a4b4.kanagclivlb0 |
+----------+----------------------------------------------------+
service-model-certify-complete
input:
--service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584
service-model-list
output:
+--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+
|uuid |invariant-uuid |name |version |status |distribution-status |
+--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+
|0f4203a8-a314-47bb-9a7d-28157652cec4 |1de901ed-17af-4b03-bc1f-41659cfa27cb |demoVLB |1.0 |CERTIFIED |DISTRIBUTED |
+--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+
|5ca7c6cb-78dc-4cf5-ab02-52c9ffb8c884 |9288833a-5dd6-4f9d-84ff-b34de06011c6 |kanagVLB |0.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED |
+--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+
|75caf010-9f14-424d-93c4-9f8fe8be7970 |b51013b7-e2bb-4abb-8f45-8e32113264b3 |demoVFW |1.0 |CERTIFIED |DISTRIBUTION_APPROVED |
+--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+
|fa9d6078-2d59-4c03-b97e-b57436680513 |5790901b-c109-4fc3-947a-ab71aa064251 |vLB-kanag |0.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED |
+--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+
|ba5a19b1-3219-4f30-bfd3-3b2f700c0157 |c4425f23-fc9a-4cbf-a3b7-12e69054806b |kanag-cli-VLB |1.0 |CERTIFIED |DISTRIBUTION_APPROVED |
+--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+
|5b054e09-9cc3-49bd-8962-e014465e295b |3a6a08c8-9bbe-4650-a1c5-687fb1012b98 |Kanag-vFW-Service |1.0 |CERTIFIED |DISTRIBUTED |
+--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+
|c9aa6a9c-dddd-4019-8f7b-70c09de68e96 |dd04c1c2-beb2-4b6c-997d-c94fae54fb57 |demoVCPE |1.0 |CERTIFIED |DISTRIBUTED |
+--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+
|f2a9f7e3-ead9-4585-8f5f-665acc6cff1c |b51013b7-e2bb-4abb-8f45-8e32113264b3 |demoVFW |1.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED |
+--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+
|d2df45ed-89c1-4d23-a605-bae03ee1f14f |566c6ab2-f32e-4022-acd3-cf2bf17ae6fc |a6484bba-671f-49c2-92fc |0.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED |
+--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+
service-model-create
input:
--name kanag-cli-VLB --description VLB created from CLI --project-code kanag-123456
output:
+----------+--------------------------------------+
|property |value |
+----------+--------------------------------------+
|ID |7b427dbf-685b-4ba9-8838-a9b3b3c8e584 |
+----------+--------------------------------------+
service-model-distribute
input:
--service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584
vf2vfmodule-model-list
input:
--vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff
output:
+----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+
|vsp-uuid |vsp-version |module-uuid |module-invariant-uuid |module-name |module-version |
+----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+
|f19cad8343794e93acb9cda2e4126281 |2.0 |f2fbc712-7adc-4a62-aa24-485ae076bdc7 |a610a6b9-adfb-4f9f-ada2-c054194092ad |KanagCliVlb..base_vlb..module-0 |1 |
+----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+
| | |c420e361-900a-4705-9329-868e7fa6d9a5 |cde91552-bdb8-4cae-b4c2-c63069d77fe1 |KanagCliVlb..dnsscaling..module-1 |1 |
+----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+
vf-model-certify-request
input:
--vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff
vf-model-create
input:
--name kanag-cli-VLB --description VF created from CLI --vendor-name Kanag-cli --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 2.0
output:
+----------+--------------------------------------+
|property |value |
+----------+--------------------------------------+
|ID |66269482-0b27-40e3-9c4d-6a26fb67d9ff |
+----------+--------------------------------------+
vf-model-certify-start
input:
--vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff
vf-model-list
output:
+--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
|uuid |uniqueid |invariant-uuid |name |version |status |
+--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
|9859e26c-2af2-427b-a837-04a47996d52a |dac5b070-e53b-44b3-8034-46c9cf797de3 |d3d50449-a81a-497f-97b3-4eb770ea67e7 |Kanag-VSP |1.0 |CERTIFIED |
+--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
|8b1f63f3-e0cc-4c27-8903-fafe2f25bfbe |047b9ff8-2414-45b7-b753-26342369f160 |cc34cd54-dd7c-44cd-8847-f9577c6f1a49 |847cb26a-59a6-475a-94dd |1.0 |CERTIFIED |
+--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
|46c89121-b37f-4192-8841-25c93165b843 |828be6cf-c11b-4759-ac37-b1b79f86a4b4 |2d455337-57eb-4edf-a8b9-9f87fd85bc0e |kanag-cli-VLB |1.0 |CERTIFIED |
+--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
|c763b7f8-6bc3-42a2-afa7-04157f79b629 |6e29f979-6f36-4c0d-8605-e59da8d62cb7 |1bd7f899-01dc-4d7f-97d8-f38ba6b40dd9 |74361ede-ef8c-43f1-9d82 |1.0 |CERTIFIED |
+--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
|94d78d38-d5ae-4a92-9d9e-fb79fc55195a |3a3fb778-1c0e-41a1-9a04-f7ddaaf93d73 |414da4ea-e482-4ed2-9941-bd90108376fa |136ab241-88ff-443a-88e8 |1.0 |CERTIFIED |
+--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
|3575fbff-614c-4418-93c7-133dc4fc59b6 |f4be1629-c9a1-4f32-8f34-11eddabffc13 |7fd3788f-a065-4270-bb95-852eae3a94b3 |ef35d3c9-a8c6-457c-a115 |1.0 |CERTIFIED |
+--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
|87c5f870-809f-4488-aae5-80ef0fd9e085 |372e2c66-ee59-4488-a6a6-546c28b3a151 |244b380b-acf1-4545-8d35-d6d01bc32fd6 |5d11dda4-fb32-4df6-86eb |1.0 |CERTIFIED |
+--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
|d49dd5ee-bc53-44d7-a067-e4cba9a3be1a |23018f7f-fbce-479e-a77b-6b98ebf03266 |6bc22345-395d-4358-8954-45963761f968 |8fd2e5c8-981d-4a14-ba77 |1.0 |CERTIFIED |
+--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
vf-model-certify-complete
input:
--vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff
vf-model-checkin
input:
--vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff
service-create
input:
--cloud-region RegionOne --tenant-id onap --model-invariant-id 1de901ed-17af-4b03-bc1f-41659cfa27cb --model-uuid ace39141-09ec-4068-b06d-ac6b23bdc6e0 --model-name demoVLB --model-version 1.0 -c Demonstration --instance-name sample-service-onap-cli-13 --service-type vLB
output:
+--------------+--------------------------------------+
|property |value |
+--------------+--------------------------------------+
|service-id |957949b4-f857-497c-81b0-832ce7bb9434 |
+--------------+--------------------------------------+
vf-create
input:
--cloud-region RegionOne --tenant-id onap --product-family vLB --instance-name vlb-cli-sample-11 --service-instance-id 2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee --vf-model-invariant-id cc34cd54-dd7c-44cd-8847-f9577c6f1a49 --vf-model-uuid 8b1f63f3-e0cc-4c27-8903-fafe2f25bfbe --vf-model-name 847cb26a-59a6-475a-94dd --vf-model-version 1.0 --vf-model-customization-id cf893f5a-1bb1-4e32-a92b-2456e12178f8 --service-model-invariant-id 1de901ed-17af-4b03-bc1f-41659cfa27cb --service-model-uuid ace39141-09ec-4068-b06d-ac6b23bdc6e0 --service-model-name demoVLB --service-model-version 1.0 -m http://192.168.17.121:8080 -u InfraPortalClient -p password1$
output:
+--------------+--------------------------------------+
|property |value |
+--------------+--------------------------------------+
|vf-id |048c2c4a-ee30-41a1-bb55-c4e7fe1a9a0d |
+--------------+--------------------------------------+
End to end service creation tutorial
Following document provides the tutorial for service creation using CLI.
End-to-End command guide for working with ONAP
This document demonstrates end to end working with ONAP using cli.
Currently, in ONAP, it is getting initialized by robot script (demo.sh init), which requires programming knowledge to modify the scripts as per the requirement. Cli provides an interface to communicate with different services in ONAP and it can be used to configure ONAP as per requirement without any programming knowledge.
Following operations are involved to deploy a VNF.
CLI communicate with:
- SDC to
Create Vendor License Model (VLM)
Create Vendor Software Product (VSP), VF and Service
Distribute service
- Policy to
Put HPA policies
- AAI to create
Complex
Cloud
Customer
- Service-type
Add customer subscription
- Multicloud to
register cloud with multicloud to discover HPA
- SO to create
Service-instance
VNF Instance
VF module (deploys stack)
- SDNC to
Preload VF module parameters
Creating Vendor License Model (VLM)
For creating a VLM we need to define in SDC using CLI: - entitlement pool - key group - feature group - license agreement
Create license
Run following command to create license.
onap>vlm-create -x ${vendor-name} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
Output: vlm-id, vlm-version
Create license entitlement pool
Run following command to create license entitlement pool.
onap>vlm-entitlement-pool-create -x ${entitlement-pool-name} -y ${vlm-id} -e ${vlm-version} -z ${entitlement-pool-description} -k ${vendor-name} -g {license-expiry-date} -l {license-start-date} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
Output: vlm-entitlement-pool-id
Create license key group
Run following command to crate license key group.
onap>vlm-key-group-create -c ${vlm-id} -e ${vlm-version} -x {key-group-name} -y {key-group-type} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
Output: key-group-id
Create license feature group
Run following command to create license feature group.
onap>vlm-feature-group-create -x ${feature-group-name} -y ${vlm-id} -e {vlm-version} -z {feature-grp-description} -g ${key-group-id} -b ${vlm-entitlement-pool-id} -c ${part-no} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
Output: feature-group-id
Create license agreement
Run following command to create license agreement.
onap>vlm-aggreement-create -x ${aggreement-name} -y ${vlm-id} -e ${vlm-version} -z ${agreement-description} -g ${feature-group-id} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
Output: agreement-id
Now, VLM is ready to submit.
Checkin and submin vlm
Run following command to check-in and submit created VLM.
vlm-submit -x ${vlm-id} -y ${vlm-version} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
Now, VLM is available in catalog to be used for VSP.
Create and distribute Vendor Software Product (VSP)
Service distribution involves following steps: - Create, validate and submit VSP - Creation and certificaion of VF - Creation and certification of Service
Create VSP
Run following command to create VSP.
onap>vsp-create -j ${feature-group-id} -o ${onboarding-method} -e ${vendor-name} -x ${vsp-name} -y ${vsp-description} -i ${aggreement-id} -c ${vlm-version} -g ${vlm-id} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
Output: vsp-id, vsp-version
Add artifact to VSP
This command associates artifacts to VSP.
onap>vsp-add-artifact -x ${vsp-id} -y ${vsp-version} -z ${csar-file} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
Validate VSP
After uploading artifacts to VSP you need to validate the VSP using following command.
onap>vsp-validate -x ${vsp-id} -y ${vsp-version} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
NOTE: In most cases warning is reported for VSP validation, this can be ignored.
Submit VSP
After VSP validation it can be checked in and submit. Run following command to complete check-in and VSP submission.
onap>vsp-submit -x ${vsp-id} -y ${vsp-version} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
To list created VSPs, run the following command;
onap>vsp-list -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
package VSP
After submitting VSP you require to generate CSAR artifact which can be done using following command.
onap>vsp-package -x ${vsp-id} -y ${vsp-version} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
Now, you can proceed for defining VF.
Create vf model for VSP
Run following command to create VF by specifying correct VSP id.
onap> vf-model-create -x ${vf-model-name} -y ${vf-model-description} -g ${vsp-version} -z ${vlm-vendor-name} -b ${vsp-id} -u cs0008 -p demo123456! -m ${sdc-catalog-url}
Output: vf-model-id
To view newly created vf;
onap> vf-model-list -u cs0008 -p demo123456! -m ${sdc-catalog-url}
Save the vf-unique-id , it will be used for certification
Now, VF is ready for certification.
Certify VF
Certification will be conducted by tester(jm0007), tester can use following command to mark VF certification start and complete.
onap> vf-model-certify -b ${vf-unique-id} -r ${vf-remarks} -u cs0008 -p demo123456! -m ${sdc-catalog-url}
After certifications, the id values change so run the above vf-model-list command to see the new values which will be used in the next steps. After successful VF creation you can proceed for service model creation.
Create service model
Run following command to create service model.
onap>service-model-create -x ${service-model-name} -y ${service-model-description} -z ${project-code} -e ${icon-id} -c ${category-display} -b ${category} -u cs0008 -p demo123456! -m ${sdc-catalog-url}
project code can be a random string
Output: service-model-id
Add VF to service model
Associate VF to service model using following command.
onap>service-model-add-vf -x ${service-model-id} -b ${vf-version} -y ${vf-model-unique-id} -z ${vf-model-name} -u cs0008 -p demo123456! -m ${sdc-catalog-url}
Submit Service for Testing
Now, service is ready for Testing. Use following command to initiate service test request.
onap>service-model-test-request -b ${service-model-id} -u cs0008 -p demo123456! -m ${sdc-catalog-url}
Test service
Now, tester(jm0007) can see service in his dashboard and he can start testing. Tester can use following command to start test and complete test
onap>service-model-test-start -b ${service-model-id} -u jm0007 -p demo123456! -m ${sdc-catalog-url}
onap>service-model-test-accept -b ${service-model-id} -r ${test-remarks} -u jm0007 -p demo123456! -m ${sdc-catalog-url}
onap>service-model-list -u cs0008 -p demo123456! -m ${sdc-catalog-url}
Run the above list command to get the service-model-unique-id, it will be used to approve the service model
Approve service model
After successful Testing, service will be submitted to governor(gv0001) to approve service model.
onap>service-model-approve -b ${service-model-unique-id} -r ${approval-remarks} -u gv0001 -p demo123456! -m ${sdc-catalog-url}
onap>service-model-list -u cs0008 -p demo123456! -m ${sdc-catalog-url}
Distribute service model
Now operator can distribute the service and it will be available in VID dashboard.
onap>service-model-distribute -b ${service-model-unique-id} -u op0001 -p demo123456! -m ${sdc-catalog-url}
onap>service-model-list -u cs0008 -p demo123456! -m ${sdc-catalog-url}
Creating Policies (Only Required if HPA is being Used)
Before Running these commands to create policies, you must have uploaded policy models. See Method 2 (Manual upload) here
onap> policy-create-outdated -m ${pdp-url} -u testpdp -p alpha123 -x ${policy-name} -S ${policy-scope} -T ${policy-config-type} -o ${policy-onap-name} -b ${policy}
onap> policy-push-outdated -m ${pdp-url} -u testpdp -p alpha123 -x ${policy-name} -b ${policy-config-type} -c ${policy-pdp-group}
When creating policies, the resource-module-name of the vf-model is required. This can be gotten by running the following command;
onap> get-resource-module-name -u cs0008 -p demo123456! -m ${sdc-catalog-url}
Note: See Step 16 in vFW with HPA Tutorial: Setting Up and Configuration for sample policies as well as example values for policy-scope, config-type …etc.
Creating Cloud, Customer and Service-type
It is required to specify the complex and cloud configuration in AAI system before deploying the service. Following are the steps to configure cloud and related information for service deployment.
Create Complex
onap>complex-create -x ${complex-name} -r ${physical-location} -y ${data-center-code} -l ${region} -i ${street-1-name} -j ${street-2-name} -lt ${latitude} -lo ${longitude} -S ${state} -la ${lata} -g ${city} -w ${postal-code} -z ${complex-name} -k ${country} -o ${elevation} -q ${identity-url} -m ${aai-url} -u AAI -p AAI
Create Cloud
Use following command to create cloud and region in AAI system.
onap>cloud-create -x ${cloud-owner-name} -y ${cloud-region-name} -e ${esr-system-info-id} -b ${cloud-user-name} -j ${cloud-user-password} -I ${extra-info} -w ${cloud-region-version} -l ${default-tenant} -url ${keystone-url} -n ${complex-name} -q ${cloud-type} -r ${owner-defined-type} -Q ${system-type} -i ${identity-url} -g ${cloud-zone} -z ${ssl-insecure-boolean} -k ${system-status} -c ${cloud-domain} -m ${aai-url} -u AAI -p AAI
Sample Command
onap> cloud-create -e 5c85ce1f-aa78-4ebf-8d6f-4b62773e9ade -b ${cloud-username} -I {\\"openstack-region-id\\":\\"ONAP-POD-01-Rail-06\\"} -x CloudOwner -y ONAP-POD-01-Rail-06 -j ${cloud-password} -w titanium_cloud -l Integration-HPA -url http://10.12.11.1:5000/v3 -n clli1 -q openstack -r t1 -Q VIM -i url -g CloudZone -z true -k active -c Default
Associate Cloud Region with complex
onap> complex-associate -x ${complex-name} -y ${cloud-region} -z ${cloud-owner} -m ${aai-url} -u AAI -p AAI
onap> cloud-list -u AAI -p AAI -m ${aai-url}
Register Cloud Region with Multicloud (only required for HPA)
onap> multicloud-register-cloud -y ${cloud-owner} -x ${cloud-region} -m ${multicloud-url}
Create Customer
A customer subscribes for the service. Use follwing command to create customer.
onap>customer-create -x ${customer-name} -y ${subscriber-name} -u AAI -p AAI -m ${aai-url}
onap>customer-list -u AAI -p AAI -m ${aai-url}
Create service type
Use following command to create service type.
onap>service-type-create -x ${service-name} -u AAI -p AAI -m ${aai-url}
onap>service-type-list -u AAI -p AAI -m ${aai-url}
Create subscription
Use the following command to create subscription for a customer.
onap>subscription-create -x ${customer-name} -z ${cloud-owner} -c ${tenant-id} -e ${service-name} -y ${default-tenant} -r ${cloud-region} -m ${aai-url} -u AAI -p AAI
If the subscription has already been created, you can add more clouds to it using the following command;
onap>subscription-cloud-add -x ${customer-name} -z ${cloud-owner} -c ${tenant-id} -e ${service-name} -y ${default-tenant} -r ${cloud-region} -m ${aai-url} -u AAI -p AAI
Create Service-instance, VNF Instance and deploy VFMODULE
Now, all the required configuration and artifacts are available for the SO service to create a service-instance, VNF-Instance and VFMODULE.
Create service instance
Using following command you can create service-instance in specified cloud region. Command requires service model identifier which can be obtained from previously used CLIs for creating and listing service model.
onap> service-create -w ${service-name} -la ${customer-latitude} -lo ${customer-longitude} -o ${orchestrator} -A {alacart-boolean} -i ${service-model-name} -y ${company-name} -x ${project-name} -q ${requestor-id} -O ${owning-entity-name} -k ${service-instance-name} -P ${test-api} -H ${homing-solution} -n ${service-model-uuid} -e ${service-model-invariant-uuid} -j ${service-model-version} -S ${subscriber-name} -g ${service-model-uuid} -z ${owning-entity-id} -c ${customer-name} -u InfraPortalClient -p password1$ -m ${so-url}
When Homing and HPA are not being used, you do not need to specify longitude, latitude, homing-solution, orchestator
Sample service-create commands
Without Homing
onap> service-create -w vFW -o multicloud -A true -i vfw-demo-service -y some_company -x Project-Demonstration -q demo -O OE-Demonstration -k rand-2 -P VNF_API -n 545bca3c-8cc0-4dac-b464-1720894e0213 -e 41d0ebba-4b89-4437-9b22-4d83d2183aaa -j 1.0 -S Demonstration -g 545bca3c-8cc0-4dac-b464-1720894e0213 -z d005274f-d295-4538-a6b0-a090a7807dae -c Demonstration -u InfraPortalClient -p password1$ -m http://192.168.1.147:30277
With Homing
onap> service-create -w vFW -la 32.897480 -lo 97.040443 -o multicloud -A true -i vfw-demo-service -y some_company -x Project-Demonstration -q demo -O OE-Demonstration -k cli-instance-new -P VNF_API -H oof -n 545bca3c-8cc0-4dac-b464-1720894e0213 -e 41d0ebba-4b89-4437-9b22-4d83d2183aaa -j 1.0 -S Demonstration -g 545bca3c-8cc0-4dac-b464-1720894e0213 -z d005274f-d295-4538-a6b0-a090a7807dae -c Demonstration -u InfraPortalClient -p password1$ -m http://192.168.1.147:30277
You can get the values for the owning entity by running the following command;
onap> owning-entity-list -u AAI -p AAI -m ${aai-url}
Create VNF Instance
Use the following command to create the VNF instance, Do a Preload and create the VFModule in a particular cloud region
onap> vnf-create -j ${service-model-invariant-uuid} -q ${service-model-name} -k ${service-model-id} -l ${cloud-region} -y ${service-instance-id} -z ${tenant-id} -r ${requestor-id} -c ${vf-model-uuid} -o ${generic-vnf-name} -e ${vf-model-name} -g ${vf-model-version} -b ${vf-model-invariant-uuid} -n ${service-version} -i ${vf-model-customization-id} -vn ${vf-model-customization-name} -w ${service-name} -pn ${platform-name} -lob ${lob-name} -u InfraPortalClient -p password1$ -m ${so-url}
Output: vnf-id
Sample vnf-create command
onap> vnf-create -j 41d0ebba-4b89-4437-9b22-4d83d2183aaa -q vfw-demo-service -k 545bca3c-8cc0-4dac-b464-1720894e0213 -l cloud-two -y 43143a2c-f0e1-499d-b042-97fb0c05166b -z a0ea4cfd751e40e0a093848dd9e03e6c -r demo -c 04ffd583-5625-4471-b20b-38394b513efd -o cli-vnf-test -e vfw-hpa-sriov_v2 -g 1.0 -b b7d993a3-3870-4096-a16c-90110d402349 -n 1.0 -i 123f896f-c6a4-4560-8786-7607e832bb6f -vn "vfw-hpa-sriov_v2 0" -w vFW -pn Platform-Demonstration -lob LOB-Demonstration -u InfraPortalClient -p password1$ -m http://192.168.1.147:30277
Preload VF-Module
onap> vf-preload -y ${preload-file} -u admin -p Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U -m ${sdnc-url}
See Step 20 of vFW with HPA Tutorial: Setting Up and Configuration for sample preload file.
Create VF-module
onap> vf-module-create -w ${tenant-id} -mn ${vf-model-customization-name} -x ${service-instance-id} -l ${cloud-region} -sv ${service-version} -vc ${vf-module-customization-id} -vm ${v-module-model-version} -mv ${vf-model-version} -i ${vf-module-name} -vf ${vf-model-name} -vi ${vf-module-model-invariant-id} -r ${suppress-rollback-boolean} -mc ${vf-model-customization-id} -api ${test-api} -mi ${vf-model-invariant-id} -vid ${vf-model-id} -y ${vnf-instance-id} -R ${requestor-id} -si ${service-uuid} -up ${use-preload} -sd ${service-invariat-id} -z ${service-model-name} -vn ${vf-module-model-name} -vv ${vf-module-model-version-id} -co ${cloud-owner} -u InfraPortalClient -p password1$ -m ${so-url}
Sample vf-module-create command
onap> vf-module-create -w a0ea4cfd751e40e0a093848dd9e03e6c -mn "vfw-hpa-sriov_v2 0" -x d353ace3-52e9-4c79-b3c8-63c97e15cc29 -l cloud-two -sv 1.0 -vc 0f837829-0dbb-4768-88d4-3cdf01e073f6 -vm 1 -mv 1.0 -i vfw-sriov-cli -vf vfw-hpa-sriov_v2 -vi 8d3071e4-0d4e-4520-aa92-c01b9a019142 -r false -mc 123f896f-c6a4-4560-8786-7607e832bb6f -api VNF_API -mi b7d993a3-3870-4096-a16c-90110d402349 -vid 04ffd583-5625-4471-b20b-38394b513efd -y dad645a3-7e01-47cd-8e70-cdc8b5e880ec -R demo -si 545bca3c-8cc0-4dac-b464-1720894e0213 -up true -sd 41d0ebba-4b89-4437-9b22-4d83d2183aaa -z vfw-demo-service -vn VfwHpaSriovV2..base_vfw..module-0 -vv d5c83591-0f22-4543-ada2-24197847b7d2 -u InfraPortalClient -p password1$ -m http://192.168.1.147:30277
PNF/VNF on-boarding tutorial
Following document provides the tutorial for PNF/VNF on-boarding tutorial using CLI.
Step to import VNF/PNF
This document describes how to insert existing PNF/VNF to AAI with CLI project.
Main steps: 1. create customer and service instance in AAI. This step could be done by UUI or VID, OR user can insert customer/service instance node by CLI cmd.
create PNF/VNF
create relation-ship between service-instance and created PNF/VNFs
check the Topology graph through AAI portal
create customer
optional,since the customer/subscription/service-instance may already exist
create customer:
onap>customer-create -u AAI -p AAI -m https://172.19.44.123:8443 --customer-name testCustomer --subscriber-name EC
Check if customer created successfully:
onap>customer-list -u AAI -p AAI -m https://172.19.44.123:8443
+--------------+------------------+
|name |resource-version |
+--------------+------------------+
|testCustomer |1521772326346 |
+--------------+------------------+
|Orange1 |1521771120855 |
+--------------+------------------+
|Orange |1520304126184 |
+--------------+------------------+
|test |1521098144163 |
+--------------+------------------+
delete customer cmd:
onap>customer-delete -u AAI -p AAI -m https://172.19.44.123:8443 --customer-name testCustomer --resource-version 1521772326346
create subscription (optional)
create subscription cmd:
onap>subscription-create-with-template -u AAI -p AAI -m https://172.19.44.123:8443 --customer-name testCustomer --service-type EC --template /opt/oclip/template/sub-create.json
content of /opt/oclip/template/sub-create.json:
{
"service-subscription": [
{
"service-type": "EC",
}
]
}
Check if subscription created successfully:
onap>subscription-list -u AAI -p AAI -m https://172.19.44.123:8443 --customer-name testCustomer
output:
+--------------+------------------+
|service-type |resource-version |
+--------------+------------------+
|EEC |1521773231094 |
+--------------+------------------+
|EC |1522058350020 |
+--------------+------------------+
delete subscription cmd:
onap>subscription-delete -u AAI -p AAI -m https://172.19.44.123:8443 --customer-name testCustomer --service-type EC --resource-version 1521772326346
create service instance(optional)
create service instance with template cmd:
onap>service-instance-create-with-template -u AAI -p AAI -m https://172.19.44.123:8443 --service-instance-id 176d9eba-1662-4289-8396-0097b50fd486 --template /opt/oclip/open-cli-schema/service-instance-template.json --global-customer-id testCustomer --service-type EC
content of /opt/oclip/open-cli-schema/service-instance-template.json:
{
"global-customer-id": "testCustomer",
"subscriber-name": "EC",
"subscriber-type": "INFRA",
"service-subscriptions": {
"service-subscription": [
{
"service-type": "EC",
"service-instances": {
"service-instance": [
{
"service-instance-id": "176d9eba-1662-4289-8396-0097b50fd486",
"service-instance-name": "template-service",
"service-type": "NetworkService",
"relationship-list": {
}
}
]
}
}
]
}
}
Create PNF
there are many ways to create PNF, cmd:
A: create pnf with pnf name:
onap>pnf-create -u AAI -p AAI -m https://172.19.44.123:8443 -n testcmdpnfname
B: create pnf with all option (including relationship json):
onap>pnf-create -u AAI -p AAI -m https://172.19.44.123:8443 -n testcmdpnfname -q MME -x generic --in-maint false --prov-status PROV --relationship /opt/oclip/open-cli-schema/pnf-sub-relation.json
Sample content of /opt/oclip/open-cli-schema/pnf-sub-relation.json:
{
"relationship": [
{
"related-to": "logical-link",
"related-link": "/aai/v11/network/logical-links/logical-link/S11-00001",
"relationship-data": [
{
"relationship-key": "logical-link.link-name",
"relationship-value": "S11-00001"
}
]
}
]
}
C: create pnf with template
since pnf contains logs of parameters , user can put all the parameters in a json file.e.g to create a PNF with p-interface,user should use this cmd:
onap>pnf-create-with-template -u AAI -p AAI -m https://172.19.44.123:8443 -n pnf_template -r /opt/oclip/open-cli-schema/pnf-template.json
Sample content of /opt/oclip/open-cli-schema/pnf-template.json
{
"pnf-name" : "pnf_template",
"equip-type" : "pnf_template",
"equip-vendor" : "Generic",
"in-maint" : "false",
"prov-status" : "PROV",
"p-interfaces" : {
"p-interface" : [
{
"interface-name" : "pnf_template-p-interface",
"speed-value" : "1",
"speed-units" : "Gbps",
"port-description" : "downstream port 1",
"interface-type" : "port",
"prov-status" : "PROV",
"in-maint" : "false",
"l-interfaces" : {
"l-interface" : [
{
"interface-name" : "pnf_template-i-interface",
"interface-role" : "Eth logical interface",
"is-port-mirrored" : "false",
"prov-status" : "PROV",
"in-maint" : "false"
}
]
}
}
]
}
}
List Created PNF cmd:
onap>pnf-list -u AAI -p AAI -m https://172.19.44.123:8443
output:
+----------------+--------------------------------------+------------------+
|pnf-name |pnf-id |resource-version |
+----------------+--------------------------------------+------------------+
|batch-name-2 |176d9eba-1662-4289-8396-0097b50fd470 |1521790894608 |
+----------------+--------------------------------------+------------------+
|pnf_template |176d9eba-1662-4289-8396-0097b50fd467 |1521702068121 |
+----------------+--------------------------------------+------------------+
|testcmdpnfname |176d9eba-1662-4289-8396-0097b50fd466 |1521687589914 |
+----------------+--------------------------------------+------------------+
|batch-name-1 |176d9eba-1662-4289-8396-0097b50fd470 |1521790894391 |
+----------------+--------------------------------------+------------------+
|SPGW-0001 | |1520304310122 |
+----------------+--------------------------------------+------------------+
|test | |1520417818047 |
+----------------+--------------------------------------+------------------+
|MME-000111 | |1520417147010 |
+----------------+--------------------------------------+------------------+
|MME-0001 | |1520303982165 |
+----------------+--------------------------------------+------------------+
|SP GW-0001 | |1520304000840 |
+----------------+--------------------------------------+------------------+
Delete PNF cmd:
onap>pnf-delete -n testname -b 1521685031379 -u AAI -p AAI -m https://172.19.44.123:8443
Create VNF
there are many ways to create VNF, cmd:
A: create VNF with VNF id:
- ::
onap>vnf-create -u AAI -p AAI -m https://172.19.44.123:8443 –name vn1 –vnf-id d9b1b05f-44c8-45ef-89aa-d27ad060ceb8 –vnf-type t1 –debug
B: create VNF with template:
onap>vnf-create-with-template -u AAI -p AAI -m https://172.19.44.123:8443 --vnf-id d9b1b05f-44c8-45ef-89aa-d27ad060ceb9 --template /opt/oclip/open-cli-schema/vnf-template.json
Sample content of /opt/oclip/open-cli-schema/vnf-template.json
{
"vnf-id": "d9b1b05f-44c8-45ef-89aa-d27ad060ceb9",
"vnf-name": "vvnf-name",
"vnf-type": "vnf-type-1",
"in-maint": true,
"is-closed-loop-disabled": false
}
Create relationship between service instance and PNF/VNF:
onap>service-instance-relationship-create -u AAI -p AAI -m https://172.19.44.123:8443 -g Orange -z EC -i 176d9eba-1662-4289-8396-0097b50fd485 -r /opt/oclip/open-cli-schema/relation.json
Sample content of /opt/oclip/open-cli-schema/relation.json:
{
"related-to": "pnf",
"related-link": "/aai/v11/network/pnfs/pnf/pnf_template",
"relationship-data": [
{
"relationship-key": "pnf.pnf-name",
"relationship-value": "pnf_template"
}
]
}
List Service-instance relationship:
onap>service-instance-relationship-list -u AAI -p AAI -m https://172.19.44.123:8443 -g Orange -z EPC -i 176d9eba-1662-4289-8396-0097b50fd485
Output:
+--------------+----------------------------------------------------+
|related-to |related-link |
+--------------+----------------------------------------------------+
|pnf |/aai/v11/network/pnfs/pnf/pnf_template |
+--------------+----------------------------------------------------+
|pnf |/aai/v11/network/pnfs/pnf/testcmdpnfname |
+--------------+----------------------------------------------------+
|logical-link |/aai/v11/network/logical-links/logical-link/S11-00 |
| |001 |
+--------------+----------------------------------------------------+
|pnf |/aai/v11/network/pnfs/pnf/MME-0001 |
+--------------+----------------------------------------------------+
|pnf |/aai/v11/network/pnfs/pnf/SP%20GW-0001 |
+--------------+----------------------------------------------------+
Delete Service-instance relationship:
onap>service-instance-relationship-delete -u AAI -p AAI -m https://172.19.44.123:8443 -g Orange -z EPC -i 176d9eba-1662-4289-8396-0097b50fd485 -r /opt/oclip/open-cli-schema/relation.json
Sample content of /opt/oclip/open-cli-schema/relation.json is same as the one used to create relation.
batch import PNF/VNF:
Since all the cmd support batch model, user can import multi-PNF/VNF one time: This CMD should be run on system terminal:
cmd:
onap>oclip -p create-batch.yaml pnf-create
Sample content of create-batch.yaml:
pnf1:
- name: batch-name-1
- host-username: AAI
- host-password: AAI
- host-url: https://172.19.44.123:8443
pnf2:
- name: batch-name-2
- host-username: AAI
- host-password: AAI
- host-url: https://172.19.44.123:8443
- template: |
{
"relationship": [
{
"related-to": "logical-link",
"related-link": "/aai/v11/network/logical-links/logical-link/S11-00001",
"relationship-data": [
{
"relationship-key": "logical-link.link-name",
"relationship-value": "S11-00001"
}
]
}
]
}
User can also use create with template cmd for batch execute:
sample cmd:
oclip -p create-batch.yaml pnf-create-with-template
Checke AAI topology through portal:
Typing the key word, (service,PNF,generic-vnf,customer),the search text box will pup up auto suggestion of the search key word. e.g.
service-instance called 176d9eba-1662-4289-8396-0097b50fd485
customer called test
pnf called MME-0001
generic-vnf called d9b1b05f-44c8-45ef-89aa-d27ad060ceb4
CLI verification program
OCLIP provides option to write test suite with set of test cases by authoring required samples and moco templates. Currently HTTP profile is enabled with this program.
CLI verification program
Verification program helps the author to setup the mocking environment for the HTTP profile (and in future it could be extended to other profile) for authoring the testing the CLI OCS YAMLs.
It provides the model based test environment where author needs to setup following aspects:
# Write the moco JSON which captures the HTTP request and response in moco style
# Write the sample YAML which captures the one or more functional test case(s)
# Place them under open-cli-sample directory under OPEN_CLI_HOME
Once this setup is done, author can verify the OCS YAML by running the following CLI
oclip <command name> --verify | -V
It will list out the success/failure of each test case written in sample YAML.
CLI installation guide
ONAP CLI is delivered in following formats:
Nexus ZIP artifact
Docker image
And it could be installed by following one of the approaches given below:
Using install.sh
Please follow the instructions given below, for installing CLI using install.sh.
Download install.sh from here. to /tmp
Run command
source /tmp/install.sh
Verify the installation by running following command.
onap -v
For details, see CLI user guide
Using Portal CLI app
Please follow the instructions given below, for installing CLI from portal.
After installing Portal, ONAP CLI will be available as Portal application as shown below:
Click on CLI application and it will show the following page and download the CLI as reported in this page.
After downloading, please follow the instruction given in this page to install ONAP CLI.
Verify the installation by running following command
onap -v
For details, see CLI user guide
Using docker image
Please follow the instructions given below, for installing CLI using docker image.
Download the cli docker image
docker login -u docker -p docker nexus3.onap.org:10001
docker pull nexus3.onap.org:10001/onap/cli
Verify the installation by running following command
docker run onap/cli onap -v
For details, see CLI user guide
CLI deployment using OOM and HEAT
ONAP CLI deployment is enabled with OOM and HEAT based ONAP installation.
OpenStack HEAT based deployment
As part of HEAT based deployment, ONAL CLI docker image is integrated into ONAP Portal and when portal_vm is successfully installed, it will be available at http://portal.api.simpledemo.openecomp.org:8080
To troubleshoot any issues in CLI, please login to portal_vm and CLI docker runs with image onap/cli
OOM based deployment
ONAL CLI docker image is integrated with OOM and is available under name ‘cli’
Once successfully installed, CLI is available under onap-cli name-space. So user can access the CLI at http://<k8s-host>:30260
CLI Logging
ONAP CLI provides logging based on slf4j and ONAP_CLI_HOME/conf/logging.properties is used to configure it.
By default, it reports the logs under ONAP_CLI_HOME/logs folder.
To enable the debugging, set the logging level to DEBUG/INFO. By default its set to ERROR.
CLI Release Notes
Version: 10.0.0 (Jakarta)
- Release Date
2022-06-09
no updates in this release
Version: 6.0.1
- Release Date
2021-04-01
New Features
Metadata support is added in OCS YAML
Security Notes
Fixed Security Issues
Known Security Issues
Known Vulnerabilities in Used Modules
Version: 6.0.0
- Release Date
2020-11-04
New Features
Enabled auto discover and registration of products functionalities as commands
Profile managment commands are added
Security Notes
Fixed Security Issues
Known Security Issues
Known Vulnerabilities in Used Modules
Version: 5.0.4
- Release Date
2020-04-07
New Features
Improved HTTP timeout
Enable Non-Root user in docker container
Improved SDC and VFC commands under onap-dublin product
CLI web portal is made to run HTTPS 443 port and Web consoles at HTTPS 9090
Vulnerability is improved from previous release by using secured 3rd-party libraries
Security Notes
Fixed Security Issues
Known Security Issues
Known Vulnerabilities in Used Modules
Version: 4.0.0
- Release Date
2019-10-24
New Features
ONAP CLI is used to end-end automation of VNF service provision and termination for both HEAT and TOSCA based VNF service.
Multi-level orchestration capability is made available to use and user could use python, or similar scripting/workflow engine for the same
VNF Test Platform(VTP) has used the Open Command Platform (OCOMP) - part of ONAP CLI project, for VNF life cycle testing (create and delete)
ONAP CLI for ONAP Dublin version is stabilized to use it for both service provisioning and testing purpose
ONAP CLI for el alto is enabled as experimental (dev) mode
Security Notes
Fixed Security Issues
Known Security Issues
In default deployment CLI (cli) exposes HTTP port 30260 outside of cluster. [OJSI-129]
In default deployment CLI (cli) exposes HTTP port 30271 outside of cluster. [OJSI-135]
CVE-2019-12130 - CLI exposes unprotected APIs/UIs on port 30271. [OJSI-205]
Known Vulnerabilities in Used Modules
Version: 3.0.0
- Release Date
2019-05-31
New Features
Beijing support EOL
Enhanced schema management
Added execution support for capturing the details of every execution includes parameters, results. This feature is used in VTP.
End-end service creation using ONAP commands are provided. [More details]
Security Notes
Fixed Security Issues
Known Security Issues
In default deployment CLI (cli) exposes HTTP port 30260 outside of cluster. [OJSI-129]
In default deployment CLI (cli) exposes HTTP port 30271 outside of cluster. [OJSI-135]
CVE-2019-12130 - CLI exposes unprotected APIs/UIs on port 30271. [OJSI-205]
Known Vulnerabilities in Used Modules
Version: 2.0.5
- Release Date
2018-11-30
New Features
Amsterdam support EOL
Added gRPC to run the ONAP commands remotely
Added Command profile to support VTP (VNF Test Platform) requirements in VNFSDK and added new commands for supporting it
VTP leverages OCLIP for providing the test center (discover the test cases) and test runner (run the test cases)
Security Notes
CLI code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The CLI open Critical security vulnerabilities and their risk assessment have been documented as part of the project.
Version: 2.0.0
- Release Date
2018-06-07
New Features
In this release, CLI provides all those features supported in previous release. In addition, following features are enabled:
Profile support (like Heat environment file)
Batch support to run same command with different set of arguments feed from param-file)
Policy management
VNF/PNF management
OCLIP SNMP profile support (get command)
OCLIP CLI verification support (–verify)
Portal CLI application is enabled for all users.
Similar to earlier release, user can perform customer, subscription, cloud and tenant management only by using CLI as portal does not support.
In addition, it made following changes to OCS 1.0
http profile is enabled with service section to capture micro-service catalog and auth information
and body section could be customized using context.
New default parameters verify and context are added.
Bug Fixes
CLI-105 Ignore those yamls which does not have open cli schema version
CLI-103 Support HTTP delete with http body (SO, AAI requires)
CLI-101 Add context parameter for ignoring empty json nodes in http body
CLI-99 Optional parameter’s default value is set to blank
CLI-95 Add profile support for multiple sessions
CLI-94 EOL openecomp CLIs
CLI-86 Create documentation for end to end cli commands for onap
CLI-74 Setup Mock environment for a command
CLI-61 Add validation for results section in yaml
Security Notes
CLI code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The CLI open Critical security vulnerabilities and their risk assessment have been documented as part of the project.
Version: 1.1.0
- Release Date
2017-11-16
ONAP CLI helps user to operate ONAP from Linux command console and web command console.
New Features
In ONAP Amsterdam release, CLI provides following ONAP operations as command:
ONAP micro-service discovery
External system on-boarding (VIM, VNFM, EMS & SDNC)
Customer and Subscription management (Only available thru CLI)
Cloud and Tenant on-boarding (Only available thru CLI)
Design-time artifacts (VSP, VF, Service model) management
Network-service (vFW, vLB, etc) life-cycle management
CLI Trouble Shooting Guide
This part provides the trouble shooting guide for ONAP CLI. It aims to provide guidance on the known issues you may encounter.
Details
IllegalArgumentException
Problem: Get an IllegalArgumentException after executing the command.
Cause: The input inside the command contains a special character(e.g. ‘!’, ‘$’,’\’) and the console mandates to escape this kind of chars
Sample Exception:
oclip:open-cli>policy-type-list-all -m http://10.12.7.6:30240 -u "healthcheck" -p "zb!XztG34" Exception in thread "main" java.lang.IllegalArgumentException: !XztG34": event not found at jline.console.ConsoleReader.expandEvents(ConsoleReader.java:507) at jline.console.ConsoleReader.finishBuffer(ConsoleReader.java:379) at jline.console.ConsoleReader.readLine(ConsoleReader.java:1327) at jline.console.ConsoleReader.readLine(ConsoleReader.java:1117) at jline.console.ConsoleReader.readLine(ConsoleReader.java:1105) at org.onap.cli.main.OnapCli.handleInteractive(OnapCli.java:369) at org.onap.cli.main.OnapCli.handle(OnapCli.java:645) at org.onap.cli.main.OnapCli.main(OnapCli.java:751)Solution: User need to escape the special character while giving input(e.g. using single/double quote or backslash)
Powered by Open CLI Platform (OCLIP)