summaryrefslogtreecommitdiffstats
path: root/docs/cmd_help.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/cmd_help.rst')
-rw-r--r--docs/cmd_help.rst10666
1 files changed, 4230 insertions, 6436 deletions
diff --git a/docs/cmd_help.rst b/docs/cmd_help.rst
index 6d2cbe27..87639d8d 100644
--- a/docs/cmd_help.rst
+++ b/docs/cmd_help.rst
@@ -9,62 +9,58 @@
.. _cli_cmd_help:
-<<<<<<< 74528bd0c35056e2e10d0aa29aac387cb6d6b05d
onap-1.1
==========================
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
-[1] microservice-delete
-=======
-[1] microservice-show
+[1] catalog
-----------------------------------------------
-usage: onap microservice-show
+usage: oclip catalog
-Details the registered microservice in Onap
+ONAP catalog command to find the base path for service.
-Onap service: msb v1
+Product: onap-1.1
+Service: msb
+Author: ONAP CLI Team onap-discuss@lists.onap.org
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.
+ [-l | --catalog-service-name] [-i | --catalog-service-version] [-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.
+ -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::
@@ -73,67 +69,43 @@ Error::
-[2] microservice-create
+[2] basic-logout
-----------------------------------------------
-usage: onap microservice-create
+usage: oclip basic-logout
-Register microservice into Onap
+ONAP basic logout auth command
-Onap service: msb v1
+Product: onap-1.1
+Service: basic-auth
+Author: ONAP CLI Team onap-discuss@lists.onap.org
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]
+ [-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.
- -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 OPEN_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.
-
-
-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.
+ -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::
@@ -142,102 +114,60 @@ Error::
-[3] microservice-delete
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+[3] sdc-basic-login
-----------------------------------------------
-usage: onap microservice-delete
+usage: oclip sdc-basic-login
-Deletes the micro service from Onap
+ONAP basic login auth command
-Onap service: msb v1
+Product: onap-1.1
+Service: sdc-basic-auth
+Author: ONAP CLI Team onap-discuss@lists.onap.org
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]
-
-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 OPEN_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.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[2] microservice-list
------------------------------------------------
-
-
-usage: onap microservice-list
-
-Lists the registetred micro services in Onap
-
-Onap service: msb v1
-
-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]
+ [-u | --host-username] [-p | --host-password] [-m | --host-url]
+ [-a | --no-auth]
where::
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
+ -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 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.
+ 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::
@@ -246,54 +176,59 @@ Error::
-[3] microservice-show
+[4] basic-login
-----------------------------------------------
-usage: onap microservice-show
+usage: oclip basic-login
-Details the registered microservice in Onap
+ONAP basic login auth command
-Onap service: msb v1
+Product: onap-1.1
+Service: basic-auth
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --service-name] [-y | --service-version] [-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 | --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 OPEN_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.
+ -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 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.
+ 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::
@@ -302,104 +237,76 @@ Error::
-[4] microservice-create
+[5] service-create
-----------------------------------------------
-usage: onap microservice-create
+usage: oclip service-create
-Register microservice into Onap
+Create a service instance using MSO
-Onap service: msb v1
+Product: onap-1.1
+Service: so
+Author: ONAP CLI Team onap-discuss@lists.onap.org
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]
-
-where::
-
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- -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
-=======
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -b | --service-model-id Service model ID. It is of type STRING. It is
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
- 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.
- -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.
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
+ [-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::
+
+ -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.
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.
-=======
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-=======
- -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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+ service-id instance id for the created service. and is of
+ type STRING.
Error::
@@ -408,114 +315,67 @@ Error::
-[5] vlm-checkin
+[6] service-delete
-----------------------------------------------
-usage: onap vlm-checkin
+usage: oclip service-delete
-Checkin Vendor License Model
-
-Onap service: sdc v1.0
-
-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]
-
-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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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>
-
-
-
-[6] vlm-key-group-create
------------------------------------------------
-
-
-usage: onap vlm-key-group-create
-
-Create License Key Group
+Delete service instance (experimental)
-Onap service: sdc v1.0
+Product: onap-1.1
+Service: so
+Author: ONAP CLI Team onap-discuss@lists.onap.org
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]
+ [-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::
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- -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.
-=======
- -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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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::
@@ -524,88 +384,65 @@ Error::
-[9] vlm-checkout
+[7] vf-module-create
-----------------------------------------------
-usage: onap vlm-checkout
+usage: oclip vf-module-create
-Checkout Vendor License Model
+Create a VF Module
-Onap service: sdc v1.0
+Product: onap-1.1
+Service: so
+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 | --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::
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -x | --vlm-id Onap VLM ID. It is of type STRING.
- -y | --vlm-version VLM version. It is of type STRING.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
- -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.
-=======
- -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
- 0f4899c3-771c-462e-9dc8-ffa2de5532f6.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
-
-
-Results::
-
- ID License Model 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.
+ -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::
@@ -614,62 +451,62 @@ Error::
-[7] vlm-aggreement-list
+[8] vfmodule-delete
-----------------------------------------------
-usage: onap vlm-aggreement-list
+usage: oclip vfmodule-delete
-List license aggreement
+delete a VF module (experimental)
-Onap service: sdc v1.0
+Product: onap-1.1
+Service: so
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
-=======
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- [-x | --vendor-name] [-y | --description] [-u | --onap-username]
-=======
- [-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 | --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 | --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
- adbbea15-de1a-442a-a0e3-793779ea25bb.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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::
@@ -678,59 +515,84 @@ Error::
-tenant-list
+[9] vfmodule-create
-----------------------------------------------
-usage: onap tenant-list
+usage: oclip vfmodule-create
-Lists the tenants under given cloud region in Onap
+Create a VF module
-Onap service: aai v11
+Product: onap-1.1
+Service: so
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --cloud] [-y | --region] [-u | --onap-username]
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
- [-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 | --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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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::
- ID aggreement ID and is of type STRING.
- name aggreement name and is of type STRING.
+ vfmodule-id id for the created vnf and is of type STRING.
Error::
@@ -739,128 +601,77 @@ Error::
-[8] vlm-key-group-list
+[10] vf-create
-----------------------------------------------
-usage: onap vlm-key-group-list
+usage: oclip vf-create
-key group list in a license model
+Create a VF
-Onap service: sdc v1.0
+Product: onap-1.1
+Service: so
+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]
-
-where::
-
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- -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.
-=======
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+ [-h | --help] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-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::
+
+ -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::
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- 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.
-=======
- -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
- 93230cdb-aae3-4b87-a38a-fc4529e8aac9.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+ vf-id id for the created vnf and is of type STRING.
Error::
@@ -869,57 +680,67 @@ Error::
-[9] vlm-create
+[11] vf-delete
-----------------------------------------------
-usage: onap vlm-create
+usage: oclip vf-delete
-Create License Model
+delete a VF (experimental)
-Onap service: sdc v1.0
+Product: onap-1.1
+Service: so
+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]
+ [-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 | --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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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 UUID.
+ -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::
@@ -928,95 +749,62 @@ Error::
-[10] vlm-entitlement-pool-create
+[12] service-model-add-vf
-----------------------------------------------
-usage: onap vlm-entitlement-pool-create
+usage: oclip service-model-add-vf
-Create Entitlement Pool
+Helps to add VF into service models in SDC
-Onap service: sdc v1.0
+Product: onap-1.1
+Service: sdc
+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]
-
-where::
-
-<<<<<<< ece4fcf67742a307d5d68fbde1723f3e0485b7fb
- -x | --name Entitlement Pool name. It is of type STRING.
-=======
-<<<<<<< 476f5637ae4e816f7abf3536c5eeb156e0af6bed
- -x | --name Feature group name. It is of type STRING.
->>>>>>> Normalize all env with OPEN_CLI
- -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.
-=======
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
->>>>>>> Normalize all env with OPEN_CLI
+ [-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::
+
+ -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::
- ID Entitlement Pool ID and is of type STRING.
+ ID Service ID and is of type STRING.
Error::
@@ -1025,51 +813,54 @@ Error::
-[11] vsp-package
+[13] service-model-certify-start
-----------------------------------------------
-usage: onap vsp-package
+usage: oclip service-model-certify-start
-Package Vendor Software Product
+Starts the certification of Service model in SDC
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
+ [-b | --service-model-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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
+ -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.
Error::
@@ -1078,51 +869,54 @@ Error::
-[12] vsp-submit
+[14] service-model-checkin
-----------------------------------------------
-usage: onap vsp-submit
+usage: oclip service-model-checkin
-Submit Vendor Software Product
+Checkin Service model in SDC
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
+ [-b | --service-model-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
- OPEN_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
+ -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.
Error::
@@ -1131,176 +925,54 @@ Error::
-[13] vsp-checkout
+[15] service-model-revert
-----------------------------------------------
-usage: onap vsp-checkout
-
-Checkout Vendor Software Product
-
-Onap service: sdc v1.0
+usage: oclip service-model-revert
-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]
-
-where::
-
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
-=======
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -x | --vlm-id License Model ID. It is of type STRING.
- -y | --vlm-version License Model version. It is of type STRING.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
- -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.
-
-
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
-=======
-Results::
-
- ID Feature group ID and is of type STRING.
- name Feature group name and is of type STRING.
-=======
- -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
- 65c6f4af-893f-4130-aa79-9158fcaed040.
- -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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
-
-
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[14] vsp-show
------------------------------------------------
-
-
-usage: onap vsp-show
-
-Details of the Vendor Software Product
+Checkout Service model in SDC
-Onap service: sdc v1.0
+Product: onap-1.1
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- [-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]
-=======
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
-=======
- [-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]
+ [-b | --service-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
- e74f4b44-28ee-45e4-a1ac-7c3a0ed4a0b7.
- -y | --vnfm-id Onap VNFM unique id. It is of type UUID. By
- default, it is
- 7a74f262-5b96-4445-8a56-2d43b73f6f6c.
- -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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
+ -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.
Error::
@@ -1309,65 +981,71 @@ Error::
-vnfm-list
+[16] service-model-create
-----------------------------------------------
-usage: onap vnfm-list
+usage: oclip service-model-create
-List the configured vnfm
+Create Service model in SDC
-Onap service: aai v11
+Product: onap-1.1
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
[-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]
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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::
- 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.
+ ID Service ID and is of type STRING.
Error::
@@ -1376,213 +1054,54 @@ Error::
-[15] vsp-create
+[17] service-model-distribute
-----------------------------------------------
-usage: onap vsp-create
+usage: oclip service-model-distribute
-Create Vendor Software Product
+Distributes the Service model in SDC
-Onap service: sdc v1.0
+Product: onap-1.1
+Service: sdc
+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]
+ [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- -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.
-=======
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -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.
-=======
- -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
- 3def24ae-701e-4c98-91a6-859c0f206759.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[19] vlm-submit
------------------------------------------------
-
-
-usage: onap vlm-submit
-
-Submit Vendor License Model
-
-Onap service: sdc v1.0
-
-Options::
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
-
-
-Results::
-
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- ID VSP ID and is of type STRING.
-=======
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -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.
-=======
- -x | --service-type-id Onap service type uuid. It is of type UUID. It is
- optional. By default, it is
- 04ebd209-7800-43f4-bca4-aaf61e15783e.
- -y | --resource-version Onap service resource version. It is of type
- UUID. It is optional. By default, it is
- 7b301a17-5eb2-413b-b214-fd1659fdf049.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+ -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 | --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.
Error::
@@ -1591,113 +1110,63 @@ Error::
-[16] vsp-add-artifact
+[18] service-model-list
-----------------------------------------------
-usage: onap vsp-add-artifact
+usage: oclip service-model-list
-Upload the CSAR file to VSP
+List the service model in SDC
-Onap service: sdc v1.0
+Product: onap-1.1
+Service: sdc
+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]
+ [-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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
-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::
-
- [-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::
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
-=======
- -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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
+ 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::
@@ -1706,50 +1175,54 @@ Error::
-cloud-list
+[19] service-model-checkout
-----------------------------------------------
-usage: onap cloud-list
+usage: oclip service-model-checkout
-List the configured clouds and Onap service subscriptions
+Checkout Service model in SDC
-Onap service: aai v11
+Product: onap-1.1
+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]
+ [-b | --service-model-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
+ -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.
Error::
@@ -1758,209 +1231,61 @@ Error::
-[18] vsp-checkout
+[20] service2vf-model-list
-----------------------------------------------
-usage: onap vsp-checkout
+usage: oclip service2vf-model-list
-Checkout Vendor Software Product
-
-Onap service: sdc v1.0
-
-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]
-
-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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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>
-
-
-
-[19] vsp-validate
------------------------------------------------
-
-
-usage: onap vsp-validate
-
-Validated the uploaded Vendor Software Product
-
-Onap service: sdc v1.0
-
-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]
-
-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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
-
-
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
-=======
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[24] vsp-create
------------------------------------------------
-
-
-usage: onap vsp-create
-
-Create Vendor Software Product
+List the VF in a given service model in SDC
-Onap service: sdc v1.0
+Product: onap-1.1
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
Options::
- [-x | --vsp-name] [-y | --vsp-description] [-z | --vsp-category]
- [-b | --vsp-subcategory] [-c | --vsp-license-version] [-e | --vsp-vendor-name]
- [-g | --vsp-vendor-id] [-i | --license-agreement-id] [-j | --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 | --service-model-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.
+ -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.
-where::
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -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 | --vsp-license-version License version. It is of type STRING. It is
- optional. By default, it is 1.0.
- -e | --vsp-vendor-name License Model Name. It is of type STRING.
- -g | --vsp-vendor-id License Model ID. It is of type STRING.
- -i | --license-agreement-id License Agreement ID. It is of type STRING.
- -j | --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.
-=======
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
-
-
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
Results::
- status Validation status and is of type STRING.
- errors Validation messages and is of type JSON.
+ 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::
@@ -1969,60 +1294,53 @@ Error::
-[20] vsp-list
+[21] vf-model-certify-complete
-----------------------------------------------
-usage: onap vsp-list
+usage: oclip vf-model-certify-complete
-List of the Vendor Software Products
+Complete certifying Virtual function
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
+ [-b | --vf-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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
- 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.
+ -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 | --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.
Error::
@@ -2031,58 +1349,53 @@ Error::
-[21] vsp-checkin
+[22] vf-model-certify-request
-----------------------------------------------
-usage: onap vsp-checkin
+usage: oclip vf-model-certify-request
-Checkin Vendor Software Product
+Request for certifying Virtual function
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
+ [-b | --vf-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
-=======
- -x | --ems-id Onap EMS unique id. It is of type UUID. By
- default, it is
- efba894e-20f4-4658-9d43-1f8736188d3d.
- -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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
+ -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.
Error::
@@ -2091,70 +1404,53 @@ Error::
-sdnc-register
+[23] vf-model-certify-start
-----------------------------------------------
-usage: onap sdnc-register
+usage: oclip vf-model-certify-start
-Register a SDNC in Onap
+Start certifying Virtual function
-Onap service: aai v11
+Product: onap-1.1
+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]
+ [-b | --vf-id] [-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
- 0f283039-a3fd-4fe1-ac14-b8cdb3a20b26.
- -y | --sdnc-id Onap SDNC unique id. It is of type UUID. By
- default, it is
- b112c385-90ad-4eb7-ae6d-1f263925e97e.
- -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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
+ -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.
Error::
@@ -2163,79 +1459,53 @@ Error::
-[22] service-model-checkin
+[24] vf-model-checkin
-----------------------------------------------
-usage: onap service-model-checkin
+usage: oclip vf-model-checkin
-Checkin Service model in SDC
+Checkin Virtual function
-Onap service: sdc v1.0
+Product: onap-1.1
+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 | --vf-id] [-u | --host-username] [-p | --host-password]
+ [-m | --host-url] [-a | --no-auth]
where::
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- -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.
- -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.
-=======
- -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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
+ -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.
Error::
@@ -2244,64 +1514,64 @@ Error::
-[28] vsp-show
+[25] vf-model-create
-----------------------------------------------
-usage: onap vsp-show
+usage: oclip vf-model-create
-Details of the Vendor Software Product
+Create Virtual function from Vendor Software Product
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
-
-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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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] [-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::
+
+ -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 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::
- 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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+ ID VF ID and is of type STRING.
Error::
@@ -2310,214 +1580,65 @@ Error::
-[23] service-model-distribute
+[26] vf-model-list
-----------------------------------------------
-usage: onap service-model-distribute
+usage: oclip vf-model-list
-Distributes the 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::
-
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- -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.
-=======
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -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.
-=======
- -x | --vnfm-id Onap VNFM unique id. It is of type UUID. By
- default, it is
- d8a2726f-18a6-4bb1-904f-554a3fb70865.
- -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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_HOST_URL.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
- -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.
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
-=======
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[24] service-model-list
------------------------------------------------
-
-
-usage: onap service-model-list
-
-List the service model in SDC
+List the VF resource model in SDC
-Onap service: sdc v1.0
+Product: onap-1.1
+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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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::
- 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]
-
-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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
+ uuid UUID and is of type STRING.
+ uniqueid UUID and is of type STRING.
+ invariant-uuid Invariant UUID and is of type STRING.
+ name Name and is of type STRING.
+ version version and is of type STRING.
+ status status and is of type STRING.
+ description description and is of type STRING.
+ vsp-uuid VSP uuid and is of type STRING.
+ vsp-version VSP version and is of type STRING.
Error::
@@ -2526,186 +1647,63 @@ Error::
-[26] service-model-add-vf
+[27] vf2vfmodule-model-list
-----------------------------------------------
-usage: onap service-model-add-vf
+usage: oclip vf2vfmodule-model-list
-Helps to add VF into service models in SDC
+List the VF modules in a given VF model in SDC
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
-
-where::
-
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- -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.
-=======
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -b | --service-model-id Service model ID. It is of type STRING. It is
- optional.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
- -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.
-=======
- -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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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-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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+ [-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::
+
+ -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.
+ -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 Service ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[27] service-model-certify-request
------------------------------------------------
-
-
-usage: onap service-model-certify-request
-
-Request 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::
-
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -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.
- -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.
-=======
- -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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+ 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::
@@ -2714,345 +1712,70 @@ Error::
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
-[28] service-model-revert
-=======
-[34] service-model-create
+[28] ep-create
-----------------------------------------------
-usage: onap service-model-create
+usage: oclip ep-create
-Create Service model in SDC
+Create Entitlement Pool
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
+ [-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::
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -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.
-=======
- -x | --service-instace-id unique id for service instance. It is of type
- STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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>
-
-
-
-vnf-create
------------------------------------------------
-
-
-usage: onap vnf-create
-
-Create a VNF
-
-Onap service: mso v2
-
-Options::
-
- [-l | --lcp-cloudregion-id] [-z | --tenant-id] [-w | --product-family-id]
- [-i | --instance-name] [-r | --supress-rollback] [-y | --service-instance-id]
- [-x | --parenet-service-model] [-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 | --lcp-cloudregion-id AIC LCP node location identifier. It is of type
- STRING.
- -z | --tenant-id openstack tenant id (uuid). It is of type STRING.
- -w | --product-family-id UUID for product family (named service id in
- AAI). It is of type STRING.
- -i | --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.
- -y | --service-instance-id unique id for service instance. It is of type
- STRING.
- -x | --parenet-service-model parent service model name. It is of type STRING.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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 Service ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[35] service-model-distribute
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
------------------------------------------------
-
-
-usage: onap service-model-revert
-
-Checkout 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::
-
-<<<<<<< 476f5637ae4e816f7abf3536c5eeb156e0af6bed
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -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.
- -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.
-=======
-=======
->>>>>>> Normalize all env with OPEN_CLI
- -x | --vnf-instace-id id for vnf. It is of type STRING.
- -y | --service-instace-id unique id for service instance. It is of type
- STRING.
- -l | --lcp-cloudregion-id AIC LCP node location identifier. It is of type
- STRING.
- -z | --tenant-id openstack tenant id (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
-<<<<<<< 476f5637ae4e816f7abf3536c5eeb156e0af6bed
- OPEN_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_PASSWORD. Secured.
-=======
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
->>>>>>> Normalize all env with OPEN_CLI
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[29] service-model-checkout
------------------------------------------------
-
-
-usage: onap service-model-checkout
-
-Checkout 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::
-
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- -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.
- -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>
-
-
-
-[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,
- 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.
+ ID Entitlement Pool ID and is of type STRING.
Error::
@@ -3061,94 +1784,62 @@ Error::
-[31] service2vf-model-list
+[29] ep-show
-----------------------------------------------
-usage: onap service2vf-model-list
+usage: oclip ep-show
-List the VF in a given service model in SDC
+Details of the Entitlement Pool
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
-
-where::
-
-=======
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
- -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.
- -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] [-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::
+
+ -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::
- 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.
-=======
- -c | --global-subscriber-id unique id for customer. It is of type STRING.
- -b | --subscriber-name subscriber name. It is of type STRING. It is
- optional.
- -i | --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.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+ 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::
@@ -3157,122 +1848,62 @@ Error::
-[32] service-model-create
+[30] license-group-create
-----------------------------------------------
-usage: onap service-model-create
+usage: oclip license-group-create
-Create Service model in SDC
+Create License Group
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
+ [-x | --group-name] [-y | --license-model-id] [-z | --license-group-description]
+ [-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.
+ -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 Service ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[33] service-model-approve
------------------------------------------------
-
-
-usage: onap service-model-approve
-
-Approves the 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::
-
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- -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.
- -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.
+ ID License Group ID and is of type STRING.
Error::
@@ -3281,98 +1912,62 @@ Error::
-[34] vf-model-create
+[31] license-group-show
-----------------------------------------------
-usage: onap vf-model-create
+usage: oclip license-group-show
-Create Virtual function from Vendor Software Product
+Details of the License Group
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
-
-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.
-=======
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -b | --vf-id VF ID. It is of type STRING. It is optional.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
- -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.
-=======
- -x | --vnf-instace-id id for vnf. It is of type STRING.
- -y | --service-instace-id unique id for service instance. It is of type
- STRING.
- -w | --vf-module-id vf module id. It is of type STRING.
- -l | --lcp-cloudregion-id AIC LCP node location identifier. It is of type
- STRING.
- -z | --tenant-id openstack tenant id (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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+ [-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::
- ID VF ID and is of type STRING.
+ 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::
@@ -3381,88 +1976,60 @@ Error::
-[35] vf-model-checkin
+[32] license-model-create
-----------------------------------------------
-usage: onap vf-model-checkin
+usage: oclip license-model-create
-Checkin Virtual function
+Create License Model
-Onap service: sdc v1.0
+Product: onap-1.1
+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 | --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.
-where::
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -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.
- -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.
-=======
- -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 | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+Results::
+
+ ID License Model ID and is of type STRING.
Error::
@@ -3471,90 +2038,62 @@ Error::
-[36] vlm-revert
+[33] license-model-show
-----------------------------------------------
-usage: onap vlm-revert
+usage: oclip license-model-show
-Revert Vendor License Model
+Details of the License Model
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
-
-where::
-
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- -x | --vlm-id Onap VLM ID. It is of type STRING.
- -y | --vlm-version VLM version. It is of type STRING.
-=======
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -b | --vf-id VF ID. It is of type STRING. It is optional.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
- -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.
-=======
- -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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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] [-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::
+
+ -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.
+ -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.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+ 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::
@@ -3563,66 +2102,63 @@ Error::
-[37] vlm-feature-group-create
+[34] vlm-aggreement-create
-----------------------------------------------
-usage: onap vlm-feature-group-create
+usage: oclip vlm-aggreement-create
-Create feature group Pool
+Create license aggreement
-Onap service: sdc v1.0
+Product: onap-1.1
+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-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::
-
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- -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.
+ [-z | --description] [-g | --vlm-feature-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 | --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.
Results::
- ID Feature group ID and is of type STRING.
+ ID aggreement ID and is of type STRING.
Error::
@@ -3631,101 +2167,60 @@ Error::
-[38] vlm-submit
+[35] vlm-aggreement-list
-----------------------------------------------
-usage: onap vlm-submit
+usage: oclip vlm-aggreement-list
-Submit Vendor License Model
+List license aggreement
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
-
-where::
-
- -x | --vlm-id Onap VLM ID. It is of type STRING.
- -y | --vlm-version VLM version. It is of type STRING.
-=======
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- -b | --vf-id VF ID. It is of type STRING. It is optional.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
- -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.
-=======
- -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.
- -null | --vsp-category Category of the VSP. It is of type STRING. It is
- optional. By default, it is
- resourceNewCategory.generic.
- -null | --vsp-subcategory Sub Category of VSP. It is of type STRING. It is
- optional. By default, it is
- resourceNewCategory.generic.abstract.
- -null | --vsp-license-version License version. It is of type STRING. It is
- optional. By default, it is 1.0.
- -null | --vsp-vendor-name License Model Name. It is of type STRING.
- -null | --vsp-vendor-id License Model ID. It is of type STRING.
- -null | --license-agreement-id License Agreement ID. It is of type STRING.
- -null | --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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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] [-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::
+
+ -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 | --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 VSP ID and is of type STRING.
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+ ID aggreement ID and is of type STRING.
+ name aggreement name and is of type STRING.
Error::
@@ -3734,50 +2229,54 @@ Error::
-[39] vf-model-certify-start
+[36] vlm-checkin
-----------------------------------------------
-usage: onap vf-model-certify-start
+usage: oclip vlm-checkin
-Start certifying Virtual function
+Checkin Vendor License Model
-Onap service: sdc v1.0
+Product: onap-1.1
+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
- OPEN_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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 | --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.
Error::
@@ -3786,62 +2285,54 @@ Error::
-[40] vf-model-list
+[37] vlm-checkout
-----------------------------------------------
-usage: onap vf-model-list
+usage: oclip vlm-checkout
-List the VF resource model in SDC
+Checkout Vendor License Model
-Onap service: sdc v1.0
+Product: onap-1.1
+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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
- uniqueid UUID and is of type STRING.
- invariant-uuid Invariant UUID and is of type STRING.
- name Name and is of type STRING.
- version version and is of type STRING.
- status status and is of type STRING.
- description description and is of type STRING.
- vsp-uuid VSP uuid and is of type STRING.
- vsp-version VSP version and is of type STRING.
+ -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 | --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.
Error::
@@ -3850,57 +2341,60 @@ Error::
-[41] vlm-entitlement-pool-list
+[38] vlm-create
-----------------------------------------------
-usage: onap vlm-entitlement-pool-list
+usage: oclip vlm-create
-entitlement pool list in a license model
+Create License Model
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
-
-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
- OPEN_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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] [-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::
+
+ -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 | --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 Feature group ID and is of type STRING.
- name Feature group name and is of type STRING.
+ ID License Model ID and is of type UUID.
Error::
@@ -3909,57 +2403,67 @@ Error::
-[42] vlm-feature-group-list
+[39] vlm-entitlement-pool-create
-----------------------------------------------
-usage: onap vlm-feature-group-list
+usage: oclip vlm-entitlement-pool-create
-Feature group list in a license model
+Create Entitlement Pool
-Onap service: sdc v1.0
+Product: onap-1.1
+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 | --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 | --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 | --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 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::
@@ -3968,111 +2472,60 @@ Error::
-[43] vlm-checkout
+[40] vlm-entitlement-pool-list
-----------------------------------------------
-usage: onap vlm-checkout
-
-Checkout Vendor License Model
-
-Onap service: sdc v1.0
+usage: oclip vlm-entitlement-pool-list
-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]
-
-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.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[44] vlm-list
------------------------------------------------
-
-
-usage: onap vlm-list
-
-List License Model
+entitlement pool list in a license model
-Onap service: sdc v1.0
+Product: onap-1.1
+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.
+ [-x | --vlm-id] [-y | --vlm-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 | --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 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 Feature group ID and is of type STRING.
+ name Feature group name and is of type STRING.
Error::
@@ -4081,112 +2534,68 @@ Error::
-[45] vlm-aggreement-create
+[41] vlm-feature-group-create
-----------------------------------------------
-usage: onap vlm-aggreement-create
+usage: oclip vlm-feature-group-create
-Create license aggreement
+Create feature group Pool
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
-
-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.
- -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.
+ [-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::
+
+ -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 aggreement ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[46] vf-model-certify-request
------------------------------------------------
-
-
-usage: onap vf-model-certify-request
-
-Request for certifying Virtual function
-
-Onap service: sdc v1.0
-
-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]
-
-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.
- -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.
+ ID Feature group ID and is of type STRING.
Error::
@@ -4195,60 +2604,60 @@ Error::
-[47] vf2vfmodule-model-list
+[42] vlm-feature-group-list
-----------------------------------------------
-usage: onap vf2vfmodule-model-list
+usage: oclip vlm-feature-group-list
-List the VF modules in a given VF model in SDC
+Feature group list in a license model
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
-
-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.
- -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] [-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::
+
+ -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 | --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::
- 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 Feature group ID and is of type STRING.
+ name Feature group name and is of type STRING.
Error::
@@ -4257,50 +2666,54 @@ Error::
-[48] vf-model-certify-complete
+[43] service-model-certify-complete
-----------------------------------------------
-usage: onap vf-model-certify-complete
+usage: oclip service-model-certify-complete
-Complete certifying Virtual function
+Completes the certification of Service model in SDC
-Onap service: sdc v1.0
+Product: onap-1.1
+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 | --service-model-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.
- -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.
+ -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.
Error::
@@ -4309,60 +2722,65 @@ Error::
-[49] cloud-list
+[44] vlm-key-group-create
-----------------------------------------------
-usage: onap cloud-list
+usage: oclip vlm-key-group-create
-List the configured clouds and Onap service subscriptions
+Create License Key Group
-Onap service: aai v11
+Product: onap-1.1
+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.
+ [-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,
+ 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.
+ -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::
@@ -4371,55 +2789,60 @@ Error::
-[50] sdnc-list
+[45] vlm-key-group-list
-----------------------------------------------
-usage: onap sdnc-list
+usage: oclip vlm-key-group-list
-List the configured sdnc
+key group list in a license model
-Onap service: aai v11
+Product: onap-1.1
+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.
+ [-x | --vlm-id] [-y | --vlm-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 | --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::
- sdnc-id Onap sdnc id and is of type STRING.
- resource-version Onap sdnc 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::
@@ -4428,185 +2851,54 @@ Error::
-[51] sdnc-register
+[46] vlm-revert
-----------------------------------------------
-usage: onap sdnc-register
+usage: oclip vlm-revert
-Register a SDNC in Onap
+Revert Vendor License Model
-Onap service: aai v11
+Product: onap-1.1
+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]
-
-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.
- -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>
-
-
-
-[52] sdnc-unregister
------------------------------------------------
-
-
-usage: onap sdnc-unregister
-
-Un-register a VNFM in Onap
-
-Onap service: aai v11
-
-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]
-
-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.
- -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>
-
-
-
-[53] vnfm-show
------------------------------------------------
-
-
-usage: onap vnfm-show
-
-Show the VNFM in Onap
-
-Onap service: aai v11
-
-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]
+ [-x | --vlm-id] [-y | --vlm-version] [-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.
- -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 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.
+ -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 | --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.
Error::
@@ -4615,54 +2907,56 @@ Error::
-[54] vnfm-unregister
+[47] vsp-add-artifact
-----------------------------------------------
-usage: onap vnfm-unregister
+usage: oclip vsp-add-artifact
-Un-register a VNFM in Onap
+Upload the CSAR file to VSP
-Onap service: aai v11
+Product: onap-1.1
+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]
+ [-x | --vsp-id] [-y | --vsp-version] [-z | --vsp-file]
+ [-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.
- -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 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.
Error::
@@ -4671,67 +2965,54 @@ Error::
-[55] vnfm-register
+[48] vsp-checkout
-----------------------------------------------
-usage: onap vnfm-register
+usage: oclip vsp-checkout
-Register a VNFM in Onap
+Checkout Vendor Software Product
-Onap service: aai v11
+Product: onap-1.1
+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 | --vsp-id] [-y | --vsp-version] [-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.
- -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::
@@ -4740,130 +3021,75 @@ Error::
-[56] vnfm-list
+[49] vsp-create
-----------------------------------------------
-usage: onap vnfm-list
+usage: oclip vsp-create
-List the configured vnfm
+Create Vendor Software Product
-Onap service: aai v11
+Product: onap-1.1
+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 | --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::
- -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-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::
- vnfm-id Onap vnfm id and is of type STRING.
- vim-id Onap vnfm id and is of type STRING.
- certificate-url Onap vnfm certificate-url and is of type STRING.
- resource-version Onap vnfm resource version and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[57] vim-register
------------------------------------------------
-
-
-usage: onap vim-register
-
-Register a VIM under a given cloud region in Onap
-
-Onap service: aai v11
-
-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]
-
-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.
- -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.
+ ID VSP ID and is of type STRING.
Error::
@@ -4872,57 +3098,54 @@ Error::
-[58] vim-unregister
+[50] vsp-package
-----------------------------------------------
-usage: onap vim-unregister
+usage: oclip vsp-package
-Un-register a VIM under from cloud region in Onap
+Package Vendor Software Product
-Onap service: aai v11
+Product: onap-1.1
+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 | --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 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 | --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::
@@ -4931,65 +3154,54 @@ Error::
-[59] vim-list
+[51] service-model-approve
-----------------------------------------------
-usage: onap vim-list
+usage: oclip service-model-approve
-List the configured vims
+Approves the Service model in SDC
-Onap service: aai v11
+Product: onap-1.1
+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]
+ [-b | --service-model-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.
- -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::
-
- 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.
+ -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 | --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.
Error::
@@ -4998,55 +3210,61 @@ Error::
-[60] ems-list
+[52] vlm-list
-----------------------------------------------
-usage: onap ems-list
+usage: oclip vlm-list
-List the configured ems
+List License Model
-Onap service: aai v11
+Product: onap-1.1
+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.
- -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::
- ems-id Onap ems id and is of type STRING.
- resource-version Onap ems 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::
@@ -5055,63 +3273,54 @@ Error::
-[61] ems-register
+[53] vlm-submit
-----------------------------------------------
-usage: onap ems-register
+usage: oclip vlm-submit
-Register a EMS in Onap
+Submit Vendor License Model
-Onap service: aai v11
+Product: onap-1.1
+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.
- -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 | --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.
Error::
@@ -5120,62 +3329,54 @@ Error::
-[62] ems-show
+[54] vsp-checkin
-----------------------------------------------
-usage: onap ems-show
+usage: oclip vsp-checkin
-Show the details of configured ems
+Checkin Vendor Software Product
-Onap service: aai v11
+Product: onap-1.1
+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] [-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.
- -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 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.
+ -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::
@@ -5184,173 +3385,63 @@ Error::
-[63] cloud-delete
+[55] vsp-list
-----------------------------------------------
-usage: onap cloud-delete
+usage: oclip vsp-list
-Delete a cloud region from Onap
+List of the Vendor Software Products
-Onap service: aai v11
+Product: onap-1.1
+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]
+ [-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.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[64] ems-unregister
------------------------------------------------
-
-
-usage: onap ems-unregister
-
-Un-register a EMS in Onap
-
-Onap service: aai v11
-
-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]
-
-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.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[65] subscription-list
------------------------------------------------
-
-
-usage: onap subscription-list
-
-Lists the subscription for a given customer in Onap
-
-Onap service: aai v11
-
-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]
-
-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.
+ -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.
+ 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::
@@ -5359,111 +3450,54 @@ Error::
-[66] subscription-create
+[56] vsp-revert
-----------------------------------------------
-usage: onap subscription-create
-
-Create a subscription of a customer for given service in specific cloud region in Onap
-
-Onap service: aai v11
-
-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]
-
-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.
- -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>
-
-
+usage: oclip vsp-revert
-[67] subscription-delete
------------------------------------------------
-
-
-usage: onap subscription-delete
-
-Delete the subscription for a given customer in Onap
+Revert Vendor Software Product
-Onap service: aai v11
+Product: onap-1.1
+Service: sdc
+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 | --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.
- -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.
- -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::
@@ -5472,59 +3506,66 @@ Error::
-[68] customer-show
+[57] vsp-show
-----------------------------------------------
-usage: onap customer-show
+usage: oclip vsp-show
-Lists the registetred customers in Onap
+Details of the Vendor Software Product
-Onap service: aai v11
+Product: onap-1.1
+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]
-
-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] [-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 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::
- 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 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::
@@ -5533,51 +3574,54 @@ Error::
-[69] customer-create
+[58] service-model-certify-request
-----------------------------------------------
-usage: onap customer-create
+usage: oclip service-model-certify-request
-Create a customer in Onap
+Request the certification of Service model in SDC
-Onap service: aai v11
+Product: onap-1.1
+Service: sdc
+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]
+ [-b | --service-model-id] [-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
- 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.
+ -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.
Error::
@@ -5586,53 +3630,54 @@ Error::
-[70] customer-delete
+[59] vsp-submit
-----------------------------------------------
-usage: onap customer-delete
+usage: oclip vsp-submit
-Delete a customer from Onap
+Submit Vendor Software Product
-Onap service: aai v11
+Product: onap-1.1
+Service: sdc
+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 | --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.
- -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.
- -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::
@@ -5641,56 +3686,60 @@ Error::
-[71] customer-list
+[60] vsp-validate
-----------------------------------------------
-usage: onap customer-list
+usage: oclip vsp-validate
-Lists the registetred customers in Onap
+Validated the uploaded Vendor Software Product
-Onap service: aai v11
+Product: onap-1.1
+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.
+ [-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.
Results::
- name Onap customer name and is of type STRING.
- resource-version Onap customer resource version and is of type
- STRING.
+ status Validation status and is of type STRING.
+ errors Validation messages and is of type JSON.
Error::
@@ -5699,59 +3748,57 @@ Error::
-[72] vf-list
+[61] microservice-show
-----------------------------------------------
-usage: onap vf-list
+usage: oclip microservice-show
-List created VF instances for a service instance
+Details the registered microservice in Onap
-Onap service: aai v11
+Product: onap-1.1
+Service: msb
+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]
- [-a | --no-auth]
+ [-x | --service-name] [-y | --service-version] [-m | --host-url]
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.
- -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-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::
- vf-id VF ID for the given service and is of type STRING.
- vf-name VF name 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::
@@ -5760,62 +3807,70 @@ Error::
-[73] service-list
+[62] microservice-create
-----------------------------------------------
-usage: onap service-list
+usage: oclip microservice-create
-List created service instance
+Register microservice into Onap
-Onap service: aai v11
+Product: onap-1.1
+Service: msb
+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 | --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 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.
- -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-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::
- 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 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::
@@ -5824,62 +3879,55 @@ Error::
-[74] vf-show
+[63] microservice-list
-----------------------------------------------
-usage: onap vf-show
+usage: oclip microservice-list
-Show details for VF
+Lists the registetred micro services in Onap
-Onap service: aai v11
+Product: onap-1.1
+Service: msb
+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]
+ [-m | --host-url]
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.
- -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::
- 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.
+ 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::
@@ -5888,54 +3936,50 @@ Error::
-[75] tenant-create
+[64] microservice-delete
-----------------------------------------------
-usage: onap tenant-create
+usage: oclip microservice-delete
-Create a tenant under given cloud region in Onap
+Deletes the micro service from Onap
-Onap service: aai v11
+Product: onap-1.1
+Service: msb
+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 | --service-name] [-y | --service-version] [-i | --node-ip]
+ [-r | --node-port] [-m | --host-url]
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.
- -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-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::
@@ -5944,59 +3988,54 @@ Error::
-[76] tenant-list
+[65] cloud-create
-----------------------------------------------
-usage: onap tenant-list
+usage: oclip cloud-create
-Lists the tenants under given cloud region in Onap
+Create a cloud region in Onap
-Onap service: aai v11
+Product: onap-1.1
+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]
+ [-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.
- -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::
-
- 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.
+ -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::
@@ -6005,56 +4044,56 @@ Error::
-[77] tenant-delete
+[66] customer-delete
-----------------------------------------------
-usage: onap tenant-delete
+usage: oclip customer-delete
-Delete tenant under given cloud region in Onap
+Delete a customer from Onap
-Onap service: aai v11
+Product: onap-1.1
+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 | --customer-name] [-y | --resource-version] [-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 | --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
+ 59d4a863-597b-4178-a7bb-a20a4a0e80c7.
+ -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::
@@ -6063,57 +4102,59 @@ Error::
-[78] service-type-list
+[67] customer-list
-----------------------------------------------
-usage: onap service-type-list
+usage: oclip customer-list
-List the service types configured in Onap
+Lists the registetred customers in Onap
-Onap service: aai v11
+Product: onap-1.1
+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.
- -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::
- 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.
+ name Onap customer name and is of type STRING.
+ resource-version Onap customer resource version and is of type
+ STRING.
Error::
@@ -6122,163 +4163,62 @@ Error::
-[79] service-type-create
------------------------------------------------
-
-
-usage: onap service-type-create
-
-Add a service type in Onap
-
-Onap service: aai v11
-
-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
- 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.
- -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>
-
-
-
-[80] service-type-delete
+[68] customer-show
-----------------------------------------------
-usage: onap service-type-delete
+usage: oclip customer-show
-Delete a service type from Onap
+Lists the registetred customers in Onap
-Onap service: aai v11
+Product: onap-1.1
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
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,
- 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>
-
-
-
-[81] cloud-create
------------------------------------------------
-
-
-usage: onap cloud-create
-
-Create a cloud region in Onap
-
-Onap service: aai v11
-
-Options::
+ [-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::
+
+ -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.
+ -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 | --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]
-where::
+Results::
- -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.
- -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 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::
@@ -6287,64 +4227,66 @@ Error::
-[82] service-delete
+[69] ems-register
-----------------------------------------------
-usage: onap service-delete
+usage: oclip ems-register
-Delete service instance (experimental)
+Register a EMS in Onap
-Onap service: so v3
+Product: onap-1.1
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
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]
+ [-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::
- -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.
+ -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.
+ -z | --ems-id Onap EMS unique id. It is of type UUID. By
+ default, it is
+ bbbc1409-9976-4af1-8ba6-f5e5c58d63d4.
+ -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.
Error::
@@ -6353,59 +4295,57 @@ Error::
-[83] vfmodule-delete
+[70] ems-unregister
-----------------------------------------------
-usage: onap vfmodule-delete
+usage: oclip ems-unregister
-delete a VF module (experimental)
+Un-register a EMS in Onap
-Onap service: so v3
+Product: onap-1.1
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
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]
+ [-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 | --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.
+ -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 | --ems-id Onap EMS unique id. It is of type UUID. By
+ default, it is
+ c7efff7f-fe14-4f4c-8489-814d98e33146.
+ -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.
Error::
@@ -6414,81 +4354,58 @@ Error::
-[84] vfmodule-create
+[71] ems-list
-----------------------------------------------
-usage: onap vfmodule-create
+usage: oclip ems-list
-Create a VF module
+List the configured ems
-Onap service: so v3
+Product: onap-1.1
+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]
+ [-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 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.
+ -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::
- vfmodule-id id for the created vnf 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::
@@ -6497,73 +4414,65 @@ Error::
-[85] service-create
+[72] ems-show
-----------------------------------------------
-usage: onap service-create
+usage: oclip ems-show
-Create a service instance using MSO
+Show the details of configured ems
-Onap service: so v3
+Product: onap-1.1
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
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]
-
-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.
+ [-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::
+
+ -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 | --ems-id Onap EMS unique id. It is of type UUID. By
+ default, it is
+ 9d7d75dd-9fff-4554-b4d6-38a96e3ae10d.
+ -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 for the created service. and is of
- type STRING.
+ 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::
@@ -6572,64 +4481,72 @@ Error::
-[86] vf-delete
+[73] sdnc-register
-----------------------------------------------
-usage: onap vf-delete (experimental)
+usage: oclip sdnc-register
-delete a VF
+Register a SDNC in Onap
-Onap service: so v3
+Product: onap-1.1
+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 | --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 | --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 | --location Onap VIM unique id. It is of type UUID. By
+ default, it is
+ 63c3e73b-f265-4d4c-bf0d-c6ee520cd723.
+ -y | --sdnc-id Onap SDNC unique id. It is of type UUID. By
+ default, it is
+ 139b5e04-0ce0-4547-95a0-5bd4f5194554.
+ -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.
Error::
@@ -6638,74 +4555,53 @@ Error::
-[87] vf-create
+[74] sdnc-unregister
-----------------------------------------------
-usage: onap vf-create
+usage: oclip sdnc-unregister
-Create a VF
+Un-register a VNFM in Onap
-Onap service: so v3
+Product: onap-1.1
+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 | --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.
- -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 | --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::
@@ -6714,63 +4610,58 @@ Error::
-onap-1.0
-==========================
-
-
-[1] license-group-create
+[75] sdnc-list
-----------------------------------------------
-usage: onap license-group-create
+usage: oclip sdnc-list
-Create License Group
+List the configured sdnc
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
+ [-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.
+ -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.
+ sdnc-id Onap sdnc id and is of type STRING.
+ resource-version Onap sdnc resource version and is of type STRING.
Error::
@@ -6779,59 +4670,74 @@ Error::
-[2] ep-show
+[76] vim-register
-----------------------------------------------
-usage: onap ep-show
+usage: oclip vim-register
-Details of the Entitlement Pool
+Register a VIM under a given cloud region in Onap
-Onap service: sdc v1.0
+Product: onap-1.1
+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 | --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 | --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.
- -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 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.
+ -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
+ f354c48b-35cc-425d-a15d-5ddeb081a58b.
+ -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::
@@ -6840,57 +4746,60 @@ Error::
-[3] license-model-create
+[77] vim-unregister
-----------------------------------------------
-usage: onap license-model-create
+usage: oclip vim-unregister
-Create License Model
+Un-register a VIM under from cloud region in Onap
-Onap service: sdc v1.0
+Product: onap-1.1
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
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]
+ [-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::
- -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.
+ -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
+ 760954af-c9ef-4f95-a9fd-c2c93b22be4f.
+ -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::
@@ -6899,59 +4808,68 @@ Error::
-[4] license-group-show
+[78] vim-list
-----------------------------------------------
-usage: onap license-group-show
+usage: oclip vim-list
-Details of the License Group
+List the configured vims
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
-
-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.
- -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] [-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::
+
+ -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::
- 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.
+ 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::
@@ -6960,51 +4878,70 @@ Error::
-[5] vsp-upload
+[79] vnfm-register
-----------------------------------------------
-usage: onap vsp-upload
+usage: oclip vnfm-register
-Upload the CSAR file to VSP
+Register a VNFM in Onap
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
+ [-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 | --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.
- -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 | --vim-id Onap VIM unique id. It is of type UUID. By
+ default, it is
+ dbd6b3cb-9237-4e78-bfd2-248d65c6d292.
+ -y | --vnfm-id Onap VNFM unique id. It is of type UUID. By
+ default, it is
+ fa29b9bb-8a41-4d31-97f9-4b451cf5b1a7.
+ -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.
Error::
@@ -7013,72 +4950,57 @@ Error::
-[6] vsp-create
+[80] vnfm-unregister
-----------------------------------------------
-usage: onap vsp-create
+usage: oclip vnfm-unregister
-Create Vendor Software Product
+Un-register a VNFM in Onap
-Onap service: sdc v1.0
+Product: onap-1.1
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
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]
+ [-x | --vnfm-id] [-y | --resource-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.
- -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.
+ -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 | --vnfm-id Onap VNFM unique id. It is of type UUID. By
+ default, it is
+ f58ee38c-d31e-4d81-8c1a-e005441da404.
+ -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.
Error::
@@ -7087,55 +5009,60 @@ Error::
-[7] vsp-list
+[81] vnfm-list
-----------------------------------------------
-usage: onap vsp-list
+usage: oclip vnfm-list
-List of the Vendor Software Products
+List the configured vnfm
-Onap service: sdc v1.0
+Product: onap-1.1
+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.
- -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.
+ 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::
@@ -7144,57 +5071,65 @@ Error::
-[8] vsp-show
+[82] vnfm-show
-----------------------------------------------
-usage: onap vsp-show
+usage: oclip vnfm-show
-Details of the Vendor Software Product
+Show the VNFM in Onap
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
-
-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.
- -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] [-v | --version] [-d | --debug]
+ [-f | --format] [-s | --long] [-t | --no-title]
+ [-x | --vnfm-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 | --vnfm-id Onap VNFM unique id. It is of type UUID. By
+ default, it is
+ 1002d62e-623f-4743-97ef-d5853ce76369.
+ -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.
+ 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::
@@ -7203,102 +5138,65 @@ Error::
-[9] vsp-submit
+[83] service-list
-----------------------------------------------
-usage: onap vsp-submit
+usage: oclip service-list
-Submit Vendor Software Product
+List created service instance
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
-
-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.
- -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>
-
-
-
-[10] vsp-checkin
------------------------------------------------
-
-
-usage: onap vsp-checkin
-
-Checkin Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
+ [-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::
+
+ -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 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.
- [-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]
-where::
+Results::
- -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.
- -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 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::
@@ -7307,59 +5205,62 @@ Error::
-[11] license-model-show
+[84] vf-list
-----------------------------------------------
-usage: onap license-model-show
+usage: oclip vf-list
-Details of the License Model
+List created VF instances for a service instance
-Onap service: sdc v1.0
+Product: onap-1.1
+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 | --customer-name] [-y | --service-type] [-z | --service-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.
- -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 | --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::
- 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.
+ vf-id VF ID for the given service and is of type STRING.
+ vf-name VF name and is of type STRING.
Error::
@@ -7368,97 +5269,65 @@ Error::
-[12] ep-create
+[85] vf-show
-----------------------------------------------
-usage: onap ep-create
+usage: oclip vf-show
-Create Entitlement Pool
+Show details for VF
-Onap service: sdc v1.0
+Product: onap-1.1
+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]
-
-where::
-
-<<<<<<< ece4fcf67742a307d5d68fbde1723f3e0485b7fb
- -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.
-=======
- -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.
+ [-x | --vf-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 | --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::
- ID License Group ID and is of type STRING.
+ 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::
@@ -7467,109 +5336,56 @@ Error::
-[10] license-group-show
+[86] service-type-create
-----------------------------------------------
-usage: onap license-group-show
+usage: oclip service-type-create
-Details of the License Group
+Add a service type in Onap
-Onap service: sdc v1.0
+Product: onap-1.1
+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 | --service-type] [-y | --service-type-id] [-u | --host-username]
+ [-p | --host-password] [-m | --host-url] [-a | --no-auth]
where::
-<<<<<<< 476f5637ae4e816f7abf3536c5eeb156e0af6bed
- -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.
- -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.
-=======
- -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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
->>>>>>> Normalize all env with OPEN_CLI
->>>>>>> Normalize all env with OPEN_CLI
-
-
-Results::
-
-<<<<<<< ece4fcf67742a307d5d68fbde1723f3e0485b7fb
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
- ID Entitlement Pool ID and is of type STRING.
-=======
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
- ID License Model ID and is of type STRING.
-=======
- -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
- OPEN_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_PASSWORD. Secured.
-=======
-<<<<<<< 476f5637ae4e816f7abf3536c5eeb156e0af6bed
- 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.
-=======
- 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.
+ -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 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
+ 8e6d03fb-dc7c-4317-ad80-a1363549ffe9.
+ -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::
@@ -7578,57 +5394,58 @@ Error::
-vsp-submit
+[87] service-type-delete
-----------------------------------------------
-usage: onap vsp-submit
+usage: oclip service-type-delete
-Submit Vendor Software Product
+Delete a service type from Onap
-Onap service: sdc v1.0
+Product: onap-1.1
+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 | --service-type-id] [-y | --resource-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.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
->>>>>>> Normalize all env with OPEN_CLI
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
-<<<<<<< ece4fcf67742a307d5d68fbde1723f3e0485b7fb
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
-=======
->>>>>>> Normalize all env with OPEN_CLI
->>>>>>> Normalize all env with OPEN_CLI
+ -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
+ 02e18702-115e-43e3-b706-469587592bb1.
+ -y | --resource-version Onap service resource version. It is of type
+ UUID. It is optional. By default, it is
+ 013ea149-79d7-407e-a0c0-809bc3782776.
+ -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::
@@ -7637,62 +5454,63 @@ Error::
-[13] subscription-list
+[88] cloud-list
-----------------------------------------------
-usage: onap subscription-list
+usage: oclip cloud-list
-Lists the subscription for a given customer in Onap
+List the configured clouds and Onap service subscriptions
-Onap service: aai v8
+Product: onap-1.1
+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
-<<<<<<< ece4fcf67742a307d5d68fbde1723f3e0485b7fb
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
-=======
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
->>>>>>> Normalize all env with OPEN_CLI
- -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::
- service-type Onap service type 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::
@@ -7701,62 +5519,58 @@ Error::
-[14] subscription-create
+[89] cloud-delete
-----------------------------------------------
-usage: onap subscription-create
+usage: oclip cloud-delete
-Create a subscription for a customer in Onap
+Delete a cloud region from Onap
-Onap service: aai v8
+Product: onap-1.1
+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 | --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 | --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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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 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
+ 83c5185a-2a1e-4943-a52a-257af9046e7f.
+ -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::
@@ -7765,59 +5579,54 @@ Error::
-[15] customer-show
+[90] customer-create
-----------------------------------------------
-usage: onap customer-show
+usage: oclip customer-create
-Lists the registetred customers in Onap
+Create a customer in Onap
-Onap service: aai v8
+Product: onap-1.1
+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 | --subscriber-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.
- -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 | --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::
@@ -7826,56 +5635,60 @@ Error::
-[16] customer-list
+[91] service-type-list
-----------------------------------------------
-usage: onap customer-list
+usage: oclip service-type-list
-Lists the registetred customers in Onap
+List the service types configured in Onap
-Onap service: aai v8
+Product: onap-1.1
+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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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::
- name Onap customer name and is of type STRING.
- resource-version Onap customer resource version 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::
@@ -7884,53 +5697,58 @@ Error::
-[17] customer-delete
+[92] subscription-create
-----------------------------------------------
-usage: onap customer-delete
+usage: oclip subscription-create
-Delete a customer from Onap
+Create a subscription of a customer for given service in specific cloud region in Onap
-Onap service: aai v8
+Product: onap-1.1
+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 | --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 | --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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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 | --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.
Error::
@@ -7939,51 +5757,57 @@ Error::
-[18] customer-create
+[93] subscription-delete
-----------------------------------------------
-usage: onap customer-create
+usage: oclip subscription-delete
-Create a customer in Onap
+Delete the subscription for a given customer in Onap
-Onap service: aai v8
+Product: onap-1.1
+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 | --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.
- -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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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 | --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::
@@ -7992,59 +5816,63 @@ Error::
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
-[19] service-type-create
-=======
-[16] customer-list
+[94] 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-1.1
+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]
-
-where::
-
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
+ [-x | --customer-name] [-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 | --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
- STRING.
+ 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::
@@ -8053,57 +5881,57 @@ Error::
-[17] customer-show
+[95] tenant-create
-----------------------------------------------
-usage: onap customer-show
+usage: oclip tenant-create
-Lists the registetred customers in Onap
+Create a tenant under given cloud region in Onap
-Onap service: aai v8
+Product: onap-1.1
+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 | --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.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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::
-
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
-=======
- service-type Onap service 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 | --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::
@@ -8112,59 +5940,59 @@ Error::
-customer-list
+[96] tenant-delete
-----------------------------------------------
-usage: onap customer-list
+usage: oclip tenant-delete
-Lists the registetred customers in Onap
+Delete tenant under given cloud region in Onap
-Onap service: aai v8
+Product: onap-1.1
+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] [-z | --tenant-id]
+ [-r | --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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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::
-
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
- 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 | --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
+ a6b44884-7d33-4309-b14a-63711a6b3e36.
+ -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::
@@ -8173,62 +6001,62 @@ Error::
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
-[18] service-type-create
-=======
-cloud-list
+[97] tenant-list
-----------------------------------------------
-usage: onap cloud-list
+usage: oclip tenant-list
-List the configured clouds and Onap service subscriptions
+Lists the tenants under given cloud region in Onap
-Onap service: aai v8
+Product: onap-1.1
+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]
-
-where::
-
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
+ [-x | --cloud] [-y | --region] [-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 | --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::
- 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.
+ 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::
@@ -8237,55 +6065,47 @@ Error::
-service-type-create
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+open-cli
+==========================
+
+
+[1] basic-logout
-----------------------------------------------
-usage: onap service-type-create
+usage: oclip basic-logout
-Add a service type in Onap
+basic logout auth command
-Onap service: aai v8
+Product: open-cli
+Service: basic-auth
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
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]
+ [-m | --host-url]
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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
Error::
@@ -8294,55 +6114,54 @@ Error::
-[20] service-type-delete
+[2] catalog
-----------------------------------------------
-usage: onap service-type-delete
+usage: oclip catalog
-Delete a service type from Onap
+cli catalog command to find the base path for service.
-Onap service: aai v8
+Product: open-cli
+Service: catalog
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
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]
+ [-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::
+
+ -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.
-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,
- it is read from environment variable
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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::
+
+ 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::
@@ -8351,57 +6170,49 @@ Error::
-[21] service-type-list
+[3] schema-refresh
-----------------------------------------------
-usage: onap service-type-list
+usage: oclip schema-refresh
-List the service types configured in Onap
+Oclip command to refresh schemas stored in open-cli-schema folders.
-Onap service: aai v8
+Product: open-cli
+Service: schema
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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.
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.
+ 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::
@@ -8410,65 +6221,51 @@ Error::
-<<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7
-[22] cloud-list
-=======
-[21] subscription-create
+[4] schema-validate
-----------------------------------------------
-usage: onap subscription-create
+usage: oclip schema-validate
-Create a subscription for a customer in Onap
+Oclip command to validate schema
-Onap service: aai v8
+Product: open-cli
+Service: schema
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
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]
+ [-l | --schema-location] [-i | --internal-schema] [-b | --ocs-version]
+
+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.
+ -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.
-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
- OPEN_CLI_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable OPEN_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::
+
+ sl-no Serial Number of error and is of type STRING.
+ error Schema validation error and is of type STRING.
Error::
@@ -8477,61 +6274,57 @@ Error::
-<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
-[22] subscription-list
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+[5] basic-login
-----------------------------------------------
-usage: onap cloud-list
+usage: oclip basic-login
-List the configured clouds and Onap service subscriptions
+basic login auth command
-Onap service: aai v8
+Product: open-cli
+Service: basic-auth
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
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.
- -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::
- 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.
+ Authorization Authorization and is of type STRING.
Error::
@@ -8540,54 +6333,56 @@ Error::
-cli-1.0
-=======
-open-cli
->>>>>>> Migrate docs to use OPEN_ instead of ONAP_
+sample-1.0
==========================
-[1] schema-validate
+[1] hello-world-http
-----------------------------------------------
-usage: onap schema-validate
+usage: oclip hello-world-http
-Onap command to validate schema
+First cmd hello world using http runing under
+lighttpd in cli at http://<cli-ip>:8080/version.json
-Onap service: onap-cli 1.0.0
-Options::
+Product: sample-1.0
+Service: hello-world
+Author: ONAP CLI Team onap-discuss@lists.onap.org
- [-l | --schema-location] [-i | --internal-schema] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title]
-
-where::
+Options::
- -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.
- -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] [-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::
@@ -8596,51 +6391,50 @@ 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-1.0
+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.
- -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.
+ -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::
On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-=======
-TBD
->>>>>>> Pls verify the usage
+