diff options
| author |   Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com> | 2017-11-14 15:00:50 +0530 |
|---|---|---|
| committer | Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com> | 2017-11-21 18:07:53 +0530 |
| commit | 0cb830f903d622674770684f8ea633c405bb7d6b (patch) | |
| tree | 013ad264fe338ffc39ece4ca5ff5dc93332be9b6 /docs/cmd_help.rst | |
| parent | 9a7c3f58efc9a4fcff5052700457cf6f7565cf39 (diff) | |
Reset the docs to match 1.1.0
Issue-Id: CLI-66
Change-Id: Ida7397eb0a422fa3cf6666add39083ec423e4694
Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Diffstat (limited to 'docs/cmd_help.rst')
| -rw-r--r-- | docs/cmd_help.rst | 8562 |
1 files changed, 4352 insertions, 4210 deletions
diff --git a/docs/cmd_help.rst b/docs/cmd_help.rst index 87639d8d..1f84c4fb 100644 --- a/docs/cmd_help.rst +++ b/docs/cmd_help.rst @@ -13,54 +13,47 @@ onap-1.1 ========================== -[1] catalog +[1] microservice-delete ----------------------------------------------- -usage: oclip catalog +usage: onap microservice-delete -ONAP catalog command to find the base path for service. +Deletes the micro service from Onap -Product: onap-1.1 -Service: msb -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: msb v1 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-l | --catalog-service-name] [-i | --catalog-service-version] [-m | --host-url] + [-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:: - -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:: - - 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. + -x | --service-name Onap service name. It is of type STRING. + -y | --service-version Onap service version. It is of type STRING. + -i | --node-ip Onap service running node IP. It is of type + STRING. + -r | --node-port Onap service running node port. It is of type + STRING. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. Error:: @@ -69,43 +62,52 @@ Error:: -[2] basic-logout +[2] microservice-list ----------------------------------------------- -usage: oclip basic-logout +usage: onap microservice-list -ONAP basic logout auth command +Lists the registetred micro services in Onap -Product: onap-1.1 -Service: basic-auth -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: msb v1 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-m | --host-url] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] 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. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. + -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. + + +Results:: + + name Onap service name and is of type STRING. + version Onap service version and is of type STRING. + url Onap service base url and is of type URL. + status Onap service status and is of type DIGIT. + nodes Onap service running nodes and is of type JSON. + enable-ssl Onap service is enabled with https or not and is + of type STRING. + path Onap service path and is of type STRING. Error:: @@ -114,60 +116,54 @@ Error:: -[3] sdc-basic-login +[3] microservice-show ----------------------------------------------- -usage: oclip sdc-basic-login +usage: onap microservice-show -ONAP basic login auth command +Details the registered microservice in Onap -Product: onap-1.1 -Service: sdc-basic-auth -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: msb v1 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:: - -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. + -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. Results:: - Authorization Authorization and is of type STRING. - X-TransactionId X-TransactionId and is of type STRING. - X-FromAppId X-FromAppId and is of type STRING. - USER_ID USER_ID for sdc and is of type STRING. + 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:: @@ -176,59 +172,67 @@ Error:: -[4] basic-login +[4] microservice-create ----------------------------------------------- -usage: oclip basic-login +usage: onap microservice-create -ONAP basic login auth command +Register microservice into Onap -Product: onap-1.1 -Service: basic-auth -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: msb v1 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] - [-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. - -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 | --service-name Onap service name. It is of type STRING. + -y | --service-version Onap service version. It is of type STRING. + -r | --service-url Onap service base url. It is of type URL. + -b | --enable-ssl Onap service is enabled with https or not. It is + of type STRING. It is optional. + -c | --path Onap service path. It is of type STRING. It is + optional. + node-ip Onap service running node IP. It is of type + STRING. + node-port Onap service running node port. It is of type + STRING. + create-or-update Onap service create or update. It is of type + BOOL. By default, it is false. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. 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:: - 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. + 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:: @@ -237,76 +241,51 @@ Error:: -[5] service-create +[5] vlm-checkin ----------------------------------------------- -usage: oclip service-create +usage: onap vlm-checkin -Create a service instance using MSO +Checkin Vendor License Model -Product: onap-1.1 -Service: so -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-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] + [-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:: - -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:: - - service-id instance id for the created service. and is of - type STRING. + -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:: @@ -315,67 +294,62 @@ Error:: -[6] service-delete +[6] vlm-key-group-create ----------------------------------------------- -usage: oclip service-delete +usage: onap vlm-key-group-create -Delete service instance (experimental) +Create License Key Group -Product: onap-1.1 -Service: so -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-c | --vlm-id] [-e | --vlm-version] [-x | --name] + [-y | --type] [-z | --description] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] where:: - -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. + -c | --vlm-id License Model Id. It is of type STRING. + -e | --vlm-version License Model version. It is of type STRING. + -x | --name name. It is of type STRING. + -y | --type type of group (Universal, unique, one-time). It + is of type STRING. By default, it is Universal. + -z | --description Description for License Key Group. It is of type + STRING. It is optional. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + ID License Model ID and is of type STRING. Error:: @@ -384,65 +358,57 @@ Error:: -[7] vf-module-create +[7] vlm-aggreement-list ----------------------------------------------- -usage: oclip vf-module-create +usage: onap vlm-aggreement-list -Create a VF Module +List license aggreement -Product: onap-1.1 -Service: so -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. + + +Results:: + + ID aggreement ID and is of type STRING. + name aggreement name and is of type STRING. Error:: @@ -451,62 +417,57 @@ Error:: -[8] vfmodule-delete +[8] vlm-key-group-list ----------------------------------------------- -usage: oclip vfmodule-delete +usage: onap vlm-key-group-list -delete a VF module (experimental) +key group list in a license model -Product: onap-1.1 -Service: so -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. + + +Results:: + + ID Feature group ID and is of type STRING. + name Feature group name and is of type STRING. Error:: @@ -515,84 +476,57 @@ Error:: -[9] vfmodule-create +[9] vlm-create ----------------------------------------------- -usage: oclip vfmodule-create +usage: onap vlm-create -Create a VF module +Create License Model -Product: onap-1.1 -Service: so -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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] 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 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. + -x | --vendor-name vendor name. It is of type STRING. + -y | --description Description for License Model. It is of type + STRING. It is optional. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. Results:: - vfmodule-id id for the created vnf and is of type STRING. + ID License Model ID and is of type UUID. Error:: @@ -601,77 +535,64 @@ Error:: -[10] vf-create +[10] vlm-entitlement-pool-create ----------------------------------------------- -usage: oclip vf-create +usage: onap vlm-entitlement-pool-create -Create a VF +Create Entitlement Pool -Product: onap-1.1 -Service: so -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 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] - [-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] + [-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. + -x | --name Entitlement Pool name. It is of type STRING. + -y | --vlm-id License Model ID. It is of type STRING. + -e | --vlm-version License Model version. It is of type STRING. + -z | --description Description for Entitlement Pool. It is of type + STRING. + -g | --operational-scope Operational Scope. It is of type STRING. By + default, it is Availability_Zone. + -k | --manufacture-reference-number Manufature Reference Number. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. Results:: - vf-id id for the created vnf and is of type STRING. + ID Entitlement Pool ID and is of type STRING. Error:: @@ -680,67 +601,51 @@ Error:: -[11] vf-delete +[11] vsp-package ----------------------------------------------- -usage: oclip vf-delete +usage: onap vsp-package -delete a VF (experimental) +Package Vendor Software Product -Product: onap-1.1 -Service: so -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. Error:: @@ -749,62 +654,51 @@ Error:: -[12] service-model-add-vf +[12] vsp-submit ----------------------------------------------- -usage: oclip service-model-add-vf +usage: onap vsp-submit -Helps to add VF into service models in SDC +Submit Vendor Software Product -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --service-model-id] [-y | --vf-id] [-z | --vf-name] - [-b | --vf-version] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-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:: - -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 Service ID and is of type STRING. + -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. Error:: @@ -813,54 +707,51 @@ Error:: -[13] service-model-certify-start +[13] vsp-checkout ----------------------------------------------- -usage: oclip service-model-certify-start +usage: onap vsp-checkout -Starts the certification of Service model in SDC +Checkout Vendor Software Product -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. Error:: @@ -869,54 +760,63 @@ Error:: -[14] service-model-checkin +[14] vsp-show ----------------------------------------------- -usage: oclip service-model-checkin +usage: onap vsp-show -Checkin Service model in SDC +Details of the Vendor Software Product -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -x | --vsp-id Onap VSP ID. It is of type STRING. + -y | --vsp-version Onap VSP version. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +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. Error:: @@ -925,54 +825,72 @@ Error:: -[15] service-model-revert +[15] vsp-create ----------------------------------------------- -usage: oclip service-model-revert +usage: onap vsp-create -Checkout Service model in SDC +Create Vendor Software Product -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 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] - [-b | --service-model-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-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. - -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. + -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. + + +Results:: + + ID VSP ID and is of type STRING. Error:: @@ -981,71 +899,53 @@ Error:: -[16] service-model-create +[16] vsp-add-artifact ----------------------------------------------- -usage: oclip service-model-create +usage: onap vsp-add-artifact -Create Service model in SDC +Upload the CSAR file to VSP -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 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] - [-x | --name] [-y | --description] [-z | --project-code] - [-b | --category] [-c | --category-display-name] [-e | --icon-id] - [-u | --host-username] [-p | --host-password] [-m | --host-url] [-a | --no-auth] where:: - -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:: - - ID Service ID and is of type STRING. + -x | --vsp-id Onap VSP ID. It is of type STRING. + -y | --vsp-version Onap VSP version. It is of type STRING. + -z | --vsp-file CSAR File path. It is of type BINARY. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. Error:: @@ -1054,54 +954,51 @@ Error:: -[17] service-model-distribute +[17] vsp-revert ----------------------------------------------- -usage: oclip service-model-distribute +usage: onap vsp-revert -Distributes the Service model in SDC +Revert Vendor Software Product -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. Error:: @@ -1110,63 +1007,51 @@ Error:: -[18] service-model-list +[18] vsp-checkout ----------------------------------------------- -usage: oclip service-model-list +usage: onap vsp-checkout -List the service model in SDC +Checkout Vendor Software Product -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. Error:: @@ -1175,54 +1060,57 @@ Error:: -[19] service-model-checkout +[19] vsp-validate ----------------------------------------------- -usage: oclip service-model-checkout +usage: onap vsp-validate -Checkout Service model in SDC +Validated the uploaded Vendor Software Product -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. + + +Results:: + + status Validation status and is of type STRING. + errors Validation messages and is of type JSON. Error:: @@ -1231,61 +1119,60 @@ Error:: -[20] service2vf-model-list +[20] vsp-list ----------------------------------------------- -usage: oclip service2vf-model-list +usage: onap vsp-list -List the VF in a given service model in SDC +List of the Vendor Software Products -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-h | --help] [-v | --version] [-d | --debug] [-f | --format] [-s | --long] [-t | --no-title] - [-z | --service-model-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-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. + -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-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. + 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:: @@ -1294,53 +1181,51 @@ Error:: -[21] vf-model-certify-complete +[21] vsp-checkin ----------------------------------------------- -usage: oclip vf-model-certify-complete +usage: onap vsp-checkin -Complete certifying Virtual function +Checkin Vendor Software Product -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. Error:: @@ -1349,53 +1234,51 @@ Error:: -[22] vf-model-certify-request +[22] service-model-checkin ----------------------------------------------- -usage: oclip vf-model-certify-request +usage: onap service-model-checkin -Request for certifying Virtual function +Checkin Service model in SDC -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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:: @@ -1404,53 +1287,51 @@ Error:: -[23] vf-model-certify-start +[23] service-model-distribute ----------------------------------------------- -usage: oclip vf-model-certify-start +usage: onap service-model-distribute -Start certifying Virtual function +Distributes the Service model in SDC -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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:: @@ -1459,53 +1340,60 @@ Error:: -[24] vf-model-checkin +[24] service-model-list ----------------------------------------------- -usage: oclip vf-model-checkin +usage: onap service-model-list -Checkin Virtual function +List the service model in SDC -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-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] + [-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. - -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. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + uuid UUID and is of type STRING. + invariant-uuid Invariant UUID and is of type STRING. + name Name and is of type STRING. + version version and is of type STRING. + status status and is of type STRING. + distribution-status status and is of type STRING. + description description and is of type STRING. Error:: @@ -1514,64 +1402,51 @@ Error:: -[25] vf-model-create +[25] service-model-certify-start ----------------------------------------------- -usage: oclip vf-model-create +usage: onap service-model-certify-start -Create Virtual function from Vendor Software Product +Starts the certification of Service model in SDC -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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:: - - ID VF ID and is of type STRING. + -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:: @@ -1580,65 +1455,59 @@ Error:: -[26] vf-model-list +[26] service-model-add-vf ----------------------------------------------- -usage: oclip vf-model-list +usage: onap service-model-add-vf -List the VF resource model in SDC +Helps to add VF into service models in SDC -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -x | --service-model-id Onap Service Name. It is of type STRING. + -y | --vf-id VF ID. It is of type STRING. It is optional. + -z | --vf-name VF ID. It is of type STRING. It is optional. + -b | --vf-version VF version. It is of type STRING. It is optional. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. 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. + ID Service ID and is of type STRING. Error:: @@ -1647,63 +1516,104 @@ Error:: -[27] vf2vfmodule-model-list +[27] service-model-certify-request ----------------------------------------------- -usage: oclip vf2vfmodule-model-list +usage: onap service-model-certify-request -List the VF modules in a given VF model in SDC +Request the certification of Service model in SDC -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. -Results:: +Error:: + + On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - 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. + + +[28] service-model-revert +----------------------------------------------- + + +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:: + + -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:: @@ -1712,70 +1622,104 @@ Error:: -[28] ep-create +[29] service-model-checkout ----------------------------------------------- -usage: oclip ep-create +usage: onap service-model-checkout -Create Entitlement Pool +Checkout Service model in SDC -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. -Results:: +Error:: - ID Entitlement Pool ID and is of type STRING. + 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. Error:: @@ -1784,62 +1728,58 @@ Error:: -[29] ep-show +[31] service2vf-model-list ----------------------------------------------- -usage: oclip ep-show +usage: onap service2vf-model-list -Details of the Entitlement Pool +List the VF in a given service model in SDC -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. 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. + 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:: @@ -1848,62 +1788,68 @@ Error:: -[30] license-group-create +[32] service-model-create ----------------------------------------------- -usage: oclip license-group-create +usage: onap service-model-create -Create License Group +Create Service model in SDC -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 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:: - -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. + -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. Results:: - ID License Group ID and is of type STRING. + ID Service ID and is of type STRING. Error:: @@ -1912,62 +1858,51 @@ Error:: -[31] license-group-show +[33] service-model-approve ----------------------------------------------- -usage: oclip license-group-show +usage: onap service-model-approve -Details of the License Group +Approves the Service model in SDC -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --license-model-id] [-y | --license-group-id] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --license-model-id Onap License Model ID. It is of type STRING. - -y | --license-group-id Onap License Group ID. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - name License Group Name and is of type STRING. - ID License Group ID and is of type STRING. - description Description for the License Group and is of type - STRING. + -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:: @@ -1976,60 +1911,61 @@ Error:: -[32] license-model-create +[34] vf-model-create ----------------------------------------------- -usage: oclip license-model-create +usage: onap vf-model-create -Create License Model +Create Virtual function from Vendor Software Product -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vendor-name] [-y | --license-model-description] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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:: - -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. + -x | --name Onap VF Name. It is of type STRING. + -y | --description Description for VF. It is of type STRING. It is + optional. + -z | --vendor-name Vendor name. It is of type STRING. It is optional. + -b | --vsp-id VSP ID. It is of type STRING. It is optional. + -g | --vsp-version VSP version. It is of type STRING. It is optional. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. 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. + ID VF ID and is of type STRING. Error:: @@ -2038,62 +1974,50 @@ Error:: -[33] license-model-show +[35] vf-model-checkin ----------------------------------------------- -usage: oclip license-model-show +usage: onap vf-model-checkin -Details of the License Model +Checkin Virtual function -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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:: - - 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. + -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. Error:: @@ -2102,63 +2026,51 @@ Error:: -[34] vlm-aggreement-create +[36] vlm-revert ----------------------------------------------- -usage: oclip vlm-aggreement-create +usage: onap vlm-revert -Create license aggreement +Revert Vendor License Model -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 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 | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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:: - -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 aggreement ID and is of type STRING. + -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:: @@ -2167,60 +2079,65 @@ Error:: -[35] vlm-aggreement-list +[37] vlm-feature-group-create ----------------------------------------------- -usage: oclip vlm-aggreement-list +usage: onap vlm-feature-group-create -List license aggreement +Create feature group Pool -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -x | --name Feature group name. It is of type STRING. + -y | --vlm-id License Model ID. It is of type STRING. + -e | --vlm-version License Model version. It is of type STRING. + -z | --description Description for feature group. It is of type + STRING. + -g | --vlm-key-group-id VLM keygroup. It is of type STRING. + -b | --vlm-entitle-pool-id VLM Entitlement pool. It is of type STRING. + -c | --part-number Part number. It is of type STRING. + -k | --manufacture-reference-number Manufature Reference Number. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. Results:: - ID aggreement ID and is of type STRING. - name aggreement name and is of type STRING. + ID Feature group ID and is of type STRING. Error:: @@ -2229,54 +2146,51 @@ Error:: -[36] vlm-checkin +[38] vlm-submit ----------------------------------------------- -usage: oclip vlm-checkin +usage: onap vlm-submit -Checkin Vendor License Model +Submit Vendor License Model -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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:: @@ -2285,54 +2199,50 @@ Error:: -[37] vlm-checkout +[39] vf-model-certify-start ----------------------------------------------- -usage: oclip vlm-checkout +usage: onap vf-model-certify-start -Checkout Vendor License Model +Start certifying Virtual function -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. Error:: @@ -2341,60 +2251,62 @@ Error:: -[38] vlm-create +[40] vf-model-list ----------------------------------------------- -usage: oclip vlm-create +usage: onap vf-model-list -Create License Model +List the VF resource model in SDC -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-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] + [-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. + -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 UUID. + 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:: @@ -2403,67 +2315,57 @@ Error:: -[39] vlm-entitlement-pool-create +[41] vlm-entitlement-pool-list ----------------------------------------------- -usage: oclip vlm-entitlement-pool-create +usage: onap vlm-entitlement-pool-list -Create Entitlement Pool +entitlement pool list in a license model -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 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 | --operational-scope] [-k | --manufacture-reference-number] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-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:: - -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. + -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. Results:: - ID Entitlement Pool ID and is of type STRING. + ID Feature group ID and is of type STRING. + name Feature group name and is of type STRING. Error:: @@ -2472,60 +2374,57 @@ Error:: -[40] vlm-entitlement-pool-list +[42] vlm-feature-group-list ----------------------------------------------- -usage: oclip vlm-entitlement-pool-list +usage: onap vlm-feature-group-list -entitlement pool list in a license model +Feature group list in a license model -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. Results:: - ID Feature group ID and is of type STRING. - name Feature group name and is of type STRING. + ID Feature group ID and is of type STRING. + name Feature group name and is of type STRING. Error:: @@ -2534,68 +2433,111 @@ Error:: -[41] vlm-feature-group-create +[43] vlm-checkout ----------------------------------------------- -usage: oclip vlm-feature-group-create +usage: onap vlm-checkout + +Checkout 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 + 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 +----------------------------------------------- -Create feature group Pool -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +usage: onap vlm-list + +List License Model + +Onap service: sdc v1.0 Options:: + [-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 | --vlm-id] [-e | --vlm-version] - [-z | --description] [-g | --vlm-key-group-id] [-b | --vlm-entitle-pool-id] - [-c | --part-number] [-k | --manufacture-reference-number] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. Results:: - ID Feature group ID and is of type STRING. + 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:: @@ -2604,60 +2546,60 @@ Error:: -[42] vlm-feature-group-list +[45] vlm-aggreement-create ----------------------------------------------- -usage: oclip vlm-feature-group-list +usage: onap vlm-aggreement-create -Feature group list in a license model +Create license aggreement -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. Results:: - ID Feature group ID and is of type STRING. - name Feature group name and is of type STRING. + ID aggreement ID and is of type STRING. Error:: @@ -2666,54 +2608,50 @@ Error:: -[43] service-model-certify-complete +[46] vf-model-certify-request ----------------------------------------------- -usage: oclip service-model-certify-complete +usage: onap vf-model-certify-request -Completes the certification of Service model in SDC +Request for certifying Virtual function -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. Error:: @@ -2722,65 +2660,60 @@ Error:: -[44] vlm-key-group-create +[47] vf2vfmodule-model-list ----------------------------------------------- -usage: oclip vlm-key-group-create +usage: onap vf2vfmodule-model-list -Create License Key Group +List the VF modules in a given VF model in SDC -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-c | --vlm-id] [-e | --vlm-version] [-x | --name] - [-y | --type] [-z | --description] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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:: - -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. + -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. Results:: - ID License Model ID and is of type STRING. + vsp-uuid VSP uuid and is of type STRING. + vsp-version VSP version and is of type STRING. + module-uuid UUID and is of type STRING. + module-invariant-uuid Invariant UUID and is of type STRING. + module-name name and is of type STRING. + module-version version and is of type STRING. Error:: @@ -2789,60 +2722,112 @@ Error:: -[45] vlm-key-group-list +[48] vf-model-certify-complete ----------------------------------------------- -usage: oclip vlm-key-group-list +usage: onap vf-model-certify-complete -key group list in a license model +Complete 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. + + +Error:: + + On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + + +[49] cloud-list +----------------------------------------------- + + +usage: onap cloud-list + +List the configured clouds and Onap service subscriptions -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-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] + [-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. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. Results:: - ID Feature group ID and is of type STRING. - name Feature group name 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:: @@ -2851,54 +2836,55 @@ Error:: -[46] vlm-revert +[50] sdnc-list ----------------------------------------------- -usage: oclip vlm-revert +usage: onap sdnc-list -Revert Vendor License Model +List the configured sdnc -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-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] + [-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 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. + -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:: + + sdnc-id Onap sdnc id and is of type STRING. + resource-version Onap sdnc resource version and is of type STRING. Error:: @@ -2907,56 +2893,69 @@ Error:: -[47] vsp-add-artifact +[51] sdnc-register ----------------------------------------------- -usage: oclip vsp-add-artifact +usage: onap sdnc-register -Upload the CSAR file to VSP +Register a SDNC in Onap -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 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] - [-x | --vsp-id] [-y | --vsp-version] [-z | --vsp-file] - [-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. - -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. + -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:: @@ -2965,54 +2964,50 @@ Error:: -[48] vsp-checkout +[52] sdnc-unregister ----------------------------------------------- -usage: oclip vsp-checkout +usage: onap sdnc-unregister -Checkout Vendor Software Product +Un-register a VNFM in Onap -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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:: - -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. + -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:: @@ -3021,75 +3016,62 @@ Error:: -[49] vsp-create +[53] vnfm-show ----------------------------------------------- -usage: oclip vsp-create +usage: onap vnfm-show -Create Vendor Software Product +Show the VNFM in Onap -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-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] + [-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] 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-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. + -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:: - ID VSP ID 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:: @@ -3098,54 +3080,54 @@ Error:: -[50] vsp-package +[54] vnfm-unregister ----------------------------------------------- -usage: oclip vsp-package +usage: onap vnfm-unregister -Package Vendor Software Product +Un-register a VNFM in Onap -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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] 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. + -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. Error:: @@ -3154,54 +3136,67 @@ Error:: -[51] service-model-approve +[55] vnfm-register ----------------------------------------------- -usage: oclip service-model-approve +usage: onap vnfm-register -Approves the Service model in SDC +Register a VNFM in Onap -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-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] + [-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] 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 | --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. + -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. Error:: @@ -3210,61 +3205,57 @@ Error:: -[52] vlm-list +[56] vnfm-list ----------------------------------------------- -usage: oclip vlm-list +usage: onap vnfm-list -List License Model +List the configured vnfm -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 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:: - -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. + -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 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. + 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:: @@ -3273,54 +3264,71 @@ Error:: -[53] vlm-submit +[57] vim-register ----------------------------------------------- -usage: oclip vlm-submit +usage: onap vim-register -Submit Vendor License Model +Register a VIM under a given cloud region in Onap -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-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] + [-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:: - -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. + -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. Error:: @@ -3329,54 +3337,57 @@ Error:: -[54] vsp-checkin +[58] vim-unregister ----------------------------------------------- -usage: oclip vsp-checkin +usage: onap vim-unregister -Checkin Vendor Software Product +Un-register a VIM under from cloud region in Onap -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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] 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. + -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. Error:: @@ -3385,63 +3396,122 @@ Error:: -[55] vsp-list +[59] vim-list ----------------------------------------------- -usage: oclip vsp-list +usage: onap vim-list -List of the Vendor Software Products +List the configured vims -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 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] + +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. + + +Error:: + + On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + + +[60] ems-list +----------------------------------------------- + + +usage: onap ems-list + +List the configured ems + +Onap service: aai v11 + +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:: - -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. + -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. - 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. + ems-id Onap ems id and is of type STRING. + resource-version Onap ems resource version and is of type STRING. Error:: @@ -3450,54 +3520,63 @@ Error:: -[56] vsp-revert +[61] ems-register ----------------------------------------------- -usage: oclip vsp-revert +usage: onap ems-register -Revert Vendor Software Product +Register a EMS in Onap -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 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] - [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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. + -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. Error:: @@ -3506,66 +3585,62 @@ Error:: -[57] vsp-show +[62] ems-show ----------------------------------------------- -usage: oclip vsp-show +usage: onap ems-show -Details of the Vendor Software Product +Show the details of configured ems -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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] 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. + -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 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. + 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:: @@ -3574,54 +3649,55 @@ Error:: -[58] service-model-certify-request +[63] cloud-delete ----------------------------------------------- -usage: oclip service-model-certify-request +usage: onap cloud-delete -Request the certification of Service model in SDC +Delete a cloud region from Onap -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 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] - [-b | --service-model-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-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. - -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. + -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:: @@ -3630,54 +3706,54 @@ Error:: -[59] vsp-submit +[64] ems-unregister ----------------------------------------------- -usage: oclip vsp-submit +usage: onap ems-unregister -Submit Vendor Software Product +Un-register a EMS in Onap -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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:: - -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. + -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:: @@ -3686,60 +3762,60 @@ Error:: -[60] vsp-validate +[65] subscription-list ----------------------------------------------- -usage: oclip vsp-validate +usage: onap subscription-list -Validated the uploaded Vendor Software Product +Lists the subscription for a given customer in Onap -Product: onap-1.1 -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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:: - -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. + -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:: - status Validation status and is of type STRING. - errors Validation messages and is of type JSON. + 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:: @@ -3748,57 +3824,55 @@ Error:: -[61] microservice-show +[66] subscription-create ----------------------------------------------- -usage: oclip microservice-show +usage: onap subscription-create -Details the registered microservice in Onap +Create a subscription of a customer for given service in specific cloud region in Onap -Product: onap-1.1 -Service: msb -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --service-name] [-y | --service-version] [-m | --host-url] + [-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:: - -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:: - - 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. + -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:: @@ -3807,70 +3881,54 @@ Error:: -[62] microservice-create +[67] subscription-delete ----------------------------------------------- -usage: oclip microservice-create +usage: onap subscription-delete -Register microservice into Onap +Delete the subscription for a given customer in Onap -Product: onap-1.1 -Service: msb -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 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] - [-x | --service-name] [-y | --service-version] [-r | --service-url] - [-b | --enable-ssl] [-c | --path] <node-ip> - <node-port> <create-or-update> [-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-name Onap service name. It is of type STRING. - -y | --service-version Onap service version. It is of type STRING. - -r | --service-url Onap service base url. It is of type URL. - -b | --enable-ssl Onap service is enabled with https or not. It is - of type STRING. It is optional. - -c | --path Onap service path. It is of type STRING. It is - optional. - node-ip Onap service running node IP. It is of type - STRING. - node-port Onap service running node port. It is of type - STRING. - create-or-update Onap service create or update. It is of type - BOOL. By default, it is true. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - - -Results:: - - name Onap service name and is of type STRING. - version Onap service version and is of type STRING. - url Onap service base url and is of type URL. - status Onap service status and is of type DIGIT. - nodes Onap service running nodes and is of type STRING. - enable-ssl Onap service is enabled with https or not and is - of type STRING. - path Onap service path and is of type STRING. + -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. Error:: @@ -3879,55 +3937,59 @@ Error:: -[63] microservice-list +[68] customer-show ----------------------------------------------- -usage: oclip microservice-list +usage: onap customer-show -Lists the registetred micro services in Onap +Lists the registetred customers in Onap -Product: onap-1.1 -Service: msb -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-m | --host-url] + [-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:: - -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. + -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 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. + 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:: @@ -3936,50 +3998,51 @@ Error:: -[64] microservice-delete +[69] customer-create ----------------------------------------------- -usage: oclip microservice-delete +usage: onap customer-create -Deletes the micro service from Onap +Create a customer in Onap -Product: onap-1.1 -Service: msb -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-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] + [-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] 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-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. + -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. Error:: @@ -3988,54 +4051,53 @@ Error:: -[65] cloud-create +[70] customer-delete ----------------------------------------------- -usage: oclip cloud-create +usage: onap customer-delete -Create a cloud region in Onap +Delete a customer from Onap -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-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] + [-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] 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. + -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. Error:: @@ -4044,56 +4106,56 @@ Error:: -[66] customer-delete +[71] customer-list ----------------------------------------------- -usage: oclip customer-delete +usage: onap customer-list -Delete a customer from Onap +Lists the registetred customers in Onap -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-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] + [-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. - -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. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + name Onap customer name and is of type STRING. + resource-version Onap customer resource version and is of type + STRING. Error:: @@ -4102,59 +4164,59 @@ Error:: -[67] customer-list +[72] vf-list ----------------------------------------------- -usage: oclip customer-list +usage: onap vf-list -Lists the registetred customers in Onap +List created VF instances for a service instance -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: + [-x | --customer-name] [-y | --service-type] [-z | --service-id] + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-h | --help] [-v | --version] [-d | --debug] [-f | --format] [-s | --long] [-t | --no-title] - [-u | --host-username] [-p | --host-password] [-m | --host-url] [-a | --no-auth] where:: - -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. + -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. Results:: - name Onap customer name and is of type STRING. - resource-version Onap customer resource version 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:: @@ -4163,62 +4225,62 @@ Error:: -[68] customer-show +[73] service-list ----------------------------------------------- -usage: oclip customer-show +usage: onap service-list -Lists the registetred customers in Onap +List created service instance -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +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] + [-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] 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 | --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. 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. + 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:: @@ -4227,66 +4289,62 @@ Error:: -[69] ems-register +[74] vf-show ----------------------------------------------- -usage: oclip ems-register +usage: onap vf-show -Register a EMS in Onap +Show details for VF -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-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] + [-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] 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 | --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. + -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. + + +Results:: + + vf-id VF ID for the given service and is of type STRING. + vf-name VF name and is of type STRING. + vf-type VF name and is of type STRING. + model-invariant-id VF name and is of type STRING. + model-uuid model uuid and is of type STRING. + model-customization-id Model customization id and is of type STRING. + service-id Service ID of parent service and is of type + STRING. Error:: @@ -4295,57 +4353,54 @@ Error:: -[70] ems-unregister +[75] tenant-create ----------------------------------------------- -usage: oclip ems-unregister +usage: onap tenant-create -Un-register a EMS in Onap +Create a tenant under given cloud region in Onap -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-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] + [-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] 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 - 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. + -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. Error:: @@ -4354,58 +4409,59 @@ Error:: -[71] ems-list +[76] tenant-list ----------------------------------------------- -usage: oclip ems-list +usage: onap tenant-list -List the configured ems +Lists the tenants under given cloud region in Onap -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-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] + [-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] 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. - -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 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:: - ems-id Onap ems id and is of type STRING. - resource-version Onap ems resource version and is of type STRING. + tenant-id Onap tenant-id and is of type STRING. + tenant-name Onap tenant name and is of type STRING. + resource-version Onap tenant resource version and is of type + STRING. Error:: @@ -4414,65 +4470,56 @@ Error:: -[72] ems-show +[77] tenant-delete ----------------------------------------------- -usage: oclip ems-show +usage: onap tenant-delete -Show the details of configured ems +Delete tenant under given cloud region in Onap -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-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] + [-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] 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:: - - 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. + -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. Error:: @@ -4481,72 +4528,57 @@ Error:: -[73] sdnc-register +[78] service-type-list ----------------------------------------------- -usage: oclip sdnc-register +usage: onap service-type-list -Register a SDNC in Onap +List the service types configured in Onap -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-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:: - -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. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + service-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:: @@ -4555,53 +4587,53 @@ Error:: -[74] sdnc-unregister +[79] service-type-create ----------------------------------------------- -usage: oclip sdnc-unregister +usage: onap service-type-create -Un-register a VNFM in Onap +Add a service type in Onap -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-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] + [-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:: - -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. + -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:: @@ -4610,58 +4642,108 @@ Error:: -[75] sdnc-list +[80] service-type-delete ----------------------------------------------- -usage: oclip sdnc-list +usage: onap service-type-delete -List the configured sdnc +Delete a service type from Onap -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v11 Options:: - [-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] + [-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:: - -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. + -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. -Results:: +Error:: + + On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + + +[81] cloud-create +----------------------------------------------- + - sdnc-id Onap sdnc id and is of type STRING. - resource-version Onap sdnc resource version and is of type STRING. +usage: onap cloud-create + +Create a cloud region in Onap + +Onap service: aai v11 + +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] + +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. Error:: @@ -4670,74 +4752,64 @@ Error:: -[76] vim-register +[82] service-delete ----------------------------------------------- -usage: oclip vim-register +usage: onap service-delete -Register a VIM under a given cloud region in Onap +Delete service instance (experimental) -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: so v3 Options:: - [-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] + [-x | --service-instace-id] [-b | --model-invariant-id] [-i | --model-uuid] + [-e | --model-name] [-g | --model-version] [-c | --customer-name] + [-j | --cloud-region] [-k | --tenant-id] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] where:: - -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. + -x | --service-instace-id unique id for service instance. It is of type + STRING. + -b | --model-invariant-id model invariant id for service in SDC catalog. It + is of type STRING. + -i | --model-uuid model uuid for service in SDC catalog. It is of + type STRING. + -e | --model-name model name available in SDC catalog. It is of + type STRING. + -g | --model-version model version of service (eg. 1.0). It is of type + STRING. + -c | --customer-name unique id for customer. It is of type STRING. + -j | --cloud-region cloud region id. It is of type STRING. + -k | --tenant-id tenant id. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. Error:: @@ -4746,60 +4818,59 @@ Error:: -[77] vim-unregister +[83] vfmodule-delete ----------------------------------------------- -usage: oclip vim-unregister +usage: onap vfmodule-delete -Un-register a VIM under from cloud region in Onap +delete a VF module (experimental) -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: so v3 Options:: - [-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] + [-x | --vfmodule-id] [-j | --service-id] [-y | --vf-id] + [-k | --vf-model-invariant-id] [-e | --vfmodule-name] [-g | --vfmodule-version] + [-l | --cloud-region] [-z | --tenant-id] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] where:: - -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. + -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. Error:: @@ -4808,68 +4879,81 @@ Error:: -[78] vim-list +[84] vfmodule-create ----------------------------------------------- -usage: oclip vim-list +usage: onap vfmodule-create -List the configured vims +Create a VF module -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: so v3 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] - [-x | --cloud-name] [-y | --region-name] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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. + -l | --cloud-region cloud region identifier. It is of type STRING. + -B | --tenant-id openstack tenant id. It is of type STRING. + -b | --vfmodule-invariant-id vfmodule model invariant id. It is of type STRING. + -c | --vfmodule-uuid model uuid for vfmodule. It is of type STRING. + -e | --vfmodule-name vfmodule model name. It is of type STRING. + -g | --vfmodule-version vf module version. It is of type STRING. + -i | --module-name vfmodule name. It is of type STRING. + -j | --service-id unique id for service. It is of type STRING. + -y | --vf-id unique id for related VF. It is of type STRING. + -k | --vf-model-invariant-id vf model invariant id. It is of type STRING. + -A | --vf-model-uuid model uuid for vf. It is of type STRING. + -n | --vf-model-name vf model name. It is of type STRING. + -o | --vf-model-version vf model version. It is of type STRING. + -q | --vf-model-customization-id vf model customization id. This can be obtained + using SDC portal (Home -> service:xxx -> + Composition -> click on VF for customization id). + It is of type STRING. + -r | --service-model-invariant-id model invariant id. It is of type STRING. + -w | --service-model-uuid model name version id. It is of type STRING. + -x | --service-model-name service model name. It is of type STRING. + -z | --service-model-version service model version. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. Results:: - 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. + vfmodule-id id for the created vnf and is of type STRING. Error:: @@ -4878,70 +4962,73 @@ Error:: -[79] vnfm-register +[85] service-create ----------------------------------------------- -usage: oclip vnfm-register +usage: onap service-create -Register a VNFM in Onap +Create a service instance using MSO -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: so v3 Options:: - [-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] + [-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:: - -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. + -l | --cloud-region cloud region identifier. It is of type STRING. + -b | --tenant-id tenant id. It is of type STRING. + -e | --model-invariant-id model invariant id generated by ASDC. It is of + type STRING. + -g | --model-uuid model uuid generated by ASDC. It is of type + STRING. + -i | --model-name model name as provided in ASDC design time. It is + of type STRING. + -j | --model-version model-version. It is of type STRING. + -c | --customer unique id for customer. It is of type STRING. + -k | --instance-name service instance name. It is of type STRING. + -r | --supress-rollback rollback changes if instantiation fails. It is of + type BOOL. It is optional. By default, it is + false. + -w | --service-type subscription service type. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + service-id instance id for the created service. and is of + type STRING. Error:: @@ -4950,57 +5037,64 @@ Error:: -[80] vnfm-unregister +[86] vf-delete ----------------------------------------------- -usage: oclip vnfm-unregister +usage: onap vf-delete (experimental) -Un-register a VNFM in Onap +delete a VF -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: so v3 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vnfm-id] [-y | --resource-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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] 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 - 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. + -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. Error:: @@ -5009,60 +5103,74 @@ Error:: -[81] vnfm-list +[87] vf-create ----------------------------------------------- -usage: oclip vnfm-list +usage: onap vf-create -List the configured vnfm +Create a VF -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: so v3 Options:: - [-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] + [-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] 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. - -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. + -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:: - 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. + vf-id id for the created vnf and is of type STRING. Error:: @@ -5071,65 +5179,63 @@ Error:: -[82] vnfm-show +onap-1.0 +========================== + + +[1] license-group-create ----------------------------------------------- -usage: oclip vnfm-show +usage: onap license-group-create -Show the VNFM in Onap +Create License Group -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 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] - [-x | --vnfm-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-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. + -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. 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. + ID License Group ID and is of type STRING. Error:: @@ -5138,65 +5244,59 @@ Error:: -[83] service-list +[2] ep-show ----------------------------------------------- -usage: oclip service-list +usage: onap ep-show -List created service instance +Details of the Entitlement Pool -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +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] + [-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] 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 | --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:: - 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 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:: @@ -5205,62 +5305,57 @@ Error:: -[84] vf-list +[3] license-model-create ----------------------------------------------- -usage: oclip vf-list +usage: onap license-model-create -List created VF instances for a service instance +Create License Model -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +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] [-z | --service-id] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-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] 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. - -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. + -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:: - vf-id VF ID for the given service and is of type STRING. - vf-name VF name and is of type STRING. + ID License Model ID and is of type STRING. Error:: @@ -5269,65 +5364,59 @@ Error:: -[85] vf-show +[4] license-group-show ----------------------------------------------- -usage: oclip vf-show +usage: onap license-group-show -Show details for VF +Details of the License Group -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vf-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-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:: - -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. + -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. 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 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:: @@ -5336,56 +5425,51 @@ Error:: -[86] service-type-create +[5] vsp-upload ----------------------------------------------- -usage: oclip service-type-create +usage: onap vsp-upload -Add a service type in Onap +Upload the CSAR file to VSP -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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] 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-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. + -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. Error:: @@ -5394,58 +5478,72 @@ Error:: -[87] service-type-delete +[6] vsp-create ----------------------------------------------- -usage: oclip service-type-delete +usage: onap vsp-create -Delete a service type from Onap +Create Vendor Software Product -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: + [-x | --vsp-name] [-y | --vsp-description] [-b | --vsp-category] + [-c | --vsp-subcategory] [-e | --vlm-version] [-g | --vlm-vendor] + [-i | --vlm-id] [-j | --vlm-agreement-id] [-k | --vlm-feature-group-id] + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-h | --help] [-v | --version] [-d | --debug] [-f | --format] [-s | --long] [-t | --no-title] - [-x | --service-type-id] [-y | --resource-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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-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. + -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. Error:: @@ -5454,63 +5552,55 @@ Error:: -[88] cloud-list +[7] vsp-list ----------------------------------------------- -usage: oclip cloud-list +usage: onap vsp-list -List the configured clouds and Onap service subscriptions +List of the Vendor Software Products -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 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:: - -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. + -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:: - 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 VSP ID and is of type STRING. + name VSP Name and is of type STRING. Error:: @@ -5519,58 +5609,57 @@ Error:: -[89] cloud-delete +[8] vsp-show ----------------------------------------------- -usage: oclip cloud-delete +usage: onap vsp-show -Delete a cloud region from Onap +Details of the Vendor Software Product -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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. + + +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. Error:: @@ -5579,54 +5668,50 @@ Error:: -[90] customer-create +[9] vsp-submit ----------------------------------------------- -usage: oclip customer-create +usage: onap vsp-submit -Create a customer in Onap +Submit Vendor Software Product -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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:: @@ -5635,60 +5720,50 @@ Error:: -[91] service-type-list +[10] vsp-checkin ----------------------------------------------- -usage: oclip service-type-list +usage: onap vsp-checkin -List the service types configured in Onap +Checkin Vendor Software Product -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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:: - -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. + -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:: @@ -5697,58 +5772,59 @@ Error:: -[92] subscription-create +[11] license-model-show ----------------------------------------------- -usage: oclip subscription-create +usage: onap license-model-show -Create a subscription of a customer for given service in specific cloud region in Onap +Details of the License Model -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 Options:: - [-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] + [-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] 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. - -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. + -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. + + +Results:: + + name License Model Name and is of type STRING. + ID License Model ID and is of type STRING. + description Description for the License Model and is of type + STRING. + status Status of the License Model and is of type STRING. Error:: @@ -5757,57 +5833,67 @@ Error:: -[93] subscription-delete +[12] ep-create ----------------------------------------------- -usage: oclip subscription-delete +usage: onap ep-create -Delete the subscription for a given customer in Onap +Create Entitlement Pool -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: sdc v1.0 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] - [-x | --customer-name] [-y | --service-type] [-g | --resource-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 | --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. + -x | --ep-name Entitlement Pool name. It is of type STRING. + -y | --license-model-id License Model ID. It is of type STRING. + -z | --ep-description Description for Entitlement Pool. It is of type + STRING. + -q | --threshold-value threshold. It is of type STRING. + -b | --threshold-unit threshold. It is of type STRING. + -c | --entitlement-metric Entitlement Metric. It is of type STRING. + -e | --aggregation-function Aggregation Function. It is of type STRING. + -g | --operational-scope Operational Scope. It is of type STRING. + -k | --reference-number Reference Number. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + ID Entitlement Pool ID and is of type STRING. Error:: @@ -5816,63 +5902,55 @@ Error:: -[94] subscription-list +[13] subscription-list ----------------------------------------------- -usage: oclip subscription-list +usage: onap subscription-list Lists the subscription for a given customer in Onap -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v8 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] + [-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:: - -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 | --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:: - 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. + service-type Onap service type and is of type STRING. Error:: @@ -5881,57 +5959,62 @@ Error:: -[95] tenant-create +[14] subscription-create ----------------------------------------------- -usage: oclip tenant-create +usage: onap subscription-create -Create a tenant under given cloud region in Onap +Create a subscription for a customer in Onap -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v8 Options:: - [-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] + [-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] 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. - -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. + -x | --customer-name Onap customer name. It is of type STRING. + -y | --subscriber-name Onap subscriber name. It is of type STRING. + -z | --cloud-type Onap cloud type (openstack, rackspace). It is of + type STRING. + -r | --cloud-region Onap cloud region. It is of type STRING. + -c | --cloud-tenant-id Onap cloud tenant id. It is of type STRING. + -e | --service-type Onap service type. It is of type STRING. + -g | --resource-version Onap subscription resource version. It is + mandatory for existing customer to create a new + subscription. It is of type STRING. It is + optional. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. 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:: @@ -5940,59 +6023,59 @@ Error:: -[96] tenant-delete +[15] customer-show ----------------------------------------------- -usage: oclip tenant-delete +usage: onap customer-show -Delete tenant under given cloud region in Onap +Lists the registetred customers in Onap -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v8 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --cloud] [-y | --region] [-z | --tenant-id] - [-r | --resource-version] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-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:: - -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. + -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. Error:: @@ -6001,62 +6084,56 @@ Error:: -[97] tenant-list +[16] customer-list ----------------------------------------------- -usage: oclip tenant-list +usage: onap customer-list -Lists the tenants under given cloud region in Onap +Lists the registetred customers in Onap -Product: onap-1.1 -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: aai v8 Options:: + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-h | --help] [-v | --version] [-d | --debug] [-f | --format] [-s | --long] [-t | --no-title] - [-x | --cloud] [-y | --region] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-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. + -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. + name Onap customer name and is of type STRING. + resource-version Onap customer resource version and is of type + STRING. Error:: @@ -6065,47 +6142,53 @@ Error:: -open-cli -========================== - - -[1] basic-logout +[17] customer-delete ----------------------------------------------- -usage: oclip basic-logout +usage: onap customer-delete -basic logout auth command +Delete a customer from Onap -Product: open-cli -Service: basic-auth -Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com +Onap service: aai v8 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-m | --host-url] + [-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] 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. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. + -x | --customer-name Onap customer name. It is of type STRING. + -y | --resource-version Onap customer resource version. It is of type + UUID. It is optional. By default, it is + 6dc30068-de3c-483a-a9a8-7d483a39425d. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. Error:: @@ -6114,54 +6197,51 @@ Error:: -[2] catalog +[18] customer-create ----------------------------------------------- -usage: oclip catalog +usage: onap customer-create -cli catalog command to find the base path for service. +Create a customer in Onap -Product: open-cli -Service: catalog -Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com +Onap service: aai v8 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-l | --catalog-service-name] [-i | --catalog-service-version] [-m | --host-url] + [-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] 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:: - - 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. + -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. Error:: @@ -6170,49 +6250,110 @@ Error:: -[3] schema-refresh +[19] service-type-create ----------------------------------------------- -usage: oclip schema-refresh +usage: onap service-type-create -Oclip command to refresh schemas stored in open-cli-schema folders. +Add a service type in Onap -Product: open-cli -Service: schema -Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com +Onap service: aai v8 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] + [-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:: - -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 + eb4a0d54-0e29-4174-8a3c-2c98e904a5f6. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. 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:: +Error:: + + On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + + +[20] service-type-delete +----------------------------------------------- + + +usage: onap service-type-delete + +Delete a service type from Onap + +Onap service: aai v8 - 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. +Options:: + + [-x | --service-type-id] [-y | --resource-version] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --service-type-id Onap service type uuid. It is of type UUID. It is + optional. By default, it is + 31d3a8cb-d4ff-4b4e-a0d3-5f79f3062686. + -y | --resource-version Onap service resource version. It is of type + UUID. It is optional. By default, it is + b06576ca-74b8-42f2-815b-6f7b80f9941c. + -u | --onap-username Onap user name. It is of type STRING. By default, + 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:: @@ -6221,51 +6362,57 @@ Error:: -[4] schema-validate +[21] service-type-list ----------------------------------------------- -usage: oclip schema-validate +usage: onap service-type-list -Oclip command to validate schema +List the service types configured in Onap -Product: open-cli -Service: schema -Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com +Onap service: aai v8 Options:: + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-h | --help] [-v | --version] [-d | --debug] [-f | --format] [-s | --long] [-t | --no-title] - [-l | --schema-location] [-i | --internal-schema] [-b | --ocs-version] + [-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 | --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. + -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:: - sl-no Serial Number of error and is of type STRING. - error Schema validation error 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:: @@ -6274,57 +6421,59 @@ Error:: -[5] basic-login +[22] cloud-list ----------------------------------------------- -usage: oclip basic-login +usage: onap cloud-list -basic login auth command +List the configured clouds and Onap service subscriptions -Product: open-cli -Service: basic-auth -Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com +Onap service: aai v8 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:: - -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. + -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:: - Authorization Authorization 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. Error:: @@ -6333,56 +6482,51 @@ Error:: -sample-1.0 +cli-1.0 ========================== -[1] hello-world-http +[1] schema-validate ----------------------------------------------- -usage: oclip hello-world-http - -First cmd hello world using http runing under -lighttpd in cli at http://<cli-ip>:8080/version.json +usage: onap schema-validate +Onap command to validate schema -Product: sample-1.0 -Service: hello-world -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: onap-cli 1.0.0 Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-b | --name] [-m | --host-url] + [-l | --schema-location] [-i | --internal-schema] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] 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. + -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. Results:: - output hello world output and is of type STRING. + sl-no Serial Number of error and is of type STRING. + error Schema validation error and is of type STRING. Error:: @@ -6391,50 +6535,48 @@ Error:: -[2] hello-world +[2] schema-refresh ----------------------------------------------- -usage: oclip hello-world +usage: onap schema-refresh -First cmd hello world +Onap command to refresh schemas stored in onap_cli_schema folders. -Product: sample-1.0 -Service: hello-world -Author: ONAP CLI Team onap-discuss@lists.onap.org +Onap service: onap-cli 1.0.0 Options:: [-h | --help] [-v | --version] [-d | --debug] [-f | --format] [-s | --long] [-t | --no-title] - [-b | --name] 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 ${env:DEMO_NAME}. + -h | --help Onap command help message. It is 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:: - output hello world output and is of type STRING. + 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. Error:: On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - |