summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKanagaraj Manickam <kanagaraj.manickam@huawei.com>2017-12-06 09:14:37 +0000
committerGerrit Code Review <gerrit@onap.org>2017-12-06 09:14:37 +0000
commitb0f92e52629b4a7a48f6d43553629f249fedf7c8 (patch)
tree13eb3fa995e0b4ccb2ec8409ee3f68ee3eebe5d3
parentd65b63c1f9c67befd4e3a3cfaa848db1c977c04a (diff)
parent03c54a40daf75644ec0bcbc73636e3eb427c1604 (diff)
Merge "Update documents with latest product naming"
-rw-r--r--docs/cmd_help.rst7175
-rw-r--r--docs/cmd_sample.rst234
-rw-r--r--docs/open_cli_schema_version_1_0.rst38
3 files changed, 3643 insertions, 3804 deletions
diff --git a/docs/cmd_help.rst b/docs/cmd_help.rst
index 1f84c4fb..f23e8349 100644
--- a/docs/cmd_help.rst
+++ b/docs/cmd_help.rst
@@ -9,51 +9,47 @@
.. _cli_cmd_help:
-onap-1.1
+open-cli
==========================
-[1] microservice-delete
+[1] basic-logout
-----------------------------------------------
-usage: onap microservice-delete
+usage: oclip basic-logout
-Deletes the micro service from Onap
+basic logout auth command
-Onap service: msb v1
+Product: open-cli
+Service: basic-auth
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-x | --service-name] [-y | --service-version] [-i | --node-ip]
- [-r | --node-port] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-m | --host-url]
where::
- -x | --service-name Onap service name. It is of type STRING.
- -y | --service-version Onap service version. It is of type STRING.
- -i | --node-ip Onap service running node IP. It is of type
- STRING.
- -r | --node-port Onap service running node port. It is of type
- STRING.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -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.
Error::
@@ -62,52 +58,54 @@ Error::
-[2] microservice-list
+[2] catalog
-----------------------------------------------
-usage: onap microservice-list
+usage: oclip catalog
-Lists the registetred micro services in Onap
+cli catalog command to find the base path for service.
-Onap service: msb v1
+Product: open-cli
+Service: catalog
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-l | --catalog-service-name] [-i | --catalog-service-version] [-m | --host-url]
where::
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -l | --catalog-service-name service name registered in catalog service. It is
+ of type STRING.
+ -i | --catalog-service-version service version registered in catalog service. It
+ is of type STRING.
+ -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.
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.
+ 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::
@@ -116,54 +114,49 @@ Error::
-[3] microservice-show
+[3] schema-refresh
-----------------------------------------------
-usage: onap microservice-show
+usage: oclip schema-refresh
-Details the registered microservice in Onap
+Oclip command to refresh schemas stored in open-cli-schema folders.
-Onap service: msb v1
+Product: open-cli
+Service: schema
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-x | --service-name] [-y | --service-version] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
where::
- -x | --service-name Onap service name. It is of type STRING.
- -y | --service-version Onap service version. It is of type STRING.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
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.
+ sr.no Serial Number and is of type STRING.
+ 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.
Error::
@@ -172,45 +165,30 @@ Error::
-[4] microservice-create
+[4] schema-validate
-----------------------------------------------
-usage: onap microservice-create
+usage: oclip schema-validate
-Register microservice into Onap
+Oclip command to validate schema
-Onap service: msb v1
+Product: open-cli
+Service: schema
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-x | --service-name] [-y | --service-version] [-r | --service-url]
- [-b | --enable-ssl] [-c | --path] <node-ip>
- <node-port> <create-or-update> [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
+ [-l | --schema-location] [-i | --internal-schema] [-b | --ocs-version]
where::
- -x | --service-name Onap service name. It is of type STRING.
- -y | --service-version Onap service version. It is of type STRING.
- -r | --service-url Onap service base url. It is of type URL.
- -b | --enable-ssl Onap service is enabled with https or not. It is
- of type STRING. It is optional.
- -c | --path Onap service path. It is of type STRING. It is
- optional.
- node-ip Onap service running node IP. It is of type
- STRING.
- node-port Onap service running node port. It is of type
- STRING.
- create-or-update Onap service create or update. It is of type
- BOOL. By default, it is false.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -221,18 +199,17 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -l | --schema-location Schema file location. It is of type URL.
+ -i | --internal-schema Validate existing schema file. It is of type
+ BOOL. By default, it is false.
+ -b | --ocs-version OCS version. It is of type STRING. It is
+ optional. By default, it is 1.0.
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.
+ sl-no Serial Number of error and is of type STRING.
+ error Schema validation error and is of type STRING.
Error::
@@ -241,39 +218,31 @@ Error::
-[5] vlm-checkin
+[5] basic-login
-----------------------------------------------
-usage: onap vlm-checkin
+usage: oclip basic-login
-Checkin Vendor License Model
+basic login auth command
-Onap service: sdc v1.0
+Product: open-cli
+Service: basic-auth
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --vlm-id Onap VLM ID. It is of type STRING.
- -y | --vlm-version VLM version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -284,72 +253,22 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[6] vlm-key-group-create
------------------------------------------------
-
-
-usage: onap vlm-key-group-create
-
-Create License Key Group
-
-Onap service: sdc v1.0
-
-Options::
-
- [-c | --vlm-id] [-e | --vlm-version] [-x | --name]
- [-y | --type] [-z | --description] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -c | --vlm-id License Model Id. It is of type STRING.
- -e | --vlm-version License Model version. It is of type STRING.
- -x | --name name. It is of type STRING.
- -y | --type type of group (Universal, unique, one-time). It
- is of type STRING. By default, it is Universal.
- -z | --description Description for License Key Group. It is of type
- STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
+ -u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
+ OPEN_CLI_HOST_USERNAME.
+ -p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
+ 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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
Results::
- ID License Model ID and is of type STRING.
+ Authorization Authorization and is of type STRING.
Error::
@@ -358,57 +277,58 @@ Error::
-[7] vlm-aggreement-list
+onap-amsterdam
+==========================
+
+
+[1] catalog
-----------------------------------------------
-usage: onap vlm-aggreement-list
+usage: oclip catalog
-List license aggreement
+ONAP catalog command to find the base path for service.
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: msb
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-l | --catalog-service-name] [-i | --catalog-service-version] [-m | --host-url]
where::
- -x | --vlm-id License Model ID. It is of type STRING.
- -y | --vlm-version License Model version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -l | --catalog-service-name service name registered in catalog service. It is
+ of type STRING.
+ -i | --catalog-service-version service version registered in catalog service. It
+ is of type STRING.
+ -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.
Results::
- ID aggreement ID and is of type STRING.
- name aggreement name and is of type STRING.
+ 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::
@@ -417,39 +337,31 @@ Error::
-[8] vlm-key-group-list
+[2] sdc-basic-login
-----------------------------------------------
-usage: onap vlm-key-group-list
+usage: oclip sdc-basic-login
-key group list in a license model
+ONAP basic login auth command
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc-basic-auth
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --vlm-id License Model ID. It is of type STRING.
- -y | --vlm-version License Model version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -460,14 +372,25 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
Results::
- ID Feature group ID and is of type STRING.
- name Feature group name and is of type STRING.
+ 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::
@@ -476,40 +399,31 @@ Error::
-[9] vlm-create
+[3] basic-login
-----------------------------------------------
-usage: onap vlm-create
+usage: oclip basic-login
-Create License Model
+ONAP basic login auth command
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: basic-auth
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vendor-name] [-y | --description] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --vendor-name vendor name. It is of type STRING.
- -y | --description Description for License Model. It is of type
- STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -520,13 +434,24 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
Results::
- ID License Model ID and is of type UUID.
+ 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::
@@ -535,64 +460,43 @@ Error::
-[10] vlm-entitlement-pool-create
+[4] basic-logout
-----------------------------------------------
-usage: onap vlm-entitlement-pool-create
+usage: oclip basic-logout
-Create Entitlement Pool
+ONAP basic logout auth command
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: basic-auth
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --name] [-y | --vlm-id] [-e | --vlm-version]
- [-z | --description] [-g | --operational-scope] [-k | --manufacture-reference-number]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-m | --host-url]
where::
- -x | --name Entitlement Pool name. It is of type STRING.
- -y | --vlm-id License Model ID. It is of type STRING.
- -e | --vlm-version License Model version. It is of type STRING.
- -z | --description Description for Entitlement Pool. It is of type
- STRING.
- -g | --operational-scope Operational Scope. It is of type STRING. By
- default, it is Availability_Zone.
- -k | --manufacture-reference-number Manufature Reference Number. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID Entitlement Pool ID and is of type STRING.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -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.
Error::
@@ -601,51 +505,67 @@ Error::
-[11] vsp-package
+[5] service-delete
-----------------------------------------------
-usage: onap vsp-package
+usage: oclip service-delete
-Package Vendor Software Product
+Delete service instance (experimental)
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: so
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --service-instace-id] [-b | --model-invariant-id] [-i | --model-uuid]
+ [-e | --model-name] [-g | --model-version] [-c | --customer-name]
+ [-j | --cloud-region] [-k | --tenant-id] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --service-instace-id unique id for service instance. It is of type
+ STRING.
+ -b | --model-invariant-id model invariant id for service in SDC catalog. It
+ is of type STRING.
+ -i | --model-uuid model uuid for service in SDC catalog. It is of
+ type STRING.
+ -e | --model-name model name available in SDC catalog. It is of
+ type STRING.
+ -g | --model-version model version of service (eg. 1.0). It is of type
+ STRING.
+ -c | --customer-name unique id for customer. It is of type STRING.
+ -j | --cloud-region cloud region id. It is of type STRING.
+ -k | --tenant-id tenant id. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Error::
@@ -654,51 +574,65 @@ Error::
-[12] vsp-submit
+[6] vf-module-create
-----------------------------------------------
-usage: onap vsp-submit
+usage: oclip vf-module-create
-Submit Vendor Software Product
+Create a VF Module
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: so
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-l | --lcp-cloudregion-id] [-w | --tenant-id] [-y | --vnf-instace-id]
+ [-x | --service-instace-id] [-z | --parenet-service-model] [-r | --supress-rollback]
+ [-i | --instance-name] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -l | --lcp-cloudregion-id AIC LCP node location identifier. It is of type
+ STRING.
+ -w | --tenant-id openstack tenant id (uuid). It is of type STRING.
+ -y | --vnf-instace-id vnf instance id. It is of type STRING.
+ -x | --service-instace-id unique id for service instance. It is of type
+ STRING.
+ -z | --parenet-service-model parent service model name. It is of type STRING.
+ -r | --supress-rollback rollback changes if instantiation fails. It is of
+ type BOOL. It is optional. By default, it is
+ false.
+ -i | --instance-name service instance name. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Error::
@@ -707,51 +641,62 @@ Error::
-[13] vsp-checkout
+[7] vfmodule-delete
-----------------------------------------------
-usage: onap vsp-checkout
+usage: oclip vfmodule-delete
-Checkout Vendor Software Product
+delete a VF module (experimental)
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: so
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vfmodule-id] [-j | --service-id] [-y | --vf-id]
+ [-k | --vf-model-invariant-id] [-e | --vfmodule-name] [-g | --vfmodule-version]
+ [-l | --cloud-region] [-z | --tenant-id] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --vfmodule-id VF module Id. It is of type STRING.
+ -j | --service-id unique id for service. It is of type STRING.
+ -y | --vf-id unique id for related VF. It is of type STRING.
+ -k | --vf-model-invariant-id vf model invariant id. It is of type STRING.
+ -e | --vfmodule-name vfmodule model name. It is of type STRING.
+ -g | --vfmodule-version vf module version. It is of type STRING.
+ -l | --cloud-region cloud region identifier. It is of type STRING.
+ -z | --tenant-id openstack tenant id. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Error::
@@ -760,63 +705,84 @@ Error::
-[14] vsp-show
+[8] vfmodule-create
-----------------------------------------------
-usage: onap vsp-show
+usage: oclip vfmodule-create
-Details of the Vendor Software Product
+Create a VF module
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: so
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-l | --cloud-region] [-B | --tenant-id] [-b | --vfmodule-invariant-id]
+ [-c | --vfmodule-uuid] [-e | --vfmodule-name] [-g | --vfmodule-version]
+ [-i | --module-name] [-j | --service-id] [-y | --vf-id]
+ [-k | --vf-model-invariant-id] [-A | --vf-model-uuid] [-n | --vf-model-name]
+ [-o | --vf-model-version] [-q | --vf-model-customization-id] [-r | --service-model-invariant-id]
+ [-w | --service-model-uuid] [-x | --service-model-name] [-z | --service-model-version]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version Onap VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -l | --cloud-region cloud region identifier. It is of type STRING.
+ -B | --tenant-id openstack tenant id. It is of type STRING.
+ -b | --vfmodule-invariant-id vfmodule model invariant id. It is of type STRING.
+ -c | --vfmodule-uuid model uuid for vfmodule. It is of type STRING.
+ -e | --vfmodule-name vfmodule model name. It is of type STRING.
+ -g | --vfmodule-version vf module version. It is of type STRING.
+ -i | --module-name vfmodule name. It is of type STRING.
+ -j | --service-id unique id for service. It is of type STRING.
+ -y | --vf-id unique id for related VF. It is of type STRING.
+ -k | --vf-model-invariant-id vf model invariant id. It is of type STRING.
+ -A | --vf-model-uuid model uuid for vf. It is of type STRING.
+ -n | --vf-model-name vf model name. It is of type STRING.
+ -o | --vf-model-version vf model version. It is of type STRING.
+ -q | --vf-model-customization-id vf model customization id. This can be obtained
+ using SDC portal (Home -> service:xxx ->
+ Composition -> click on VF for customization id).
+ It is of type STRING.
+ -r | --service-model-invariant-id model invariant id. It is of type STRING.
+ -w | --service-model-uuid model name version id. It is of type STRING.
+ -x | --service-model-name service model name. It is of type STRING.
+ -z | --service-model-version service model version. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Results::
- name VSP Name and is of type STRING.
- ID VSP ID and is of type STRING.
- description Description for the VSP and is of type STRING.
- vendor-name Vendor name and is of type STRING.
- vendor-id Vendor id 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.
+ vfmodule-id id for the created vnf and is of type STRING.
Error::
@@ -825,72 +791,77 @@ Error::
-[15] vsp-create
+[9] vf-create
-----------------------------------------------
-usage: onap vsp-create
+usage: oclip vf-create
-Create Vendor Software Product
+Create a VF
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: so
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vsp-name] [-y | --vsp-description] [-z | --vsp-category]
- [-b | --vsp-subcategory] [-c | --vlm-version] [-e | --vlm-vendor]
- [-g | --vlm-id] [-i | --vlm-agreement-id] [-j | --vlm-feature-group-id]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-l | --cloud-region] [-z | --tenant-id] [-w | --product-family]
+ [-o | --instance-name] [-y | --service-instance-id] [-b | --vf-model-invariant-id]
+ [-c | --vf-model-uuid] [-e | --vf-model-name] [-g | --vf-model-version]
+ [-i | --vf-model-customization-id] [-j | --service-model-invariant-id] [-k | --service-model-uuid]
+ [-q | --service-model-name] [-n | --service-model-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --vsp-name Onap VSP Name. It is of type STRING.
- -y | --vsp-description Description for VSP. It is of type STRING. It is
- optional.
- -z | --vsp-category Category of the VSP. It is of type STRING. It is
- optional. By default, it is
- resourceNewCategory.generic.
- -b | --vsp-subcategory Sub Category of VSP. It is of type STRING. It is
- optional. By default, it is
- resourceNewCategory.generic.abstract.
- -c | --vlm-version License version. It is of type STRING. It is
- optional. By default, it is 1.0.
- -e | --vlm-vendor License Model vendor. It is of type STRING.
- -g | --vlm-id License Model ID. It is of type STRING.
- -i | --vlm-agreement-id License Agreement ID. It is of type STRING.
- -j | --vlm-feature-group-id Feature Group ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -l | --cloud-region cloud region identifier. It is of type STRING.
+ -z | --tenant-id openstack tenant id. It is of type STRING.
+ -w | --product-family service type for serivce (e.g. vLB). It is of
+ type STRING.
+ -o | --instance-name service instance name. It is of type STRING.
+ -y | --service-instance-id unique id for service instance. It is of type
+ STRING.
+ -b | --vf-model-invariant-id vf model invariant id. It is of type STRING.
+ -c | --vf-model-uuid model uuid for vf. It is of type STRING.
+ -e | --vf-model-name vf model name. It is of type STRING.
+ -g | --vf-model-version vf model version. It is of type STRING.
+ -i | --vf-model-customization-id vf model customization id. It is of type STRING.
+ -j | --service-model-invariant-id model invariant id. It is of type STRING.
+ -k | --service-model-uuid model name version id. It is of type STRING.
+ -q | --service-model-name service model name. It is of type STRING.
+ -n | --service-model-version service model version. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Results::
- ID VSP ID and is of type STRING.
+ vf-id id for the created vnf and is of type STRING.
Error::
@@ -899,106 +870,76 @@ Error::
-[16] vsp-add-artifact
+[10] service-create
-----------------------------------------------
-usage: onap vsp-add-artifact
+usage: oclip service-create
-Upload the CSAR file to VSP
+Create a service instance using MSO
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: so
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vsp-id] [-y | --vsp-version] [-z | --vsp-file]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-l | --cloud-region] [-b | --tenant-id] [-e | --model-invariant-id]
+ [-g | --model-uuid] [-i | --model-name] [-j | --model-version]
+ [-c | --customer] [-k | --instance-name] [-r | --supress-rollback]
+ [-w | --service-type] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version Onap VSP version. It is of type STRING.
- -z | --vsp-file CSAR File path. It is of type BINARY.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[17] vsp-revert
------------------------------------------------
-
-
-usage: onap vsp-revert
-
-Revert Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -l | --cloud-region cloud region identifier. It is of type STRING.
+ -b | --tenant-id tenant id. It is of type STRING.
+ -e | --model-invariant-id model invariant id generated by ASDC. It is of
+ type STRING.
+ -g | --model-uuid model uuid generated by ASDC. It is of type
+ STRING.
+ -i | --model-name model name as provided in ASDC design time. It is
+ of type STRING.
+ -j | --model-version model-version. It is of type STRING.
+ -c | --customer unique id for customer. It is of type STRING.
+ -k | --instance-name service instance name. It is of type STRING.
+ -r | --supress-rollback rollback changes if instantiation fails. It is of
+ type BOOL. It is optional. By default, it is
+ false.
+ -w | --service-type subscription service type. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-where::
+Results::
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ service-id instance id for the created service. and is of
+ type STRING.
Error::
@@ -1007,51 +948,67 @@ Error::
-[18] vsp-checkout
+[11] vf-delete
-----------------------------------------------
-usage: onap vsp-checkout
+usage: oclip vf-delete
-Checkout Vendor Software Product
+delete a VF (experimental)
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: so
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vf-id] [-y | --service-instance-id] [-l | --cloud-region]
+ [-z | --tenant-id] [-b | --model-invariant-id] [-c | --model-uuid]
+ [-e | --model-name] [-g | --model-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --vf-id id for vnf. It is of type STRING.
+ -y | --service-instance-id unique id for service instance. It is of type
+ STRING.
+ -l | --cloud-region Cloud region ID. It is of type STRING.
+ -z | --tenant-id openstack tenant id (uuid). It is of type STRING.
+ -b | --model-invariant-id model invariant id for service in SDC catalog. It
+ is of type STRING.
+ -c | --model-uuid model uuid for service in SDC catalog. It is of
+ type STRING.
+ -e | --model-name model name available in SDC catalog. It is of
+ type STRING.
+ -g | --model-version model version of service (eg. 1.0). It is of type
+ STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Error::
@@ -1060,57 +1017,62 @@ Error::
-[19] vsp-validate
+[12] service-model-add-vf
-----------------------------------------------
-usage: onap vsp-validate
+usage: oclip service-model-add-vf
-Validated the uploaded Vendor Software Product
+Helps to add VF into service models in SDC
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --service-model-id] [-y | --vf-id] [-z | --vf-name]
+ [-b | --vf-version] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --service-model-id Onap Service Name. It is of type STRING.
+ -y | --vf-id VF ID. It is of type STRING. It is optional.
+ -z | --vf-name VF ID. It is of type STRING. It is optional.
+ -b | --vf-version VF 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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Results::
- status Validation status and is of type STRING.
- errors Validation messages and is of type JSON.
+ ID Service ID and is of type STRING.
Error::
@@ -1119,37 +1081,31 @@ Error::
-[20] vsp-list
+[13] vsp-revert
-----------------------------------------------
-usage: onap vsp-list
+usage: oclip vsp-revert
-List of the Vendor Software Products
+Revert Vendor Software Product
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -1160,60 +1116,52 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vsp-id Onap VSP ID. It is of type STRING.
+ -y | --vsp-version VSP version. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
-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 <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[21] vsp-checkin
+[14] vsp-validate
-----------------------------------------------
-usage: onap vsp-checkin
+usage: oclip vsp-validate
-Checkin Vendor Software Product
+Validated the uploaded Vendor Software Product
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -1224,49 +1172,58 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vsp-id Onap VSP ID. It is of type STRING.
+ -y | --vsp-version VSP version. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
+Results::
+
+ status Validation status and is of type STRING.
+ errors Validation messages and is of type JSON.
+
+
Error::
On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[22] service-model-checkin
+[15] service-model-approve
-----------------------------------------------
-usage: onap service-model-checkin
+usage: oclip service-model-approve
-Checkin Service model in SDC
+Approves the Service model in SDC
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -b | --service-model-id Service model ID. It is of type STRING. It is
- optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -1277,6 +1234,17 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -b | --service-model-id Service model ID. 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -1287,39 +1255,31 @@ Error::
-[23] service-model-distribute
+[16] service-model-certify-start
-----------------------------------------------
-usage: onap service-model-distribute
+usage: oclip service-model-certify-start
-Distributes the Service model in SDC
+Starts the certification of Service model in SDC
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -b | --service-model-id Service model ID. It is of type STRING. It is
- optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -1330,6 +1290,17 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -b | --service-model-id Service model ID. 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -1340,101 +1311,31 @@ Error::
-[24] service-model-list
+[17] service-model-checkin
-----------------------------------------------
-usage: onap service-model-list
+usage: oclip service-model-checkin
-List the service model in SDC
+Checkin Service model in SDC
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-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 <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[25] service-model-certify-start
------------------------------------------------
-
-
-usage: onap service-model-certify-start
-
-Starts the certification of Service model in SDC
-
-Onap service: sdc v1.0
-
-Options::
-
- [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -b | --service-model-id Service model ID. It is of type STRING. It is
- optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -1445,6 +1346,17 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -b | --service-model-id Service model ID. 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -1455,54 +1367,66 @@ Error::
-[26] service-model-add-vf
+[18] service-model-create
-----------------------------------------------
-usage: onap service-model-add-vf
+usage: oclip service-model-create
-Helps to add VF into service models in SDC
+Create Service model in SDC
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --service-model-id] [-y | --vf-id] [-z | --vf-name]
- [-b | --vf-version] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --name] [-y | --description] [-z | --project-code]
+ [-b | --category] [-c | --category-display-name] [-e | --icon-id]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --service-model-id Onap Service Name. It is of type STRING.
- -y | --vf-id VF ID. It is of type STRING. It is optional.
- -z | --vf-name VF ID. It is of type STRING. It is optional.
- -b | --vf-version VF version. It is of type STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --name Onap Service Name. It is of type STRING.
+ -y | --description Description for Service. It is of type STRING. It
+ is optional.
+ -z | --project-code Project code. It is of type STRING. It is
+ optional.
+ -b | --category Service category. It is of type STRING. It is
+ optional. By default, it is network l1-3.
+ -c | --category-display-name Service category display name. It is of type
+ STRING. It is optional. By default, it is Network
+ L1-3.
+ -e | --icon-id Service Icon id. It is of type STRING. It is
+ optional. By default, it is defaulticon.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Results::
@@ -1516,39 +1440,31 @@ Error::
-[27] service-model-certify-request
+[19] service-model-checkout
-----------------------------------------------
-usage: onap service-model-certify-request
+usage: oclip service-model-checkout
-Request the certification of Service model in SDC
+Checkout Service model in SDC
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -b | --service-model-id Service model ID. It is of type STRING. It is
- optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -1559,6 +1475,17 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -b | --service-model-id Service model ID. 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -1569,39 +1496,31 @@ Error::
-[28] service-model-revert
+[20] service-model-certify-request
-----------------------------------------------
-usage: onap service-model-revert
+usage: oclip service-model-certify-request
-Checkout Service model in SDC
+Request the certification of Service model in SDC
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -b | --service-model-id Service model ID. It is of type STRING. It is
- optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -1612,6 +1531,17 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -b | --service-model-id Service model ID. 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -1622,39 +1552,31 @@ Error::
-[29] service-model-checkout
+[21] service-model-revert
-----------------------------------------------
-usage: onap service-model-checkout
+usage: oclip service-model-revert
Checkout Service model in SDC
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -b | --service-model-id Service model ID. It is of type STRING. It is
- optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -1665,59 +1587,17 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[30] service-model-certify-complete
------------------------------------------------
-
-
-usage: onap service-model-certify-complete
-
-Completes the certification of Service model in SDC
-
-Onap service: sdc v1.0
-
-Options::
-
- [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
-b | --service-model-id Service model ID. It is of type STRING. It is
optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
+ -u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
+ OPEN_CLI_HOST_USERNAME.
+ -p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
+ 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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -1728,38 +1608,31 @@ Error::
-[31] service2vf-model-list
+[22] service-model-distribute
-----------------------------------------------
-usage: onap service2vf-model-list
+usage: oclip service-model-distribute
-List the VF in a given service model in SDC
+Distributes the Service model in SDC
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-z | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -z | --service-model-id Service model uuid. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -1770,86 +1643,84 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -b | --service-model-id Service model ID. 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
-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 <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[32] service-model-create
+[23] service-model-list
-----------------------------------------------
-usage: onap service-model-create
+usage: oclip service-model-list
-Create Service model in SDC
+List the service model in SDC
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --name] [-y | --description] [-z | --project-code]
- [-b | --category] [-c | --category-display-name] [-e | --icon-id]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
[-a | --no-auth]
where::
- -x | --name Onap Service Name. It is of type STRING.
- -y | --description Description for Service. It is of type STRING. It
- is optional.
- -z | --project-code Project code. It is of type STRING. It is
- optional.
- -b | --category Service category. It is of type STRING. It is
- optional. By default, it is network l1-3.
- -c | --category-display-name Service category display name. It is of type
- STRING. It is optional. By default, it is Network
- L1-3.
- -e | --icon-id Service Icon id. It is of type STRING. It is
- optional. By default, it is defaulticon.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Results::
- ID Service ID and is of type STRING.
+ 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::
@@ -1858,39 +1729,31 @@ Error::
-[33] service-model-approve
+[24] service2vf-model-list
-----------------------------------------------
-usage: onap service-model-approve
+usage: oclip service2vf-model-list
-Approves the Service model in SDC
+List the VF in a given service model in SDC
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-z | --service-model-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -b | --service-model-id Service model ID. It is of type STRING. It is
- optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -1901,54 +1764,59 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -z | --service-model-id Service model uuid. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
+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 <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[34] vf-model-create
+[25] vf-model-certify-complete
-----------------------------------------------
-usage: onap vf-model-create
+usage: oclip vf-model-certify-complete
-Create Virtual function from Vendor Software Product
+Complete certifying Virtual function
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --name] [-y | --description] [-z | --vendor-name]
- [-b | --vsp-id] [-g | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-b | --vf-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -x | --name Onap VF Name. It is of type STRING.
- -y | --description Description for VF. It is of type STRING. It is
- optional.
- -z | --vendor-name Vendor name. It is of type STRING. It is optional.
- -b | --vsp-id VSP ID. It is of type STRING. It is optional.
- -g | --vsp-version VSP version. It is of type STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -1959,53 +1827,51 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -b | --vf-id VF ID. 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
-Results::
-
- ID VF ID and is of type STRING.
-
-
Error::
On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[35] vf-model-checkin
+[26] vf-model-certify-request
-----------------------------------------------
-usage: onap vf-model-checkin
+usage: oclip vf-model-certify-request
-Checkin Virtual function
+Request for certifying Virtual function
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-b | --vf-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-b | --vf-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -b | --vf-id VF ID. It is of type STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -2016,6 +1882,16 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -b | --vf-id VF ID. 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -2026,39 +1902,31 @@ Error::
-[36] vlm-revert
+[27] vf-model-certify-start
-----------------------------------------------
-usage: onap vlm-revert
+usage: oclip vf-model-certify-start
-Revert Vendor License Model
+Start certifying Virtual function
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-b | --vf-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -x | --vlm-id Onap VLM ID. It is of type STRING.
- -y | --vlm-version VLM version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -2069,6 +1937,16 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -b | --vf-id VF ID. 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -2079,106 +1957,31 @@ Error::
-[37] vlm-feature-group-create
------------------------------------------------
-
-
-usage: onap vlm-feature-group-create
-
-Create feature group Pool
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --name] [-y | --vlm-id] [-e | --vlm-version]
- [-z | --description] [-g | --vlm-key-group-id] [-b | --vlm-entitle-pool-id]
- [-c | --part-number] [-k | --manufacture-reference-number] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --name Feature group name. It is of type STRING.
- -y | --vlm-id License Model ID. It is of type STRING.
- -e | --vlm-version License Model version. It is of type STRING.
- -z | --description Description for feature group. It is of type
- STRING.
- -g | --vlm-key-group-id VLM keygroup. It is of type STRING.
- -b | --vlm-entitle-pool-id VLM Entitlement pool. It is of type STRING.
- -c | --part-number Part number. It is of type STRING.
- -k | --manufacture-reference-number Manufature Reference Number. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID Feature group ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[38] vlm-submit
+[28] vf-model-checkin
-----------------------------------------------
-usage: onap vlm-submit
+usage: oclip vf-model-checkin
-Submit Vendor License Model
+Checkin Virtual function
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-b | --vf-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -x | --vlm-id Onap VLM ID. It is of type STRING.
- -y | --vlm-version VLM version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -2189,6 +1992,16 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -b | --vf-id VF ID. 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -2199,38 +2012,32 @@ Error::
-[39] vf-model-certify-start
+[29] vf-model-create
-----------------------------------------------
-usage: onap vf-model-certify-start
+usage: oclip vf-model-create
-Start certifying Virtual function
+Create Virtual function from Vendor Software Product
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-b | --vf-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --name] [-y | --description] [-z | --vendor-name]
+ [-b | --vsp-id] [-g | --vsp-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -b | --vf-id VF ID. It is of type STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -2241,47 +2048,61 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --name Onap VF Name. It is of type STRING.
+ -y | --description Description for VF. It is of type STRING. It is
+ optional.
+ -z | --vendor-name Vendor name. It is of type STRING. It is optional.
+ -b | --vsp-id VSP ID. It is of type STRING. It is optional.
+ -g | --vsp-version VSP 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
+Results::
+
+ ID VF ID and is of type STRING.
+
+
Error::
On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[40] vf-model-list
+[30] vf-model-list
-----------------------------------------------
-usage: onap vf-model-list
+usage: oclip vf-model-list
List the VF resource model in SDC
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
[-a | --no-auth]
where::
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -2292,6 +2113,15 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -2315,39 +2145,31 @@ Error::
-[41] vlm-entitlement-pool-list
+[31] vf2vfmodule-model-list
-----------------------------------------------
-usage: onap vlm-entitlement-pool-list
+usage: oclip vf2vfmodule-model-list
-entitlement pool list in a license model
+List the VF modules in a given VF model in SDC
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-z | --vf-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -x | --vlm-id License Model ID. It is of type STRING.
- -y | --vlm-version License Model version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -2358,14 +2180,28 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -z | --vf-id VF uuid. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
Results::
- ID Feature group ID and is of type STRING.
- name Feature group name and is of type STRING.
+ vsp-uuid VSP uuid and is of type STRING.
+ vsp-version VSP version and is of type STRING.
+ module-uuid UUID and is of type STRING.
+ module-invariant-uuid Invariant UUID and is of type STRING.
+ module-name name and is of type STRING.
+ module-version version and is of type STRING.
Error::
@@ -2374,57 +2210,70 @@ Error::
-[42] vlm-feature-group-list
+[32] ep-create
-----------------------------------------------
-usage: onap vlm-feature-group-list
+usage: oclip ep-create
-Feature group list in a license model
+Create Entitlement Pool
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --ep-name] [-y | --license-model-id] [-z | --ep-description]
+ [-q | --threshold-value] [-b | --threshold-unit] [-c | --entitlement-metric]
+ [-e | --aggregation-function] [-g | --operational-scope] [-k | --reference-number]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --vlm-id License Model ID. It is of type STRING.
- -y | --vlm-version License Model version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --ep-name Entitlement Pool name. It is of type STRING.
+ -y | --license-model-id License Model ID. It is of type STRING.
+ -z | --ep-description Description for Entitlement Pool. It is of type
+ STRING.
+ -q | --threshold-value threshold. It is of type STRING.
+ -b | --threshold-unit threshold. It is of type STRING.
+ -c | --entitlement-metric Entitlement Metric. It is of type STRING.
+ -e | --aggregation-function Aggregation Function. It is of type STRING.
+ -g | --operational-scope Operational Scope. It is of type STRING.
+ -k | --reference-number Reference Number. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Results::
- ID Feature group ID and is of type STRING.
- name Feature group name and is of type STRING.
+ ID Entitlement Pool ID and is of type STRING.
Error::
@@ -2433,51 +2282,62 @@ Error::
-[43] vlm-checkout
+[33] ep-show
-----------------------------------------------
-usage: onap vlm-checkout
+usage: oclip ep-show
-Checkout Vendor License Model
+Details of the Entitlement Pool
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --license-model-id] [-y | --pool-id] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --vlm-id Onap VLM ID. It is of type STRING.
- -y | --vlm-version VLM version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --license-model-id Onap License Model ID. It is of type STRING.
+ -y | --pool-id Onap Entitlement Pool ID. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
+
+
+Results::
+
+ name Entitlement Pool Name and is of type STRING.
+ ID Entitlement Pool ID and is of type STRING.
+ description Description for the Entitlement Pool and is of
+ type STRING.
Error::
@@ -2486,58 +2346,62 @@ Error::
-[44] vlm-list
+[34] license-group-create
-----------------------------------------------
-usage: onap vlm-list
+usage: oclip license-group-create
-List License Model
+Create License Group
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --group-name] [-y | --license-model-id] [-z | --license-group-description]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
[-a | --no-auth]
where::
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --group-name group name. It is of type STRING.
+ -y | --license-model-id License Model ID. It is of type STRING.
+ -z | --license-group-description Description for License Group. 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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Results::
- id License ID and is of type UUID.
- vendor-name Vendor Name and is of type STRING.
- vlm-version VLM version and is of type STRING.
- status status and is of type STRING.
- description License description and is of type STRING.
+ ID License Group ID and is of type STRING.
Error::
@@ -2546,43 +2410,158 @@ Error::
-[45] vlm-aggreement-create
+[35] license-group-show
-----------------------------------------------
-usage: onap vlm-aggreement-create
+usage: oclip license-group-show
+
+Details of the License Group
+
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --license-model-id] [-y | --license-group-id] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
+
+where::
+
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --license-model-id Onap License Model ID. It is of type STRING.
+ -y | --license-group-id Onap License Group ID. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
+
+
+Results::
+
+ name License Group Name and is of type STRING.
+ ID License Group ID and is of type STRING.
+ description Description for the License Group and is of type
+ STRING.
+
+
+Error::
+
+ On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+
+[36] license-model-create
+-----------------------------------------------
+
+
+usage: oclip license-model-create
+
+Create License Model
+
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vendor-name] [-y | --license-model-description] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
+
+where::
+
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --vendor-name vendor name. It is of type STRING.
+ -y | --license-model-description Description for License Model. 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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
+
+
+Results::
+
+ ID License Model ID and is of type STRING.
+
+
+Error::
+
+ On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+
+[37] vlm-aggreement-create
+-----------------------------------------------
+
+
+usage: oclip vlm-aggreement-create
Create license aggreement
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
[-x | --name] [-y | --vlm-id] [-e | --vlm-version]
- [-z | --description] [-g | --vlm-feature-group-id] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-z | --description] [-g | --vlm-feature-group-id] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --name aggreement name. It is of type STRING.
- -y | --vlm-id License Model ID. It is of type STRING.
- -e | --vlm-version License Model version. It is of type STRING.
- -z | --description Description for aggreement. It is of type STRING.
- -g | --vlm-feature-group-id VLM feature group. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -2593,6 +2572,20 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --name aggreement name. It is of type STRING.
+ -y | --vlm-id License Model ID. It is of type STRING.
+ -e | --vlm-version License Model version. It is of type STRING.
+ -z | --description Description for aggreement. It is of type STRING.
+ -g | --vlm-feature-group-id VLM feature group. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -2608,38 +2601,31 @@ Error::
-[46] vf-model-certify-request
+[38] vlm-checkin
-----------------------------------------------
-usage: onap vf-model-certify-request
+usage: oclip vlm-checkin
-Request for certifying Virtual function
+Checkin Vendor License Model
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-b | --vf-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -b | --vf-id VF ID. It is of type STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -2650,6 +2636,17 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vlm-id Onap VLM ID. It is of type STRING.
+ -y | --vlm-version VLM version. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -2660,38 +2657,31 @@ Error::
-[47] vf2vfmodule-model-list
+[39] vlm-create
-----------------------------------------------
-usage: onap vf2vfmodule-model-list
+usage: oclip vlm-create
-List the VF modules in a given VF model in SDC
+Create License Model
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-z | --vf-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vendor-name] [-y | --description] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -z | --vf-id VF uuid. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -2702,18 +2692,25 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vendor-name vendor name. It is of type STRING.
+ -y | --description Description for License Model. 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
Results::
- vsp-uuid VSP uuid and is of type STRING.
- vsp-version VSP version and is of type STRING.
- module-uuid UUID and is of type STRING.
- module-invariant-uuid Invariant UUID and is of type STRING.
- module-name name and is of type STRING.
- module-version version and is of type STRING.
+ ID License Model ID and is of type UUID.
Error::
@@ -2722,38 +2719,31 @@ Error::
-[48] vf-model-certify-complete
+[40] vlm-entitlement-pool-list
-----------------------------------------------
-usage: onap vf-model-certify-complete
+usage: oclip vlm-entitlement-pool-list
-Complete certifying Virtual function
+entitlement pool list in a license model
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-b | --vf-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -b | --vf-id VF ID. It is of type STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -2764,47 +2754,129 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vlm-id License Model ID. It is of type STRING.
+ -y | --vlm-version License Model version. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
+Results::
+
+ ID Feature group ID and is of type STRING.
+ name Feature group name and is of type STRING.
+
+
Error::
On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[49] cloud-list
+[41] vlm-feature-group-create
-----------------------------------------------
-usage: onap cloud-list
+usage: oclip vlm-feature-group-create
-List the configured clouds and Onap service subscriptions
+Create feature group Pool
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-x | --name] [-y | --vlm-id] [-e | --vlm-version]
+ [-z | --description] [-g | --vlm-key-group-id] [-b | --vlm-entitle-pool-id]
+ [-c | --part-number] [-k | --manufacture-reference-number] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --name Feature group name. It is of type STRING.
+ -y | --vlm-id License Model ID. It is of type STRING.
+ -e | --vlm-version License Model version. It is of type STRING.
+ -z | --description Description for feature group. It is of type
+ STRING.
+ -g | --vlm-key-group-id VLM keygroup. It is of type STRING.
+ -b | --vlm-entitle-pool-id VLM Entitlement pool. It is of type STRING.
+ -c | --part-number Part number. It is of type STRING.
+ -k | --manufacture-reference-number Manufature Reference Number. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
+
+
+Results::
+
+ ID Feature group ID and is of type STRING.
+
+
+Error::
+
+ On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+
+[42] vlm-key-group-create
+-----------------------------------------------
+
+
+usage: oclip vlm-key-group-create
+
+Create License Key Group
+
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-c | --vlm-id] [-e | --vlm-version] [-x | --name]
+ [-y | --type] [-z | --description] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
+
+where::
+
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -2815,19 +2887,29 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -c | --vlm-id License Model Id. It is of type STRING.
+ -e | --vlm-version License Model version. It is of type STRING.
+ -x | --name name. It is of type STRING.
+ -y | --type type of group (Universal, unique, one-time). It
+ is of type STRING. By default, it is Universal.
+ -z | --description Description for License Key Group. 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
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.
+ ID License Model ID and is of type STRING.
Error::
@@ -2836,37 +2918,31 @@ Error::
-[50] sdnc-list
+[43] vlm-list
-----------------------------------------------
-usage: onap sdnc-list
+usage: oclip vlm-list
-List the configured sdnc
+List License Model
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
[-a | --no-auth]
where::
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -2877,14 +2953,26 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
Results::
- sdnc-id Onap sdnc id and is of type STRING.
- resource-version Onap sdnc resource version and is of type STRING.
+ id License ID and is of type UUID.
+ vendor-name Vendor Name and is of type STRING.
+ vlm-version VLM version and is of type STRING.
+ status status and is of type STRING.
+ description License description and is of type STRING.
Error::
@@ -2893,57 +2981,31 @@ Error::
-[51] sdnc-register
+[44] vlm-submit
-----------------------------------------------
-usage: onap sdnc-register
+usage: oclip vlm-submit
-Register a SDNC in Onap
+Submit Vendor License Model
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --location] [-y | --sdnc-id] [-b | --name]
- [-c | --type] [-e | --vendor] [-q | --sdnc-version]
- [-g | --ip-address] [-k | --port] [-r | --protocal]
- [-i | --username] [-j | --password] [-z | --product-name]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --location Onap VIM unique id. It is of type UUID. By
- default, it is
- 2821b55f-121c-47a8-8b47-6a555ce54e19.
- -y | --sdnc-id Onap SDNC unique id. It is of type UUID. By
- default, it is
- d5575325-4d90-4ead-9656-8186504e9a88.
- -b | --name Onap SDNC name. It is of type STRING.
- -c | --type Onap SDNC type. It is of type STRING.
- -e | --vendor Onap SDNC vendor. It is of type STRING.
- -q | --sdnc-version Onap SDNC version. It is of type STRING.
- -g | --ip-address Onap SDNC ip address. It is of type STRING.
- -k | --port Onap SDNC port. It is of type STRING.
- -r | --protocal Onap SDNC protocal. It is of type STRING.
- -i | --username Onap SDNC username. It is of type STRING.
- -j | --password Onap SDNC password. It is of type STRING.
- -z | --product-name Onap SDNC product-name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -2954,6 +3016,17 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vlm-id Onap VLM ID. It is of type STRING.
+ -y | --vlm-version VLM version. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -2964,38 +3037,31 @@ Error::
-[52] sdnc-unregister
+[45] vsp-checkin
-----------------------------------------------
-usage: onap sdnc-unregister
+usage: oclip vsp-checkin
-Un-register a VNFM in Onap
+Checkin Vendor Software Product
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --sdnc-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --sdnc-id Onap VNFM unique id. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -3006,6 +3072,17 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vsp-id Onap VSP ID. It is of type STRING.
+ -y | --vsp-version VSP version. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -3016,40 +3093,108 @@ Error::
-[53] vnfm-show
+[46] vsp-create
-----------------------------------------------
-usage: onap vnfm-show
+usage: oclip vsp-create
-Show the VNFM in Onap
+Create Vendor Software Product
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vnfm-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vsp-name] [-y | --vsp-description] [-z | --vsp-category]
+ [-b | --vsp-subcategory] [-c | --vlm-version] [-e | --vlm-vendor]
+ [-g | --vlm-id] [-i | --vlm-agreement-id] [-j | --vlm-feature-group-id]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --vnfm-id Onap VNFM unique id. It is of type UUID. By
- default, it is
- 16d1e277-973c-409c-b221-5fd57cc7100a.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --vsp-name Onap VSP Name. It is of type STRING.
+ -y | --vsp-description Description for VSP. It is of type STRING. It is
+ optional.
+ -z | --vsp-category Category of the VSP. It is of type STRING. It is
+ optional. By default, it is
+ resourceNewCategory.generic.
+ -b | --vsp-subcategory Sub Category of VSP. It is of type STRING. It is
+ optional. By default, it is
+ resourceNewCategory.generic.abstract.
+ -c | --vlm-version License version. It is of type STRING. It is
+ optional. By default, it is 1.0.
+ -e | --vlm-vendor License Model vendor. It is of type STRING.
+ -g | --vlm-id License Model ID. It is of type STRING.
+ -i | --vlm-agreement-id License Agreement ID. It is of type STRING.
+ -j | --vlm-feature-group-id Feature Group ID. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
+
+
+Results::
+
+ ID VSP ID and is of type STRING.
+
+
+Error::
+
+ On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+
+[47] vsp-package
+-----------------------------------------------
+
+
+usage: oclip vsp-package
+
+Package Vendor Software Product
+
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
+
+where::
+
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -3060,18 +3205,75 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vsp-id Onap VSP ID. It is of type STRING.
+ -y | --vsp-version VSP version. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
-Results::
+Error::
+
+ On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
- 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.
+
+
+[48] vsp-submit
+-----------------------------------------------
+
+
+usage: oclip vsp-submit
+
+Submit Vendor Software Product
+
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
+
+where::
+
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --vsp-id Onap VSP ID. It is of type STRING.
+ -y | --vsp-version VSP version. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Error::
@@ -3080,42 +3282,31 @@ Error::
-[54] vnfm-unregister
+[49] service-model-certify-complete
-----------------------------------------------
-usage: onap vnfm-unregister
+usage: oclip service-model-certify-complete
-Un-register a VNFM in Onap
+Completes the certification of Service model in SDC
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vnfm-id] [-y | --resource-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -x | --vnfm-id Onap VNFM unique id. It is of type UUID. By
- default, it is
- b6271696-01e3-43eb-a7f2-11d3b24746c4.
- -y | --resource-version Onap vim resource version. It is of type STRING.
- It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -3126,6 +3317,17 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -b | --service-model-id Service model ID. 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -3136,55 +3338,31 @@ Error::
-[55] vnfm-register
+[50] license-model-show
-----------------------------------------------
-usage: onap vnfm-register
+usage: oclip license-model-show
-Register a VNFM in Onap
+Details of the License Model
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vim-id] [-y | --vnfm-id] [-b | --name]
- [-c | --type] [-e | --vendor] [-q | --vnfm-version]
- [-g | --url] [-i | --username] [-j | --password]
- [-z | --certificate-url] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --license-model-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -x | --vim-id Onap VIM unique id. It is of type UUID. By
- default, it is
- 061e5c37-2a9a-4775-80e4-d15891a22ae4.
- -y | --vnfm-id Onap VNFM unique id. It is of type UUID. By
- default, it is
- 2e8957a6-75af-4508-9949-bf17eb7cf76a.
- -b | --name Onap VNFM name. It is of type STRING.
- -c | --type Onap VNFM type. It is of type STRING.
- -e | --vendor Onap VNFM vendor. It is of type STRING.
- -q | --vnfm-version Onap VNFM version. It is of type STRING.
- -g | --url Onap VNFM URL. It is of type STRING.
- -i | --username Onap VNFM username. It is of type STRING.
- -j | --password Onap VNFM password. It is of type STRING.
- -z | --certificate-url Onap VNFM certificate-url. It is of type STRING.
- It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -3195,47 +3373,60 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --license-model-id Onap License Model ID. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
+Results::
+
+ name License Model Name and is of type STRING.
+ ID License Model ID and is of type STRING.
+ description Description for the License Model and is of type
+ STRING.
+ status Status of the License Model and is of type STRING.
+
+
Error::
On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[56] vnfm-list
+[51] vlm-aggreement-list
-----------------------------------------------
-usage: onap vnfm-list
+usage: oclip vlm-aggreement-list
-List the configured vnfm
+List license aggreement
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -3246,16 +3437,25 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vlm-id License Model ID. It is of type STRING.
+ -y | --vlm-version License Model version. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
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.
+ ID aggreement ID and is of type STRING.
+ name aggreement name and is of type STRING.
Error::
@@ -3264,59 +3464,31 @@ Error::
-[57] vim-register
+[52] vlm-checkout
-----------------------------------------------
-usage: onap vim-register
+usage: oclip vlm-checkout
-Register a VIM under a given cloud region in Onap
+Checkout Vendor License Model
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --cloud-name] [-y | --region-name] [-z | --vim-id]
- [-b | --name] [-c | --type] [-e | --vendor]
- [-q | --vim-version] [-g | --url] [-i | --username]
- [-j | --password] [-k | --ssl-cacert] [-l | --ssl-insecure]
- [-n | --cloud-domain] [-o | --default-tenant] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --cloud-name Onap cloud name. It is of type STRING.
- -y | --region-name Onap region name. It is of type STRING.
- -z | --vim-id Onap VIM unique id. It is of type UUID. By
- default, it is
- 545935b3-ca9c-4cbf-bfb4-4a7297010aff.
- -b | --name Onap VIM name. It is of type STRING.
- -c | --type Onap VIM type. It is of type STRING.
- -e | --vendor Onap VIM vendor. It is of type STRING.
- -q | --vim-version Onap VIM version. It is of type STRING.
- -g | --url Onap VIM URL. It is of type STRING.
- -i | --username Onap VIM username. It is of type STRING.
- -j | --password Onap VIM password. It is of type STRING.
- -k | --ssl-cacert Onap VIM SSL certificate. It is of type TEXT. It
- is optional.
- -l | --ssl-insecure Onap VIM insecure. It is of type BOOL. It is
- optional. By default, it is false.
- -n | --cloud-domain Onap VIM cloud domain. It is of type STRING.
- -o | --default-tenant Onap VIM default tenant. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -3327,6 +3499,17 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vlm-id Onap VLM ID. It is of type STRING.
+ -y | --vlm-version VLM version. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -3337,57 +3520,67 @@ Error::
-[58] vim-unregister
+[53] vlm-entitlement-pool-create
-----------------------------------------------
-usage: onap vim-unregister
+usage: oclip vlm-entitlement-pool-create
-Un-register a VIM under from cloud region in Onap
+Create Entitlement Pool
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --cloud-name] [-y | --region-name] [-z | --vim-id]
- [-b | --resource-version] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --name] [-y | --vlm-id] [-e | --vlm-version]
+ [-z | --description] [-g | --operational-scope] [-k | --manufacture-reference-number]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --cloud-name Onap cloud name. It is of type STRING.
- -y | --region-name Onap region name. It is of type STRING.
- -z | --vim-id Onap VIM unique id. It is of type UUID. By
- default, it is
- 0e129921-5700-48e2-ab9a-e4e4208d8b6b.
- -b | --resource-version Onap vim resource version. It is of type STRING.
- It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --name Entitlement Pool name. It is of type STRING.
+ -y | --vlm-id License Model ID. It is of type STRING.
+ -e | --vlm-version License Model version. It is of type STRING.
+ -z | --description Description for Entitlement Pool. It is of type
+ STRING.
+ -g | --operational-scope Operational Scope. It is of type STRING. By
+ default, it is Availability_Zone.
+ -k | --manufacture-reference-number Manufature Reference Number. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
+
+
+Results::
+
+ ID Entitlement Pool ID and is of type STRING.
Error::
@@ -3396,39 +3589,31 @@ Error::
-[59] vim-list
+[54] vlm-feature-group-list
-----------------------------------------------
-usage: onap vim-list
+usage: oclip vlm-feature-group-list
-List the configured vims
+Feature group list in a license model
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --cloud-name] [-y | --region-name] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --cloud-name Onap cloud name. It is of type STRING.
- -y | --region-name Onap region name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -3439,22 +3624,25 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vlm-id License Model ID. It is of type STRING.
+ -y | --vlm-version License Model version. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
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.
+ ID Feature group ID and is of type STRING.
+ name Feature group name and is of type STRING.
Error::
@@ -3463,37 +3651,31 @@ Error::
-[60] ems-list
+[55] vlm-key-group-list
-----------------------------------------------
-usage: onap ems-list
+usage: oclip vlm-key-group-list
-List the configured ems
+key group list in a license model
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -3504,14 +3686,25 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vlm-id License Model ID. It is of type STRING.
+ -y | --vlm-version License Model version. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
Results::
- ems-id Onap ems id and is of type STRING.
- resource-version Onap ems resource version and is of type STRING.
+ ID Feature group ID and is of type STRING.
+ name Feature group name and is of type STRING.
Error::
@@ -3520,51 +3713,31 @@ Error::
-[61] ems-register
+[56] vlm-revert
-----------------------------------------------
-usage: onap ems-register
+usage: oclip vlm-revert
-Register a EMS in Onap
+Revert Vendor License Model
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-z | --ems-id] [-b | --name] [-c | --type]
- [-e | --vendor] [-q | --ems-version] [-g | --url]
- [-i | --username] [-j | --password] [-x | --remote-path]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -z | --ems-id Onap EMS unique id. It is of type UUID. By
- default, it is
- 0f51b629-46dd-4c1d-bc23-c76d84e72bc2.
- -b | --name Onap EMS name. It is of type STRING.
- -c | --type Onap EMS type. It is of type STRING.
- -e | --vendor Onap EMS vendor. It is of type STRING.
- -q | --ems-version Onap EMS version. It is of type STRING.
- -g | --url Onap EMS URL. It is of type STRING.
- -i | --username Onap EMS username. It is of type STRING.
- -j | --password Onap EMS password. It is of type STRING.
- -x | --remote-path Onap EMS remote-path. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -3575,6 +3748,17 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vlm-id Onap VLM ID. It is of type STRING.
+ -y | --vlm-version VLM version. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -3585,40 +3769,32 @@ Error::
-[62] ems-show
+[57] vsp-add-artifact
-----------------------------------------------
-usage: onap ems-show
+usage: oclip vsp-add-artifact
-Show the details of configured ems
+Upload the CSAR file to VSP
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --ems-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vsp-id] [-y | --vsp-version] [-z | --vsp-file]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --ems-id Onap EMS unique id. It is of type UUID. By
- default, it is
- 9b59cd0e-43c1-47d3-b943-4c9c23f49732.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -3629,75 +3805,76 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vsp-id Onap VSP ID. It is of type STRING.
+ -y | --vsp-version Onap VSP version. It is of type STRING.
+ -z | --vsp-file CSAR File path. It is of type BINARY.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
-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 <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[63] cloud-delete
+[58] vsp-checkout
-----------------------------------------------
-usage: onap cloud-delete
+usage: oclip vsp-checkout
-Delete a cloud region from Onap
+Checkout Vendor Software Product
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --cloud-name] [-y | --region-name] [-z | --resource-version]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --cloud-name Onap cloud name. It is of type STRING.
- -y | --region-name Onap cloud region name. It is of type STRING.
- -z | --resource-version Onap cloud region version. It is of type UUID. It
- is optional. By default, it is
- efef37f1-f030-4bd2-b699-0a0e9c0ceb54.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --vsp-id Onap VSP ID. It is of type STRING.
+ -y | --vsp-version VSP version. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Error::
@@ -3706,54 +3883,63 @@ Error::
-[64] ems-unregister
+[59] vsp-list
-----------------------------------------------
-usage: onap ems-unregister
+usage: oclip vsp-list
-Un-register a EMS in Onap
+List of the Vendor Software Products
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --ems-id] [-y | --resource-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --ems-id Onap EMS unique id. It is of type UUID. By
- default, it is
- 3158d92f-e37b-450c-a86e-55c19309c3d3.
- -y | --resource-version Onap vim resource version. It is of type STRING.
- It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
+
+
+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::
@@ -3762,38 +3948,31 @@ Error::
-[65] subscription-list
+[60] vsp-show
-----------------------------------------------
-usage: onap subscription-list
+usage: oclip vsp-show
-Lists the subscription for a given customer in Onap
+Details of the Vendor Software Product
-Onap service: aai v11
+Product: onap-amsterdam
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --customer-name] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --customer-name Onap customer name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -3804,18 +3983,31 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vsp-id Onap VSP ID. It is of type STRING.
+ -y | --vsp-version Onap VSP version. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
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.
+ name VSP Name and is of type STRING.
+ ID VSP ID and is of type STRING.
+ description Description for the VSP and is of type STRING.
+ vendor-name Vendor name and is of type STRING.
+ vendor-id Vendor id 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.
Error::
@@ -3824,43 +4016,32 @@ Error::
-[66] subscription-create
+[61] microservice-create
-----------------------------------------------
-usage: onap subscription-create
+usage: oclip microservice-create
-Create a subscription of a customer for given service in specific cloud region in Onap
+Register microservice into Onap
-Onap service: aai v11
+Product: onap-amsterdam
+Service: msb
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --customer-name] [-z | --cloud-name] [-r | --cloud-region]
- [-c | --cloud-tenant-id] [-e | --service-type] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --service-name] [-y | --service-version] [-r | --service-url]
+ [-b | --enable-ssl] [-c | --path] <node-ip>
+ <node-port> <create-or-update> [-m | --host-url]
where::
- -x | --customer-name Onap customer name. It is of type STRING.
- -z | --cloud-name Onap cloud name. It is of type STRING.
- -r | --cloud-region Onap cloud region. It is of type STRING.
- -c | --cloud-tenant-id Onap cloud tenant id. It is of type STRING.
- -e | --service-type Onap service type. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -3871,8 +4052,34 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -x | --service-name Onap service name. It is of type STRING.
+ -y | --service-version Onap service version. It is of type STRING.
+ -r | --service-url Onap service base url. It is of type URL.
+ -b | --enable-ssl Onap service is enabled with https or not. It is
+ of type STRING. It is optional.
+ -c | --path Onap service path. It is of type STRING. It is
+ optional.
+ node-ip Onap service running node IP. It is of type
+ STRING.
+ node-port Onap service running node port. It is of type
+ STRING.
+ create-or-update Onap service create or update. It is of type
+ BOOL. By default, it is true.
+ -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.
+
+
+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::
@@ -3881,42 +4088,31 @@ Error::
-[67] subscription-delete
+[62] microservice-delete
-----------------------------------------------
-usage: onap subscription-delete
+usage: oclip microservice-delete
-Delete the subscription for a given customer in Onap
+Deletes the micro service from Onap
-Onap service: aai v11
+Product: onap-amsterdam
+Service: msb
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --customer-name] [-y | --service-type] [-g | --resource-version]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-x | --service-name] [-y | --service-version] [-i | --node-ip]
+ [-r | --node-port] [-m | --host-url]
where::
- -x | --customer-name Onap customer name. It is of type STRING.
- -y | --service-type Onap subscribtion id. It is of type STRING.
- -g | --resource-version Onap subscription resource version. It is of type
- STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -3927,8 +4123,15 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -x | --service-name Onap service name. It is of type STRING.
+ -y | --service-version Onap service version. It is of type STRING.
+ -i | --node-ip Onap service running node IP. It is of type
+ STRING.
+ -r | --node-port Onap service running node port. It is of type
+ STRING.
+ -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.
Error::
@@ -3937,59 +4140,55 @@ Error::
-[68] customer-show
+[63] microservice-list
-----------------------------------------------
-usage: onap customer-show
+usage: oclip microservice-list
-Lists the registetred customers in Onap
+Lists the registetred micro services in Onap
-Onap service: aai v11
+Product: onap-amsterdam
+Service: msb
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --customer-name] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-m | --host-url]
where::
- -x | --customer-name Onap customer name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -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.
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.
+ 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::
@@ -3998,39 +4197,30 @@ Error::
-[69] customer-create
+[64] microservice-show
-----------------------------------------------
-usage: onap customer-create
+usage: oclip microservice-show
-Create a customer in Onap
+Details the registered microservice in Onap
-Onap service: aai v11
+Product: onap-amsterdam
+Service: msb
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --customer-name] [-y | --subscriber-name] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --service-name] [-y | --service-version] [-m | --host-url]
where::
- -x | --customer-name Onap customer name. It is of type STRING.
- -y | --subscriber-name Onap subscriber name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -4041,8 +4231,23 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -x | --service-name Onap service name. It is of type STRING.
+ -y | --service-version Onap service version. It is of type STRING.
+ -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.
+
+
+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::
@@ -4051,41 +4256,32 @@ Error::
-[70] customer-delete
+[65] cloud-delete
-----------------------------------------------
-usage: onap customer-delete
+usage: oclip cloud-delete
-Delete a customer from Onap
+Delete a cloud region from Onap
-Onap service: aai v11
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --customer-name] [-y | --resource-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --cloud-name] [-y | --region-name] [-z | --resource-version]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --customer-name Onap customer name. It is of type STRING.
- -y | --resource-version Onap customer resource version. It is of type
- UUID. It is optional. By default, it is
- 99d76614-2e73-4aa2-9839-40cac60ccdd2.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -4096,6 +4292,20 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --cloud-name Onap cloud name. It is of type STRING.
+ -y | --region-name Onap cloud region name. It is of type STRING.
+ -z | --resource-version Onap cloud region version. It is of type UUID. It
+ is optional. By default, it is
+ 806a5679-06be-4efb-b420-b314c28efdeb.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -4106,56 +4316,56 @@ Error::
-[71] customer-list
+[66] customer-delete
-----------------------------------------------
-usage: onap customer-list
+usage: oclip customer-delete
-Lists the registetred customers in Onap
+Delete a customer from Onap
-Onap service: aai v11
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-x | --customer-name] [-y | --resource-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- name Onap customer name and is of type STRING.
- resource-version Onap customer resource version and is of type
- STRING.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --customer-name Onap customer name. It is of type STRING.
+ -y | --resource-version Onap customer resource version. It is of type
+ UUID. It is optional. By default, it is
+ 0c453a65-431c-48f9-ad3b-ed0b4b5859b3.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Error::
@@ -4164,41 +4374,31 @@ Error::
-[72] vf-list
+[67] customer-list
-----------------------------------------------
-usage: onap vf-list
+usage: oclip customer-list
-List created VF instances for a service instance
+Lists the registetred customers in Onap
-Onap service: aai v11
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --customer-name] [-y | --service-type] [-z | --service-id]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
[-a | --no-auth]
where::
- -x | --customer-name customer name. It is of type STRING.
- -y | --service-type service subscription type. It is of type STRING.
- -z | --service-id service ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -4209,14 +4409,24 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
Results::
- vf-id VF ID for the given service and is of type STRING.
- vf-name VF name and is of type STRING.
+ name Onap customer name and is of type STRING.
+ resource-version Onap customer resource version and is of type
+ STRING.
Error::
@@ -4225,39 +4435,31 @@ Error::
-[73] service-list
+[68] customer-show
-----------------------------------------------
-usage: onap service-list
+usage: oclip customer-show
-List created service instance
+Lists the registetred customers in Onap
-Onap service: aai v11
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --customer-name] [-y | --service-type] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --customer-name] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -x | --customer-name customer name. It is of type STRING.
- -y | --service-type service subscription type. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -4268,19 +4470,27 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --customer-name Onap customer name. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
Results::
- service-id instance id of service and is of type STRING.
- service-name Service name and is of type STRING.
- model-invariant-id Model invariant id of service model and is of
- type STRING.
- model-uuid Model uuid for service model and is of type
- STRING.
- description service description and is of type STRING.
+ 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::
@@ -4289,38 +4499,31 @@ Error::
-[74] vf-show
+[69] ems-list
-----------------------------------------------
-usage: onap vf-show
+usage: oclip ems-list
-Show details for VF
+List the configured ems
-Onap service: aai v11
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vf-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --vf-id VF identifier. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -4331,20 +4534,23 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
Results::
- vf-id VF ID for the given service and is of type STRING.
- vf-name VF name and is of type STRING.
- vf-type VF name and is of type STRING.
- model-invariant-id VF name and is of type STRING.
- model-uuid model uuid and is of type STRING.
- model-customization-id Model customization id and is of type STRING.
- service-id Service ID of parent service and is of type
- STRING.
+ ems-id Onap ems id and is of type STRING.
+ resource-version Onap ems resource version and is of type STRING.
Error::
@@ -4353,42 +4559,35 @@ Error::
-[75] tenant-create
+[70] sdnc-register
-----------------------------------------------
-usage: onap tenant-create
+usage: oclip sdnc-register
-Create a tenant under given cloud region in Onap
+Register a SDNC in Onap
-Onap service: aai v11
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --cloud] [-y | --region] [-z | --tenant-id]
- [-r | --tenant-name] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --location] [-y | --sdnc-id] [-b | --name]
+ [-c | --type] [-e | --vendor] [-q | --sdnc-version]
+ [-g | --ip-address] [-k | --port] [-r | --protocal]
+ [-i | --username] [-j | --password] [-z | --product-name]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --cloud Onap cloud. It is of type STRING.
- -y | --region Onap cloud region. It is of type STRING.
- -z | --tenant-id Onap cloud tenant id. It is of type STRING.
- -r | --tenant-name Onap cloud tenant name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -4399,6 +4598,31 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --location Onap VIM unique id. It is of type UUID. By
+ default, it is
+ 32df2939-2901-4908-ba4c-5ddaabf719c5.
+ -y | --sdnc-id Onap SDNC unique id. It is of type UUID. By
+ default, it is
+ ea5db6b0-e8e8-44a9-ae2a-fb9b0d5ab26d.
+ -b | --name Onap SDNC name. It is of type STRING.
+ -c | --type Onap SDNC type. It is of type STRING.
+ -e | --vendor Onap SDNC vendor. It is of type STRING.
+ -q | --sdnc-version Onap SDNC version. It is of type STRING.
+ -g | --ip-address Onap SDNC ip address. It is of type STRING.
+ -k | --port Onap SDNC port. It is of type STRING.
+ -r | --protocal Onap SDNC protocal. It is of type STRING.
+ -i | --username Onap SDNC username. It is of type STRING.
+ -j | --password Onap SDNC password. It is of type STRING.
+ -z | --product-name Onap SDNC product-name. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -4409,39 +4633,31 @@ Error::
-[76] tenant-list
+[71] sdnc-list
-----------------------------------------------
-usage: onap tenant-list
+usage: oclip sdnc-list
-Lists the tenants under given cloud region in Onap
+List the configured sdnc
-Onap service: aai v11
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --cloud] [-y | --region] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --cloud Onap cloud. It is of type STRING.
- -y | --region Onap cloud region. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -4452,16 +4668,23 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
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.
+ sdnc-id Onap sdnc id and is of type STRING.
+ resource-version Onap sdnc resource version and is of type STRING.
Error::
@@ -4470,56 +4693,54 @@ Error::
-[77] tenant-delete
+[72] cloud-create
-----------------------------------------------
-usage: onap tenant-delete
+usage: oclip cloud-create
-Delete tenant under given cloud region in Onap
+Create a cloud region in Onap
-Onap service: aai v11
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --cloud] [-y | --region] [-z | --tenant-id]
- [-r | --resource-version] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --cloud-name] [-y | --region-name] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --cloud Onap cloud. It is of type STRING.
- -y | --region Onap cloud region. It is of type STRING.
- -z | --tenant-id Onap cloud tenant id. It is of type STRING.
- -r | --resource-version Onap cloud tenant version. It is of type UUID. It
- is optional. By default, it is
- c22f376e-03fb-49f9-982c-9887b4e5da10.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --cloud-name Onap cloud name. It is of type STRING.
+ -y | --region-name Onap region name. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Error::
@@ -4528,37 +4749,34 @@ Error::
-[78] service-type-list
+[73] ems-register
-----------------------------------------------
-usage: onap service-type-list
+usage: oclip ems-register
-List the service types configured in Onap
+Register a EMS in Onap
-Onap service: aai v11
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
+ [-z | --ems-id] [-b | --name] [-c | --type]
+ [-e | --vendor] [-q | --ems-version] [-g | --url]
+ [-i | --username] [-j | --password] [-x | --remote-path]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
[-a | --no-auth]
where::
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -4569,59 +4787,61 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -z | --ems-id Onap EMS unique id. It is of type UUID. By
+ default, it is
+ 5888ad8e-c90c-4120-8a7e-dbdfe567db1c.
+ -b | --name Onap EMS name. It is of type STRING.
+ -c | --type Onap EMS type. It is of type STRING.
+ -e | --vendor Onap EMS vendor. It is of type STRING.
+ -q | --ems-version Onap EMS version. It is of type STRING.
+ -g | --url Onap EMS URL. It is of type STRING.
+ -i | --username Onap EMS username. It is of type STRING.
+ -j | --password Onap EMS password. It is of type STRING.
+ -x | --remote-path Onap EMS remote-path. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
-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 <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[79] service-type-create
+[74] ems-unregister
-----------------------------------------------
-usage: onap service-type-create
+usage: oclip ems-unregister
-Add a service type in Onap
+Un-register a EMS in Onap
-Onap service: aai v11
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --service-type] [-y | --service-type-id] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --ems-id] [-y | --resource-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --service-type Onap service type. It is of type STRING.
- -y | --service-type-id Onap service type uuid. It is of type UUID. It is
- optional. By default, it is
- d4445250-ef8d-4d78-a1b8-21719383acf7.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -4632,63 +4852,20 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[80] service-type-delete
------------------------------------------------
-
-
-usage: onap service-type-delete
-
-Delete a service type from Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --service-type-id] [-y | --resource-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --service-type-id Onap service type uuid. It is of type UUID. It is
- optional. By default, it is
- bb1938c7-1609-40fe-b4ba-75a3282ad3ad.
- -y | --resource-version Onap service resource version. It is of type
- UUID. It is optional. By default, it is
- 12b1a7c7-f8be-49cb-b320-dc103a24f00e.
- -u | --onap-username Onap user name. It is of type STRING. By default,
+ -x | --ems-id Onap EMS unique id. It is of type UUID. By
+ default, it is
+ 34953098-9d3f-4438-95e8-9d9ce430d7d3.
+ -y | --resource-version Onap vim resource 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
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
+ OPEN_CLI_HOST_USERNAME.
+ -p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
+ 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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -4699,39 +4876,31 @@ Error::
-[81] cloud-create
+[75] ems-show
-----------------------------------------------
-usage: onap cloud-create
+usage: oclip ems-show
-Create a cloud region in Onap
+Show the details of configured ems
-Onap service: aai v11
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --cloud-name] [-y | --region-name] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --ems-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -x | --cloud-name Onap cloud name. It is of type STRING.
- -y | --region-name Onap region name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -4742,135 +4911,30 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --ems-id Onap EMS unique id. It is of type UUID. By
+ default, it is
+ 44b59f48-34cb-4f07-84fb-b8b1033570df.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[82] service-delete
------------------------------------------------
-
-
-usage: onap service-delete
-
-Delete service instance (experimental)
-
-Onap service: so v3
-
-Options::
-
- [-x | --service-instace-id] [-b | --model-invariant-id] [-i | --model-uuid]
- [-e | --model-name] [-g | --model-version] [-c | --customer-name]
- [-j | --cloud-region] [-k | --tenant-id] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --service-instace-id unique id for service instance. It is of type
- STRING.
- -b | --model-invariant-id model invariant id for service in SDC catalog. It
- is of type STRING.
- -i | --model-uuid model uuid for service in SDC catalog. It is of
- type STRING.
- -e | --model-name model name available in SDC catalog. It is of
- type STRING.
- -g | --model-version model version of service (eg. 1.0). It is of type
- STRING.
- -c | --customer-name unique id for customer. It is of type STRING.
- -j | --cloud-region cloud region id. It is of type STRING.
- -k | --tenant-id tenant id. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[83] vfmodule-delete
------------------------------------------------
-
-
-usage: onap vfmodule-delete
-
-delete a VF module (experimental)
-
-Onap service: so v3
-
-Options::
-
- [-x | --vfmodule-id] [-j | --service-id] [-y | --vf-id]
- [-k | --vf-model-invariant-id] [-e | --vfmodule-name] [-g | --vfmodule-version]
- [-l | --cloud-region] [-z | --tenant-id] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
+Results::
- -x | --vfmodule-id VF module Id. It is of type STRING.
- -j | --service-id unique id for service. It is of type STRING.
- -y | --vf-id unique id for related VF. It is of type STRING.
- -k | --vf-model-invariant-id vf model invariant id. It is of type STRING.
- -e | --vfmodule-name vfmodule model name. It is of type STRING.
- -g | --vfmodule-version vf module version. It is of type STRING.
- -l | --cloud-region cloud region identifier. It is of type STRING.
- -z | --tenant-id openstack tenant id. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ 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::
@@ -4879,156 +4943,53 @@ Error::
-[84] vfmodule-create
+[76] sdnc-unregister
-----------------------------------------------
-usage: onap vfmodule-create
+usage: oclip sdnc-unregister
-Create a VF module
+Un-register a VNFM in Onap
-Onap service: so v3
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-l | --cloud-region] [-B | --tenant-id] [-b | --vfmodule-invariant-id]
- [-c | --vfmodule-uuid] [-e | --vfmodule-name] [-g | --vfmodule-version]
- [-i | --module-name] [-j | --service-id] [-y | --vf-id]
- [-k | --vf-model-invariant-id] [-A | --vf-model-uuid] [-n | --vf-model-name]
- [-o | --vf-model-version] [-q | --vf-model-customization-id] [-r | --service-model-invariant-id]
- [-w | --service-model-uuid] [-x | --service-model-name] [-z | --service-model-version]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -l | --cloud-region cloud region identifier. It is of type STRING.
- -B | --tenant-id openstack tenant id. It is of type STRING.
- -b | --vfmodule-invariant-id vfmodule model invariant id. It is of type STRING.
- -c | --vfmodule-uuid model uuid for vfmodule. It is of type STRING.
- -e | --vfmodule-name vfmodule model name. It is of type STRING.
- -g | --vfmodule-version vf module version. It is of type STRING.
- -i | --module-name vfmodule name. It is of type STRING.
- -j | --service-id unique id for service. It is of type STRING.
- -y | --vf-id unique id for related VF. It is of type STRING.
- -k | --vf-model-invariant-id vf model invariant id. It is of type STRING.
- -A | --vf-model-uuid model uuid for vf. It is of type STRING.
- -n | --vf-model-name vf model name. It is of type STRING.
- -o | --vf-model-version vf model version. It is of type STRING.
- -q | --vf-model-customization-id vf model customization id. This can be obtained
- using SDC portal (Home -> service:xxx ->
- Composition -> click on VF for customization id).
- It is of type STRING.
- -r | --service-model-invariant-id model invariant id. It is of type STRING.
- -w | --service-model-uuid model name version id. It is of type STRING.
- -x | --service-model-name service model name. It is of type STRING.
- -z | --service-model-version service model version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- vfmodule-id id for the created vnf and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[85] service-create
------------------------------------------------
-
-
-usage: onap service-create
-
-Create a service instance using MSO
-
-Onap service: so v3
-
-Options::
-
- [-l | --cloud-region] [-b | --tenant-id] [-e | --model-invariant-id]
- [-g | --model-uuid] [-i | --model-name] [-j | --model-version]
- [-c | --customer] [-k | --instance-name] [-r | --supress-rollback]
- [-w | --service-type] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-x | --sdnc-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -l | --cloud-region cloud region identifier. It is of type STRING.
- -b | --tenant-id tenant id. It is of type STRING.
- -e | --model-invariant-id model invariant id generated by ASDC. It is of
- type STRING.
- -g | --model-uuid model uuid generated by ASDC. It is of type
- STRING.
- -i | --model-name model name as provided in ASDC design time. It is
- of type STRING.
- -j | --model-version model-version. It is of type STRING.
- -c | --customer unique id for customer. It is of type STRING.
- -k | --instance-name service instance name. It is of type STRING.
- -r | --supress-rollback rollback changes if instantiation fails. It is of
- type BOOL. It is optional. By default, it is
- false.
- -w | --service-type subscription service type. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- service-id instance id for the created service. and is of
- type STRING.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --sdnc-id Onap VNFM unique id. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Error::
@@ -5037,64 +4998,74 @@ Error::
-[86] vf-delete
+[77] vim-register
-----------------------------------------------
-usage: onap vf-delete (experimental)
+usage: oclip vim-register
-delete a VF
+Register a VIM under a given cloud region in Onap
-Onap service: so v3
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vf-id] [-y | --service-instance-id] [-l | --cloud-region]
- [-z | --tenant-id] [-b | --model-invariant-id] [-c | --model-uuid]
- [-e | --model-name] [-g | --model-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --cloud-name] [-y | --region-name] [-z | --vim-id]
+ [-b | --name] [-c | --type] [-e | --vendor]
+ [-q | --vim-version] [-g | --url] [-i | --username]
+ [-j | --password] [-k | --ssl-cacert] [-l | --ssl-insecure]
+ [-n | --cloud-domain] [-o | --default-tenant] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --vf-id id for vnf. It is of type STRING.
- -y | --service-instance-id unique id for service instance. It is of type
- STRING.
- -l | --cloud-region Cloud region ID. It is of type STRING.
- -z | --tenant-id openstack tenant id (uuid). It is of type STRING.
- -b | --model-invariant-id model invariant id for service in SDC catalog. It
- is of type STRING.
- -c | --model-uuid model uuid for service in SDC catalog. It is of
- type STRING.
- -e | --model-name model name available in SDC catalog. It is of
- type STRING.
- -g | --model-version model version of service (eg. 1.0). It is of type
- STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --cloud-name Onap cloud name. It is of type STRING.
+ -y | --region-name Onap region name. It is of type STRING.
+ -z | --vim-id Onap VIM unique id. It is of type UUID. By
+ default, it is
+ b7eae86a-0e63-4804-93a9-4127a7c1d747.
+ -b | --name Onap VIM name. It is of type STRING.
+ -c | --type Onap VIM type. It is of type STRING.
+ -e | --vendor Onap VIM vendor. It is of type STRING.
+ -q | --vim-version Onap VIM version. It is of type STRING.
+ -g | --url Onap VIM URL. It is of type STRING.
+ -i | --username Onap VIM username. It is of type STRING.
+ -j | --password Onap VIM password. It is of type STRING.
+ -k | --ssl-cacert Onap VIM SSL certificate. It is of type TEXT. It
+ is optional.
+ -l | --ssl-insecure Onap VIM insecure. It is of type BOOL. It is
+ optional. By default, it is false.
+ -n | --cloud-domain Onap VIM cloud domain. It is of type STRING.
+ -o | --default-tenant Onap VIM default tenant. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Error::
@@ -5103,74 +5074,60 @@ Error::
-[87] vf-create
+[78] vim-unregister
-----------------------------------------------
-usage: onap vf-create
+usage: oclip vim-unregister
-Create a VF
+Un-register a VIM under from cloud region in Onap
-Onap service: so v3
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-l | --cloud-region] [-z | --tenant-id] [-w | --product-family]
- [-o | --instance-name] [-y | --service-instance-id] [-b | --vf-model-invariant-id]
- [-c | --vf-model-uuid] [-e | --vf-model-name] [-g | --vf-model-version]
- [-i | --vf-model-customization-id] [-j | --service-model-invariant-id] [-k | --service-model-uuid]
- [-q | --service-model-name] [-n | --service-model-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --cloud-name] [-y | --region-name] [-z | --vim-id]
+ [-b | --resource-version] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -l | --cloud-region cloud region identifier. It is of type STRING.
- -z | --tenant-id openstack tenant id. It is of type STRING.
- -w | --product-family service type for serivce (e.g. vLB). It is of
- type STRING.
- -o | --instance-name service instance name. It is of type STRING.
- -y | --service-instance-id unique id for service instance. It is of type
- STRING.
- -b | --vf-model-invariant-id vf model invariant id. It is of type STRING.
- -c | --vf-model-uuid model uuid for vf. It is of type STRING.
- -e | --vf-model-name vf model name. It is of type STRING.
- -g | --vf-model-version vf model version. It is of type STRING.
- -i | --vf-model-customization-id vf model customization id. It is of type STRING.
- -j | --service-model-invariant-id model invariant id. It is of type STRING.
- -k | --service-model-uuid model name version id. It is of type STRING.
- -q | --service-model-name service model name. It is of type STRING.
- -n | --service-model-version service model version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- vf-id id for the created vnf and is of type STRING.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --cloud-name Onap cloud name. It is of type STRING.
+ -y | --region-name Onap region name. It is of type STRING.
+ -z | --vim-id Onap VIM unique id. It is of type UUID. By
+ default, it is
+ 98319f86-9d39-4d59-8a89-7902f2214056.
+ -b | --resource-version Onap vim resource 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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Error::
@@ -5179,63 +5136,68 @@ Error::
-onap-1.0
-==========================
-
-
-[1] license-group-create
+[79] vim-list
-----------------------------------------------
-usage: onap license-group-create
+usage: oclip vim-list
-Create License Group
+List the configured vims
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --group-name] [-y | --license-model-id] [-z | --license-group-description]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-x | --cloud-name] [-y | --region-name] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --group-name group name. It is of type STRING.
- -y | --license-model-id License Model ID. It is of type STRING.
- -z | --license-group-description Description for License Group. It is of type
- STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --cloud-name Onap cloud name. It is of type STRING.
+ -y | --region-name Onap region name. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Results::
- ID License Group ID and is of type STRING.
+ 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::
@@ -5244,39 +5206,34 @@ Error::
-[2] ep-show
+[80] vnfm-register
-----------------------------------------------
-usage: onap ep-show
+usage: oclip vnfm-register
-Details of the Entitlement Pool
+Register a VNFM in Onap
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --license-model-id] [-y | --pool-id] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vim-id] [-y | --vnfm-id] [-b | --name]
+ [-c | --type] [-e | --vendor] [-q | --vnfm-version]
+ [-g | --url] [-i | --username] [-j | --password]
+ [-z | --certificate-url] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -x | --license-model-id Onap License Model ID. It is of type STRING.
- -y | --pool-id Onap Entitlement Pool ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -5287,116 +5244,65 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vim-id Onap VIM unique id. It is of type UUID. By
+ default, it is
+ f3e8293e-7315-4945-8f8e-a0dd13a880cc.
+ -y | --vnfm-id Onap VNFM unique id. It is of type UUID. By
+ default, it is
+ c35aee19-2416-4f13-9fd2-bc76e70db99c.
+ -b | --name Onap VNFM name. It is of type STRING.
+ -c | --type Onap VNFM type. It is of type STRING.
+ -e | --vendor Onap VNFM vendor. It is of type STRING.
+ -q | --vnfm-version Onap VNFM version. It is of type STRING.
+ -g | --url Onap VNFM URL. It is of type STRING.
+ -i | --username Onap VNFM username. It is of type STRING.
+ -j | --password Onap VNFM password. It is of type STRING.
+ -z | --certificate-url Onap VNFM certificate-url. 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
-Results::
-
- name Entitlement Pool Name and is of type STRING.
- ID Entitlement Pool ID and is of type STRING.
- description Description for the Entitlement Pool and is of
- type STRING.
-
-
Error::
On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[3] license-model-create
+[81] vnfm-unregister
-----------------------------------------------
-usage: onap license-model-create
-
-Create License Model
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vendor-name] [-y | --license-model-description] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+usage: oclip vnfm-unregister
-where::
-
- -x | --vendor-name vendor name. It is of type STRING.
- -y | --license-model-description Description for License Model. It is of type
- STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID License Model ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[4] license-group-show
------------------------------------------------
-
-
-usage: onap license-group-show
-
-Details of the License Group
+Un-register a VNFM in Onap
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --license-model-id] [-y | --license-group-id] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vnfm-id] [-y | --resource-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --license-model-id Onap License Model ID. It is of type STRING.
- -y | --license-group-id Onap License Group ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -5407,57 +5313,55 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vnfm-id Onap VNFM unique id. It is of type UUID. By
+ default, it is
+ 2cbe3dc0-97cb-41e9-b8db-411e6a0975e6.
+ -y | --resource-version Onap vim resource 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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
-Results::
-
- name License Group Name and is of type STRING.
- ID License Group ID and is of type STRING.
- description Description for the License Group and is of type
- STRING.
-
-
Error::
On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[5] vsp-upload
+[82] vnfm-list
-----------------------------------------------
-usage: onap vsp-upload
+usage: oclip vnfm-list
-Upload the CSAR file to VSP
+List the configured vnfm
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vsp-id] [-y | --vsp-file] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-file CSAR File path. It is of type BINARY.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -5468,82 +5372,25 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[6] vsp-create
------------------------------------------------
-
-
-usage: onap vsp-create
-
-Create Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vsp-name] [-y | --vsp-description] [-b | --vsp-category]
- [-c | --vsp-subcategory] [-e | --vlm-version] [-g | --vlm-vendor]
- [-i | --vlm-id] [-j | --vlm-agreement-id] [-k | --vlm-feature-group-id]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -x | --vsp-name Onap VSP Name. It is of type STRING.
- -y | --vsp-description Description for VSP. It is of type STRING. It is
- optional.
- -b | --vsp-category Category of the VSP. It is of type STRING. It is
- optional. By default, it is
- resourceNewCategory.generic.
- -c | --vsp-subcategory Sub Category of VSP. It is of type STRING. It is
- optional. By default, it is
- resourceNewCategory.generic.abstract.
- -e | --vlm-version License version. It is of type STRING. It is
- optional. By default, it is 1.0.
- -g | --vlm-vendor License Model Name. It is of type STRING.
- -i | --vlm-id License Model ID. It is of type STRING.
- -j | --vlm-agreement-id License Agreement ID. It is of type STRING.
- -k | --vlm-feature-group-id Feature Group ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
Results::
- ID VSP ID and is of type STRING.
+ 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::
@@ -5552,37 +5399,31 @@ Error::
-[7] vsp-list
+[83] vnfm-show
-----------------------------------------------
-usage: onap vsp-list
+usage: oclip vnfm-show
-List of the Vendor Software Products
+Show the VNFM in Onap
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-x | --vnfm-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -5593,14 +5434,30 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vnfm-id Onap VNFM unique id. It is of type UUID. By
+ default, it is
+ 472dea25-b892-4b6f-912f-e61430d258da.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
Results::
- ID VSP ID and is of type STRING.
- name VSP Name and is of type STRING.
+ 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::
@@ -5609,38 +5466,31 @@ Error::
-[8] vsp-show
+[84] service-list
-----------------------------------------------
-usage: onap vsp-show
+usage: oclip service-list
-Details of the Vendor Software Product
+List created service instance
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --customer-name] [-y | --service-type] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -5651,15 +5501,30 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --customer-name customer name. It is of type STRING.
+ -y | --service-type service subscription type. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
Results::
- name VSP Name and is of type STRING.
- ID VSP ID and is of type STRING.
- description Description for the VSP and is of type STRING.
+ service-id instance id of service and is of type STRING.
+ service-name Service name and is of type STRING.
+ model-invariant-id Model invariant id of service model and is of
+ type STRING.
+ model-uuid Model uuid for service model and is of type
+ STRING.
+ description service description and is of type STRING.
Error::
@@ -5668,38 +5533,32 @@ Error::
-[9] vsp-submit
+[85] vf-list
-----------------------------------------------
-usage: onap vsp-submit
+usage: oclip vf-list
-Submit Vendor Software Product
+List created VF instances for a service instance
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --customer-name] [-y | --service-type] [-z | --service-id]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -5710,48 +5569,59 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --customer-name customer name. It is of type STRING.
+ -y | --service-type service subscription type. It is of type STRING.
+ -z | --service-id service ID. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
+Results::
+
+ vf-id VF ID for the given service and is of type STRING.
+ vf-name VF name and is of type STRING.
+
+
Error::
On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[10] vsp-checkin
+[86] vf-show
-----------------------------------------------
-usage: onap vsp-checkin
+usage: oclip vf-show
-Checkin Vendor Software Product
+Show details for VF
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vf-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -5762,48 +5632,63 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --vf-id VF identifier. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
+Results::
+
+ vf-id VF ID for the given service and is of type STRING.
+ vf-name VF name and is of type STRING.
+ vf-type VF name and is of type STRING.
+ model-invariant-id VF name and is of type STRING.
+ model-uuid model uuid and is of type STRING.
+ model-customization-id Model customization id and is of type STRING.
+ service-id Service ID of parent service and is of type
+ STRING.
+
+
Error::
On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[11] license-model-show
+[87] service-type-create
-----------------------------------------------
-usage: onap license-model-show
+usage: oclip service-type-create
-Details of the License Model
+Add a service type in Onap
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --license-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --service-type] [-y | --service-type-id] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --license-model-id Onap License Model ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -5814,86 +5699,81 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --service-type Onap service type. It is of type STRING.
+ -y | --service-type-id Onap service type uuid. It is of type UUID. It is
+ optional. By default, it is
+ a6c6f62a-19a3-4b7c-9add-e31ccd337510.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
-Results::
-
- name License Model Name and is of type STRING.
- ID License Model ID and is of type STRING.
- description Description for the License Model and is of type
- STRING.
- status Status of the License Model and is of type STRING.
-
-
Error::
On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[12] ep-create
+[88] service-type-delete
-----------------------------------------------
-usage: onap ep-create
+usage: oclip service-type-delete
-Create Entitlement Pool
+Delete a service type from Onap
-Onap service: sdc v1.0
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --ep-name] [-y | --license-model-id] [-z | --ep-description]
- [-q | --threshold-value] [-b | --threshold-unit] [-c | --entitlement-metric]
- [-e | --aggregation-function] [-g | --operational-scope] [-k | --reference-number]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-x | --service-type-id] [-y | --resource-version] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --ep-name Entitlement Pool name. It is of type STRING.
- -y | --license-model-id License Model ID. It is of type STRING.
- -z | --ep-description Description for Entitlement Pool. It is of type
- STRING.
- -q | --threshold-value threshold. It is of type STRING.
- -b | --threshold-unit threshold. It is of type STRING.
- -c | --entitlement-metric Entitlement Metric. It is of type STRING.
- -e | --aggregation-function Aggregation Function. It is of type STRING.
- -g | --operational-scope Operational Scope. It is of type STRING.
- -k | --reference-number Reference Number. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID Entitlement Pool ID and is of type STRING.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --service-type-id Onap service type uuid. It is of type UUID. It is
+ optional. By default, it is
+ f610d2cb-710a-4603-9aed-b66db1675d20.
+ -y | --resource-version Onap service resource version. It is of type
+ UUID. It is optional. By default, it is
+ 0d1f018e-6e47-48c7-95af-5d15d8a6e8ea.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Error::
@@ -5902,38 +5782,31 @@ Error::
-[13] subscription-list
+[89] service-type-list
-----------------------------------------------
-usage: onap subscription-list
+usage: oclip service-type-list
-Lists the subscription for a given customer in Onap
+List the service types configured in Onap
-Onap service: aai v8
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --customer-name] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --customer-name Onap customer name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -5944,13 +5817,25 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
Results::
- service-type Onap service type and is of type STRING.
+ 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::
@@ -5959,50 +5844,32 @@ Error::
-[14] subscription-create
+[90] subscription-create
-----------------------------------------------
-usage: onap subscription-create
+usage: oclip subscription-create
-Create a subscription for a customer in Onap
+Create a subscription of a customer for given service in specific cloud region in Onap
-Onap service: aai v8
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --customer-name] [-y | --subscriber-name] [-z | --cloud-type]
- [-r | --cloud-region] [-c | --cloud-tenant-id] [-e | --service-type]
- [-g | --resource-version] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --customer-name] [-z | --cloud-name] [-r | --cloud-region]
+ [-c | --cloud-tenant-id] [-e | --service-type] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -x | --customer-name Onap customer name. It is of type STRING.
- -y | --subscriber-name Onap subscriber name. It is of type STRING.
- -z | --cloud-type Onap cloud type (openstack, rackspace). It is of
- type STRING.
- -r | --cloud-region Onap cloud region. It is of type STRING.
- -c | --cloud-tenant-id Onap cloud tenant id. It is of type STRING.
- -e | --service-type Onap service type. It is of type STRING.
- -g | --resource-version Onap subscription resource version. It is
- mandatory for existing customer to create a new
- subscription. It is of type STRING. It is
- optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -6013,6 +5880,20 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --customer-name Onap customer name. It is of type STRING.
+ -z | --cloud-name Onap cloud name. It is of type STRING.
+ -r | --cloud-region Onap cloud region. It is of type STRING.
+ -c | --cloud-tenant-id Onap cloud tenant id. It is of type STRING.
+ -e | --service-type Onap service type. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -6023,59 +5904,57 @@ Error::
-[15] customer-show
+[91] subscription-delete
-----------------------------------------------
-usage: onap customer-show
+usage: oclip subscription-delete
-Lists the registetred customers in Onap
+Delete the subscription for a given customer in Onap
-Onap service: aai v8
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --customer-name] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --customer-name] [-y | --service-type] [-g | --resource-version]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -x | --customer-name Onap customer name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-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.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --customer-name Onap customer name. It is of type STRING.
+ -y | --service-type Onap subscribtion id. It is of type STRING.
+ -g | --resource-version Onap subscription resource 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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Error::
@@ -6084,37 +5963,31 @@ Error::
-[16] customer-list
+[92] subscription-list
-----------------------------------------------
-usage: onap customer-list
+usage: oclip subscription-list
-Lists the registetred customers in Onap
+Lists the subscription for a given customer in Onap
-Onap service: aai v8
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-x | --customer-name] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -6125,15 +5998,28 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --customer-name Onap customer name. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
Results::
- name Onap customer name and is of type STRING.
- resource-version Onap customer resource version and is of type
+ 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::
@@ -6142,53 +6028,57 @@ Error::
-[17] customer-delete
+[93] tenant-create
-----------------------------------------------
-usage: onap customer-delete
+usage: oclip tenant-create
-Delete a customer from Onap
+Create a tenant under given cloud region in Onap
-Onap service: aai v8
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --customer-name] [-y | --resource-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --cloud] [-y | --region] [-z | --tenant-id]
+ [-r | --tenant-name] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -x | --customer-name Onap customer name. It is of type STRING.
- -y | --resource-version Onap customer resource version. It is of type
- UUID. It is optional. By default, it is
- 6dc30068-de3c-483a-a9a8-7d483a39425d.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -x | --cloud Onap cloud. It is of type STRING.
+ -y | --region Onap cloud region. It is of type STRING.
+ -z | --tenant-id Onap cloud tenant id. It is of type STRING.
+ -r | --tenant-name Onap cloud tenant name. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
Error::
@@ -6197,94 +6087,32 @@ Error::
-[18] customer-create
+[94] tenant-delete
-----------------------------------------------
-usage: onap customer-create
+usage: oclip tenant-delete
-Create a customer in Onap
+Delete tenant under given cloud region in Onap
-Onap service: aai v8
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --customer-name] [-y | --subscriber-name] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --cloud] [-y | --region] [-z | --tenant-id]
+ [-r | --resource-version] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
- -x | --customer-name Onap customer name. It is of type STRING.
- -y | --subscriber-name Onap subscriber name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[19] service-type-create
------------------------------------------------
-
-
-usage: onap service-type-create
-
-Add a service type in Onap
-
-Onap service: aai v8
-
-Options::
-
- [-x | --service-type] [-y | --service-type-id] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --service-type Onap service type. It is of type STRING.
- -y | --service-type-id Onap service type uuid. It is of type UUID. It is
- optional. By default, it is
- eb4a0d54-0e29-4174-8a3c-2c98e904a5f6.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -6295,63 +6123,21 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[20] service-type-delete
------------------------------------------------
-
-
-usage: onap service-type-delete
-
-Delete a service type from Onap
-
-Onap service: aai v8
-
-Options::
-
- [-x | --service-type-id] [-y | --resource-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --service-type-id Onap service type uuid. It is of type UUID. It is
- optional. By default, it is
- 31d3a8cb-d4ff-4b4e-a0d3-5f79f3062686.
- -y | --resource-version Onap service resource version. It is of type
- UUID. It is optional. By default, it is
- b06576ca-74b8-42f2-815b-6f7b80f9941c.
- -u | --onap-username Onap user name. It is of type STRING. By default,
+ -x | --cloud Onap cloud. It is of type STRING.
+ -y | --region Onap cloud region. It is of type STRING.
+ -z | --tenant-id Onap cloud tenant id. It is of type STRING.
+ -r | --resource-version Onap cloud tenant version. It is of type UUID. It
+ is optional. By default, it is
+ b9ea4541-bff0-419b-80cb-0cabad805aad.
+ -u | --host-username Host user name. It is of type STRING. By default,
it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
+ OPEN_CLI_HOST_USERNAME.
+ -p | --host-password Host user password. It is of type STRING. By
default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
+ 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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
@@ -6362,37 +6148,31 @@ Error::
-[21] service-type-list
+[95] tenant-list
-----------------------------------------------
-usage: onap service-type-list
+usage: oclip tenant-list
-List the service types configured in Onap
+Lists the tenants under given cloud region in Onap
-Onap service: aai v8
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-x | --cloud] [-y | --region] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -6403,16 +6183,27 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --cloud Onap cloud. It is of type STRING.
+ -y | --region Onap cloud region. It is of type STRING.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
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.
+ 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::
@@ -6421,37 +6212,31 @@ Error::
-[22] cloud-list
+[96] cloud-list
-----------------------------------------------
-usage: onap cloud-list
+usage: oclip cloud-list
List the configured clouds and Onap service subscriptions
-Onap service: aai v8
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
[-a | --no-auth]
where::
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -6462,18 +6247,28 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -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.
+ -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.
-a | --no-auth whether to authenticate user or not. It is of
type BOOL. By default, it is false.
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.
+ 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::
@@ -6482,35 +6277,31 @@ Error::
-cli-1.0
-==========================
-
-
-[1] schema-validate
+[97] customer-create
-----------------------------------------------
-usage: onap schema-validate
+usage: oclip customer-create
-Onap command to validate schema
+Create a customer in Onap
-Onap service: onap-cli 1.0.0
+Product: onap-amsterdam
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-l | --schema-location] [-i | --internal-schema] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title]
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --customer-name] [-y | --subscriber-name] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
- -l | --schema-location Schema file location. It is of type URL.
- -i | --internal-schema Validate existing schema file. It is of type
- BOOL. By default, it is false.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -6521,12 +6312,77 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -x | --customer-name Onap customer name. It is of type STRING.
+ -y | --subscriber-name Onap subscriber name. It is of type STRING.
+ -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.
+ -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.
+ -a | --no-auth whether to authenticate user or not. It is of
+ type BOOL. By default, it is false.
+
+
+Error::
+
+ On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
+
+sample-helloworld
+==========================
+
+
+[1] hello-world-http
+-----------------------------------------------
+
+
+usage: oclip hello-world-http
+
+First cmd hello world using http runing under
+lighttpd in cli at http://<cli-ip>:8080/version.json
+
+
+Product: sample-helloworld
+Service: hello-world
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-b | --name] [-m | --host-url]
+
+where::
+
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
+ -d | --debug Enable debug output. It is of type BOOL. By
+ default, it is false.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING. By
+ default, it is table.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL. By default, it is
+ false.
+ -t | --no-title whether to print title or not. It is of type
+ BOOL. By default, it is false.
+ -b | --name name of the person. It is of type STRING. By
+ default, it is ${DEMO_NAME}.
+ -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.
Results::
- sl-no Serial Number of error and is of type STRING.
- error Schema validation error and is of type STRING.
+ output hello world output and is of type STRING.
Error::
@@ -6535,27 +6391,30 @@ Error::
-[2] schema-refresh
+[2] hello-world
-----------------------------------------------
-usage: onap schema-refresh
+usage: oclip hello-world
-Onap command to refresh schemas stored in onap_cli_schema folders.
+First cmd hello world
-Onap service: onap-cli 1.0.0
+Product: sample-helloworld
+Service: hello-world
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
+ [-b | --name]
where::
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
+ -h | --help print help message. It is of type STRING. By
+ default, it is false.
+ -v | --version print service version. It is of type STRING. By
+ default, it is false.
-d | --debug Enable debug output. It is of type BOOL. By
default, it is false.
-f | --format Output formats, supported formats such as table,
@@ -6566,15 +6425,13 @@ where::
false.
-t | --no-title whether to print title or not. It is of type
BOOL. By default, it is false.
+ -b | --name name of the person. It is of type STRING. By
+ default, it is ${env:DEMO_NAME}.
Results::
- sl-no Serial Number and is of type STRING.
- command Command name and is of type STRING.
- product-version Command product version and is of type STRING.
- schema Schema name and is of type STRING.
- version Schema version and is of type STRING.
+ output hello world output and is of type STRING.
Error::
diff --git a/docs/cmd_sample.rst b/docs/cmd_sample.rst
index cbe128f1..3c3013af 100644
--- a/docs/cmd_sample.rst
+++ b/docs/cmd_sample.rst
@@ -5,8 +5,8 @@
.. _cli_cmd_sample:
-onap-1.1
-========
+onap-amsterdam
+==============
@@ -1285,8 +1285,8 @@ output::
+--------------+--------------------------------------+
|vf-id |048c2c4a-ee30-41a1-bb55-c4e7fe1a9a0d |
+--------------+--------------------------------------+
-onap-1.0
-========
+openecomp
+=========
@@ -1363,7 +1363,7 @@ output::
|test-vsp |2DEB6CB4B082415BB7A697C9CD1273BA |vendor software product |
+----------+----------------------------------+--------------------------+
-cli-1.0
+open-cli
========
schema-validate
@@ -1390,232 +1390,232 @@ output::
+--------+--------------------------------+------------------+------------------------------------------------+----------+
|sl-no |command |product-version |schema |version |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |1 |vfmodule-create |onap-1.1 |vfmodule-create-schema-1.1.yaml |1.0 |
+ |1 |vfmodule-create |onap-amsterdam |vfmodule-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |2 |schema-validate |cli-1.0 |schema-validate.yaml |1.0 |
+ |2 |schema-validate |open-cli |schema-validate.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |3 |schema-refresh |cli-1.0 |schema-refresh.yaml |1.0 |
+ |3 |schema-refresh |open-cli |schema-refresh.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |4 |cloud-list |onap-1.1 |cloud-list-schema-1.1.yaml |1.0 |
+ |4 |cloud-list |onap-amsterdam |cloud-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |5 |sdnc-list |onap-1.1 |sdnc-list-schema-1.1.yaml |1.0 |
+ |5 |sdnc-list |onap-amsterdam |sdnc-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |6 |sdnc-register |onap-1.1 |sdnc-create-schema-1.1.yaml |1.0 |
+ |6 |sdnc-register |onap-amsterdam |sdnc-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |7 |sdnc-unregister |onap-1.1 |sdnc-delete-schema-1.1.yaml |1.0 |
+ |7 |sdnc-unregister |onap-amsterdam |sdnc-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |8 |vnfm-show |onap-1.1 |vnfm-show-schema-1.1.yaml |1.0 |
+ |8 |vnfm-show |onap-amsterdam |vnfm-show-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |9 |vnfm-unregister |onap-1.1 |vnfm-delete-schema-1.1.yaml |1.0 |
+ |9 |vnfm-unregister |onap-amsterdam |vnfm-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |10 |vnfm-register |onap-1.1 |vnfm-create-schema-1.1.yaml |1.0 |
+ |10 |vnfm-register |onap-amsterdam |vnfm-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |11 |vnfm-list |onap-1.1 |vnfm-list-schema-1.1.yaml |1.0 |
+ |11 |vnfm-list |onap-amsterdam |vnfm-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |12 |vim-register |onap-1.1 |vim-create-schema-1.1.yaml |1.0 |
+ |12 |vim-register |onap-amsterdam |vim-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |13 |vim-unregister |onap-1.1 |vim-delete-schema-1.1.yaml |1.0 |
+ |13 |vim-unregister |onap-amsterdam |vim-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |14 |vim-list |onap-1.1 |vim-list-schema-1.1.yaml |1.0 |
+ |14 |vim-list |onap-amsterdam |vim-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |15 |ems-list |onap-1.1 |ems-list-schema-1.1.yaml |1.0 |
+ |15 |ems-list |onap-amsterdam |ems-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |16 |ems-register |onap-1.1 |ems-create-schema-1.1.yaml |1.0 |
+ |16 |ems-register |onap-amsterdam |ems-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |17 |ems-show |onap-1.1 |ems-show-schema-1.1.yaml |1.0 |
+ |17 |ems-show |onap-amsterdam |ems-show-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |18 |cloud-delete |onap-1.1 |cloud-delete-schema-1.1.yaml |1.0 |
+ |18 |cloud-delete |onap-amsterdam |cloud-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |19 |ems-unregister |onap-1.1 |ems-delete-schema-1.1.yaml |1.0 |
+ |19 |ems-unregister |onap-amsterdam |ems-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |20 |subscription-list |onap-1.0 |subscription-list-schema.yaml |1.0 |
+ |20 |subscription-list |openecomp |subscription-list-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |21 |subscription-create |onap-1.0 |subscription-create-schema.yaml |1.0 |
+ |21 |subscription-create |openecomp |subscription-create-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |22 |subscription-list |onap-1.1 |subscription-list-schema-1.1.yaml |1.0 |
+ |22 |subscription-list |onap-amsterdam |subscription-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |23 |subscription-create |onap-1.1 |subscription-create-schema-1.1.yaml |1.0 |
+ |23 |subscription-create |onap-amsterdam |subscription-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |24 |subscription-delete |onap-1.1 |subscription-delete-schema-1.1.yaml |1.0 |
+ |24 |subscription-delete |onap-amsterdam |subscription-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |25 |customer-show |onap-1.0 |customer-show-schema.yaml |1.0 |
+ |25 |customer-show |openecomp |customer-show-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |26 |customer-show |onap-1.1 |customer-show-schema-1.1.yaml |1.0 |
+ |26 |customer-show |onap-amsterdam |customer-show-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |27 |customer-list |onap-1.0 |customer-list-schema.yaml |1.0 |
+ |27 |customer-list |openecomp |customer-list-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |28 |customer-delete |onap-1.0 |customer-delete-schema.yaml |1.0 |
+ |28 |customer-delete |openecomp |customer-delete-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |29 |customer-create |onap-1.0 |customer-create-schema.yaml |1.0 |
+ |29 |customer-create |openecomp |customer-create-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |30 |customer-create |onap-1.1 |customer-create-schema-1.1.yaml |1.0 |
+ |30 |customer-create |onap-amsterdam |customer-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |31 |customer-delete |onap-1.1 |customer-delete-schema-1.1.yaml |1.0 |
+ |31 |customer-delete |onap-amsterdam |customer-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |32 |customer-list |onap-1.1 |customer-list-schema-1.1.yaml |1.0 |
+ |32 |customer-list |onap-amsterdam |customer-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |33 |vf-list |onap-1.1 |vf-list-schema-1.1.yaml |1.0 |
+ |33 |vf-list |onap-amsterdam |vf-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |34 |service-list |onap-1.1 |service-list-schema-1.1.yaml |1.0 |
+ |34 |service-list |onap-amsterdam |service-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |35 |vf-show |onap-1.1 |vf-show-schema-1.1.yaml |1.0 |
+ |35 |vf-show |onap-amsterdam |vf-show-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |36 |tenant-create |onap-1.1 |tenant-create-schema-1.1.yaml |1.0 |
+ |36 |tenant-create |onap-amsterdam |tenant-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |37 |tenant-list |onap-1.1 |tenant-list-schema-1.1.yaml |1.0 |
+ |37 |tenant-list |onap-amsterdam |tenant-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |38 |tenant-delete |onap-1.1 |tenant-delete-schema-1.1.yaml |1.0 |
+ |38 |tenant-delete |onap-amsterdam |tenant-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |39 |service-type-create |onap-1.0 |service-type-create-schema.yaml |1.0 |
+ |39 |service-type-create |openecomp |service-type-create-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |40 |service-type-list |onap-1.1 |service-type-list-schema-1.1.yaml |1.0 |
+ |40 |service-type-list |onap-amsterdam |service-type-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |41 |service-type-create |onap-1.1 |service-type-create-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 |onap-1.0 |service-type-delete-schema.yaml |1.0 |
+ |42 |service-type-delete |openecomp |service-type-delete-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |43 |service-type-list |onap-1.0 |service-type-list-schema.yaml |1.0 |
+ |43 |service-type-list |openecomp |service-type-list-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |44 |service-type-delete |onap-1.1 |service-type-delete-schema-1.1.yaml |1.0 |
+ |44 |service-type-delete |onap-amsterdam |service-type-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |45 |cloud-create |onap-1.1 |cloud-create-schema-1.1.yaml |1.0 |
+ |45 |cloud-create |onap-amsterdam |cloud-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |46 |cloud-list |onap-1.0 |cloud-list-schema.yaml |1.0 |
+ |46 |cloud-list |openecomp |cloud-list-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |47 |microservice-delete |onap-1.1 |microservice-delete-schema.yaml |1.0 |
+ |47 |microservice-delete |onap-amsterdam |microservice-delete-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |48 |microservice-list |onap-1.1 |microservice-list-schema.yaml |1.0 |
+ |48 |microservice-list |onap-amsterdam |microservice-list-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |49 |microservice-show |onap-1.1 |microservice-show-schema.yaml |1.0 |
+ |49 |microservice-show |onap-amsterdam |microservice-show-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |50 |microservice-create |onap-1.1 |microservice-create-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-1.1 |vlm-checkin-schema-1.1.yaml |1.0 |
+ |53 |vlm-checkin |onap-amsterdam |vlm-checkin-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |54 |license-group-create |onap-1.0 |license-group-create-schema.yaml |1.0 |
+ |54 |license-group-create |openecomp |license-group-create-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |55 |vlm-key-group-create |onap-1.1 |vlm-key-group-create-schema-1.1.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-1.1 |vlm-aggreement-list-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-1.1 |vlm-key-group-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-1.1 |vlm-create-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-1.1 |vlm-entitlement-pool-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 |onap-1.0 |license-entitlement-pool-show-schema.yaml |1.0 |
+ |60 |ep-show |openecomp |license-entitlement-pool-show-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |61 |license-model-create |onap-1.0 |license-model-create-schema.yaml |1.0 |
+ |61 |license-model-create |openecomp |license-model-create-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |62 |license-group-show |onap-1.0 |license-group-show-schema.yaml |1.0 |
+ |62 |license-group-show |openecomp |license-group-show-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |63 |vsp-upload |onap-1.0 |vsp-upload-schema.yaml |1.0 |
+ |63 |vsp-upload |openecomp |vsp-upload-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |64 |vsp-package |onap-1.1 |vsp-package-schema-1.1.yaml |1.0 |
+ |64 |vsp-package |onap-amsterdam |vsp-package-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |65 |vsp-submit |onap-1.1 |vsp-submit-schema-1.1.yaml |1.0 |
+ |65 |vsp-submit |onap-amsterdam |vsp-submit-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |66 |vsp-checkout |onap-1.1 |vsp-checkout-schema-1.1.yaml |1.0 |
+ |66 |vsp-checkout |onap-amsterdam |vsp-checkout-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |67 |vsp-create |onap-1.0 |vsp-create-schema.yaml |1.0 |
+ |67 |vsp-create |openecomp |vsp-create-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |68 |vsp-list |onap-1.0 |vsp-list-schema.yaml |1.0 |
+ |68 |vsp-list |openecomp |vsp-list-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |69 |vsp-show |onap-1.1 |vsp-show-schema-1.1.yaml |1.0 |
+ |69 |vsp-show |onap-amsterdam |vsp-show-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |70 |vsp-show |onap-1.0 |vsp-show-schema.yaml |1.0 |
+ |70 |vsp-show |openecomp |vsp-show-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |71 |vsp-submit |onap-1.0 |vsp-submit-schema.yaml |1.0 |
+ |71 |vsp-submit |openecomp |vsp-submit-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |72 |vsp-create |onap-1.1 |vsp-create-schema-1.1.yaml |1.0 |
+ |72 |vsp-create |onap-amsterdam |vsp-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |73 |vsp-add-artifact |onap-1.1 |vsp-add-artifact-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-1.1 |vsp-revert-schema-1.1.yaml |1.0 |
+ |74 |vsp-revert |onap-amsterdam |vsp-revert-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |75 |vsp-checkin |onap-1.0 |vsp-checkin-schema.yaml |1.0 |
+ |75 |vsp-checkin |openecomp |vsp-checkin-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |76 |vsp-checkout |onap-1.1 |vsp-checkout-schema.yaml |1.0 |
+ |76 |vsp-checkout |onap-amsterdam |vsp-checkout-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |77 |vsp-validate |onap-1.1 |vsp-validate-schema-1.1.yaml |1.0 |
+ |77 |vsp-validate |onap-amsterdam |vsp-validate-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |78 |vsp-list |onap-1.1 |vsp-list-schema-1.1.yaml |1.0 |
+ |78 |vsp-list |onap-amsterdam |vsp-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |79 |vsp-checkin |onap-1.1 |vsp-checkin-schema-1.1.yaml |1.0 |
+ |79 |vsp-checkin |onap-amsterdam |vsp-checkin-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |80 |service-model-checkin |onap-1.1 |service-model-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-1.1 |service-model-distribute-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-1.1 |service-model-list-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-1.1 |service-model-certify-start-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-1.1 |service-model-add-vf-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-1.1 |service-model-certify-request-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-1.1 |service-model-checkout-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-1.1 |service-model-revert-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-1.1 |service-model-certify-complete-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-1.1 |service2vf-model-list-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-1.1 |service-model-create-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-1.1 |service-model-approve-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-1.1 |vf-model-create-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-1.1 |vf-model-checkin-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-1.1 |vlm-revert-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-1.1 |vlm-feature-group-create-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-1.1 |vlm-submit-schema-1.1.yaml |1.0 |
+ |96 |vlm-submit |onap-amsterdam |vlm-submit-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |97 |license-model-show |onap-1.0 |license-model-show-schema.yaml |1.0 |
+ |97 |license-model-show |openecomp |license-model-show-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |98 |vf-model-certify-start |onap-1.1 |vf-model-certify-start-schema-1.1.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-1.1 |vf-model-list-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-1.1 |vlm-entitlement-pool-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-1.1 |vlm-feature-group-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-1.1 |vlm-checkout-schema-1.1.yaml |1.0 |
+ |102 |vlm-checkout |onap-amsterdam |vlm-checkout-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |103 |vlm-list |onap-1.1 |vlm-list-schema-1.1.yaml |1.0 |
+ |103 |vlm-list |onap-amsterdam |vlm-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |104 |vlm-aggreement-create |onap-1.1 |vlm-aggreement-create-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-1.1 |vf-model-certify-request-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 |onap-1.0 |license-entitlement-pool-create-schema.yaml |1.0 |
+ |106 |ep-create |openecomp |license-entitlement-pool-create-schema.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |107 |vf2vfmodule-model-list |onap-1.1 |vf2vfmodule-model-list-schema-1.1.yaml |1.0 |
+ |107 |vf2vfmodule-model-list |onap-amsterdam |vf2vfmodule-model-list-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |108 |vf-model-certify-complete |onap-1.1 |vf-model-certify-complete-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-1.1 |service-delete-schema-1.1.yaml |1.0 |
+ |109 |service-delete |onap-amsterdam |service-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |110 |vfmodule-delete |onap-1.1 |vf-module-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-1.1 |vfmodule-create-schema-1.1.yaml |1.0 |
+ |111 |vfmodule-create |onap-amsterdam |vfmodule-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |112 |service-create |onap-1.1 |service-create-schema-1.1.yaml |1.0 |
+ |112 |service-create |onap-amsterdam |service-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |113 |vf-delete |onap-1.1 |vf-delete-schema-1.1.yaml |1.0 |
+ |113 |vf-delete |onap-amsterdam |vf-delete-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
- |114 |vf-create |onap-1.1 |vf-create-schema-1.1.yaml |1.0 |
+ |114 |vf-create |onap-amsterdam |vf-create-schema-1.1.yaml |1.0 |
+--------+--------------------------------+------------------+------------------------------------------------+----------+
diff --git a/docs/open_cli_schema_version_1_0.rst b/docs/open_cli_schema_version_1_0.rst
index 8d1726c0..59d0094e 100644
--- a/docs/open_cli_schema_version_1_0.rst
+++ b/docs/open_cli_schema_version_1_0.rst
@@ -485,22 +485,22 @@ name: host-username
long_option: host-username
- default_value: ${OPEN_CLI_USERNAME}
+ default_value: ${OPEN_CLI_HOST_USERNAME}
is_optional: false
-name: onap-password
+name: host-password
~~~~~~~~~~~~~~~~~~~
type: string
- description: Onap user password
+ description: Host user password
short_option: p
- long_option: onap-password
+ long_option: host-password
- default_value: ${ONAP_PASSWORD}
+ default_value: ${OPEN_CLI_HOST_PASSWORD}
is_secured: true
@@ -510,7 +510,7 @@ name: host-url
~~~~~~~~~~~~~~
type: url
- description: Onap host url
+ description: Host url
short_option: m
@@ -518,13 +518,13 @@ name: host-url
is_optional: false
- default_value: ${ONAP_HOST_URL}
+ default_value: ${OPEN_CLI_HOST_URL}
name: help
~~~~~~~~~~
type: string
- description: Onap command help message
+ description: Command help message
short_option: h
@@ -536,7 +536,7 @@ name: version
~~~~~~~~~~~~~
type: string
- description: Onap command service version
+ description: Command service version
short_option: v
@@ -606,27 +606,9 @@ name: no-auth
default_value: false
*NOTE*: no-auth parameter is very helpful to by-pass the login and logout phase
-of each commands. Please refere *service* section to find more details on login
+of each commands. Please refer *service* section to find more details on login
and logout.
-For example, OCLIP platform provides a command called 'schema-validate' to
-validate schematics of template against the specification defined in this
-document. For this command, host-url, onap-username, onap-password, no-auth
-parameters are required. so author could exclude these parameters by defining
-as :
-
- default_parameters:
- exclude:
- \- onap-username
-
- \- onap-password
-
- \- host-url
-
- \- no-auth
-
-
-
results
-------
Every command produces the output and *results* section helps to define the