From 208be2505b56df39aad52df15983d03517b17595 Mon Sep 17 00:00:00 2001 From: Kanagaraj Manickam k00365106 Date: Thu, 2 Nov 2017 19:12:33 +0530 Subject: Improve validation test cases CLI-57 Change-Id: I1c44db4d71893af0093598ac4d539774360d1ab6 Signed-off-by: Kanagaraj Manickam k00365106 --- docs/cmd_help.rst | 5745 ++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 4317 insertions(+), 1428 deletions(-) (limited to 'docs/cmd_help.rst') diff --git a/docs/cmd_help.rst b/docs/cmd_help.rst index 0dec1cd3..9d8d76e0 100644 --- a/docs/cmd_help.rst +++ b/docs/cmd_help.rst @@ -10,11 +10,67 @@ .. _cli_cmd_help: onap-1.1 -======== +========================== + + +[1] microservice-show +----------------------------------------------- + + +usage: onap microservice-show + +Details the registered microservice in Onap + +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] + +where:: + + -x | --service-name Onap service name. It is of type STRING. + -y | --service-version Onap service version. It is of type STRING. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + + +Results:: + + name Onap service name and is of type STRING. + version Onap service version and is of type STRING. + url Onap service base url and is of type URL. + status Onap service status and is of type DIGIT. + nodes Onap service running nodes and is of type JSON. + enable-ssl Onap service is enabled with https or not and is + of type STRING. + path Onap service path and is of type STRING. + + +Error:: + + On error, it prints :::: + -microservice-create -------------------- +[2] microservice-create +----------------------------------------------- usage: onap microservice-create @@ -26,16 +82,20 @@ Onap service: msb v1 Options:: [-x | --service-name] [-y | --service-version] [-r | --service-url] - - [-m | --host-url] [-h | --help] [-v | --version] - [-d | --debug] [-f | --format] [-s | --long] - [-t | --no-title] + [-b | --enable-ssl] [-c | --path] + [-m | --host-url] + [-h | --help] [-v | --version] [-d | --debug] + [-f | --format] [-s | --long] [-t | --no-title] where:: -x | --service-name Onap service name. It is of type STRING. -y | --service-version Onap service version. It is of type STRING. -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 @@ -62,11 +122,14 @@ where:: 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. + 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:: @@ -75,26 +138,31 @@ Error:: -microservice-show +[3] microservice-delete ----------------------------------------------- -usage: onap microservice-show +usage: onap microservice-delete -Details the registered microservice in Onap +Deletes the micro service from Onap 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] + [-x | --service-name] [-y | --service-version] [-i | --node-ip] + [-r | --node-port] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] where:: -x | --service-name Onap service name. It is of type STRING. -y | --service-version Onap service version. It is of type STRING. + -i | --node-ip Onap service running node IP. It is of type + STRING. + -r | --node-port Onap service running node port. It is of type + STRING. -m | --host-url Onap host url. It is of type URL. By default, it is read from environment variable ONAP_HOST_URL. -h | --help Onap command help message. It is of type STRING. @@ -113,22 +181,13 @@ where:: 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. - - Error:: On error, it prints :::: -microservice-list +[4] microservice-list ----------------------------------------------- @@ -166,11 +225,14 @@ where:: 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. + 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:: @@ -179,31 +241,35 @@ Error:: -microservice-delete +[5] service-model-add-vnf ----------------------------------------------- -usage: onap microservice-delete +usage: onap service-model-add-vnf -Deletes the micro service from Onap +Helps to add VF into service models in SDC -Onap service: msb v1 +Onap service: sdc v1.0 Options:: - [-x | --service-name] [-y | --service-version] [-i | --node-ip] - [-r | --node-port] [-m | --host-url] [-h | --help] - [-v | --version] [-d | --debug] [-f | --format] - [-s | --long] [-t | --no-title] + [-x | --service-model-id] [-y | --vf-id] [-z | --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:: - -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. + -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-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. @@ -220,6 +286,13 @@ where:: false. -t | --no-title whether to print title or not. It is of type BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + ID Service ID and is of type STRING. Error:: @@ -228,50 +301,51 @@ Error:: -vsp-checkout +[6] service-model-approve ----------------------------------------------- -usage: onap vsp-checkout +usage: onap service-model-approve -Checkout Vendor Software Product +Approves the Service model in SDC Onap service: sdc v1.0 Options:: - [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password] + [-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:: - -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. + -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:: @@ -280,27 +354,25 @@ Error:: -cloud-create +[7] service-model-list ----------------------------------------------- -usage: onap cloud-create +usage: onap service-model-list -Create a cloud region in Onap +List the service model in SDC -Onap service: aai v11 +Onap service: sdc v1.0 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] + [-u | --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. @@ -327,33 +399,44 @@ where:: type BOOL. By default, it is false. +Results:: + + uuid UUID and is of type STRING. + invariant-uuid Invariant UUID and is of type STRING. + name Name and is of type STRING. + version version and is of type STRING. + status status and is of type STRING. + distribution-status status and is of type STRING. + description description and is of type STRING. + + Error:: On error, it prints :::: -customer-create +[8] service-model-certify-complete ----------------------------------------------- -usage: onap customer-create +usage: onap service-model-certify-complete -Create a customer in Onap +Completes the certification of Service model in SDC -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --customer-name] [-y | --subscriber-name] [-u | --onap-username] - [-p | --onap-password] [-m | --host-url] [-h | --help] - [-v | --version] [-d | --debug] [-f | --format] - [-s | --long] [-t | --no-title] [-a | --no-auth] + [-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:: - -x | --customer-name Onap customer name. It is of type STRING. - -y | --subscriber-name Onap subscriber name. It 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. @@ -386,53 +469,51 @@ Error:: -customer-delete +[9] vlm-checkout ----------------------------------------------- -usage: onap customer-delete +usage: onap vlm-checkout -Delete a customer from Onap +Checkout Vendor License Model -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --customer-name] [-y | --resource-version] [-u | --onap-username] + [-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 | --customer-name Onap customer name. It is of type STRING. - -y | --resource-version Onap customer resource version. It is of type - UUID. It is optional. By default, it is - 0f4899c3-771c-462e-9dc8-ffa2de5532f6. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -x | --vlm-id 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:: @@ -441,85 +522,28 @@ Error:: -tenant-delete +[10] vlm-create ----------------------------------------------- -usage: onap tenant-delete +usage: onap vlm-create -Delete tenant under given cloud region in Onap +Create License Model -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --cloud] [-y | --region] [-z | --tenant-id] - [-r | --resource-version] [-u | --onap-username] [-p | --onap-password] - [-m | --host-url] [-h | --help] [-v | --version] - [-d | --debug] [-f | --format] [-s | --long] - [-t | --no-title] [-a | --no-auth] - -where:: - - -x | --cloud Onap cloud. It is of type STRING. - -y | --region Onap cloud region. It is of type STRING. - -z | --tenant-id Onap cloud tenant id. It is of type STRING. - -r | --resource-version Onap cloud tenant version. It is of type UUID. It - is optional. By default, it is - adbbea15-de1a-442a-a0e3-793779ea25bb. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. 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 :::: - - - -tenant-list ------------------------------------------------ - - -usage: onap tenant-list - -Lists the tenants under given cloud region in Onap - -Onap service: aai v11 - -Options:: - - [-x | --cloud] [-y | --region] [-u | --onap-username] + [-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:: - -x | --cloud Onap cloud. It is of type STRING. - -y | --region Onap cloud region. It is of type STRING. + -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. @@ -548,10 +572,7 @@ where:: 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. + ID License Model ID and is of type UUID. Error:: @@ -560,19 +581,20 @@ Error:: -cloud-delete +[11] vlm-entitlement-pool-create ----------------------------------------------- -usage: onap cloud-delete +usage: onap vlm-entitlement-pool-create -Delete a cloud region from Onap +Create Entitlement Pool -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --cloud-name] [-y | --region-name] [-z | --resource-version] + [-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] @@ -580,35 +602,43 @@ Options:: where:: - -x | --cloud-name Onap cloud name. It is of type STRING. - -y | --region-name Onap cloud region name. It is of type STRING. - -z | --resource-version Onap cloud region version. It is of type UUID. It - is optional. By default, it is - 93230cdb-aae3-4b87-a38a-fc4529e8aac9. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -x | --name Entitlement Pool name. It is of type STRING. + -y | --vlm-id License Model ID. It is of type STRING. + -e | --vlm-version License Model version. It is of type STRING. + -z | --description Description for Entitlement Pool. It is of type + STRING. + -g | --operational-scope Operational Scope. It is of type STRING. By + default, it is Availability_Zone. + -k | --manufacture-reference-number Manufature Reference Number. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + ID Entitlement Pool ID and is of type STRING. Error:: @@ -617,25 +647,27 @@ Error:: -customer-list +[12] vlm-entitlement-pool-list ----------------------------------------------- -usage: onap customer-list +usage: onap vlm-entitlement-pool-list -Lists the registetred customers in Onap +entitlement pool list in a license model -Onap service: aai v11 +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] - [-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:: + -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. @@ -664,9 +696,8 @@ where:: Results:: - name Onap customer name and is of type STRING. - resource-version Onap customer resource version and is of type - STRING. + ID Feature group ID and is of type STRING. + name Feature group name and is of type STRING. Error:: @@ -675,25 +706,94 @@ Error:: -ems-list +[13] vlm-feature-group-create ----------------------------------------------- -usage: onap ems-list +usage: onap vlm-feature-group-create -List the configured ems +Create feature group Pool -Onap service: aai v11 +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] - [-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:: + + -x | --name Feature group name. It is of type STRING. + -y | --vlm-id License Model ID. It is of type STRING. + -e | --vlm-version License Model version. It is of type STRING. + -z | --description Description for feature group. It is of type + STRING. + -g | --vlm-key-group-id VLM keygroup. It is of type STRING. + -b | --vlm-entitle-pool-id VLM Entitlement pool. It is of type STRING. + -c | --part-number Part number. It is of type STRING. + -k | --manufacture-reference-number Manufature Reference Number. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + ID Feature group ID and is of type STRING. + + +Error:: + + On error, it prints :::: + + + +[14] vlm-feature-group-list +----------------------------------------------- + + +usage: onap vlm-feature-group-list + +Feature group list in a 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 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. @@ -722,8 +822,8 @@ where:: Results:: - ems-id Onap ems id and is of type STRING. - resource-version Onap ems resource version and is of type STRING. + ID Feature group ID and is of type STRING. + name Feature group name and is of type STRING. Error:: @@ -732,26 +832,33 @@ Error:: -sdnc-unregister +[15] vlm-key-group-create ----------------------------------------------- -usage: onap sdnc-unregister +usage: onap vlm-key-group-create -Un-register a VNFM in Onap +Create License Key Group -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --sdnc-id] [-u | --onap-username] [-p | --onap-password] - [-m | --host-url] [-h | --help] [-v | --version] - [-d | --debug] [-f | --format] [-s | --long] - [-t | --no-title] [-a | --no-auth] + [-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:: - -x | --sdnc-id Onap VNFM unique id. It is of type STRING. + -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. @@ -778,63 +885,68 @@ where:: type BOOL. By default, it is false. +Results:: + + ID License Model ID and is of type STRING. + + Error:: On error, it prints :::: -vim-unregister +[16] vlm-key-group-list ----------------------------------------------- -usage: onap vim-unregister +usage: onap vlm-key-group-list -Un-register a VIM under from cloud region in Onap +key group list in a license model -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --cloud-name] [-y | --region-name] [-z | --vim-id] - [-b | --resource-version] [-u | --onap-username] [-p | --onap-password] - [-m | --host-url] [-h | --help] [-v | --version] - [-d | --debug] [-f | --format] [-s | --long] - [-t | --no-title] [-a | --no-auth] + [-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 | --cloud-name Onap cloud name. It is of type STRING. - -y | --region-name Onap region name. It is of type STRING. - -z | --vim-id Onap VIM unique id. It is of type UUID. By - default, it is - 65c6f4af-893f-4130-aa79-9158fcaed040. - -b | --resource-version Onap vim resource version. It is of type STRING. - It is optional. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -x | --vlm-id 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:: @@ -843,91 +955,22 @@ Error:: -vnfm-register +[17] vlm-list ----------------------------------------------- -usage: onap vnfm-register +usage: onap vlm-list -Register a VNFM in Onap +List License Model -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --vim-id] [-y | --vnfm-id] [-b | --name] - [-c | --type] [-e | --vendor] [-q | --vnfm-version] - [-g | --url] [-i | --username] [-j | --password] - [-z | --certificate-url] [-u | --onap-username] [-p | --onap-password] - [-m | --host-url] [-h | --help] [-v | --version] - [-d | --debug] [-f | --format] [-s | --long] - [-t | --no-title] [-a | --no-auth] - -where:: - - -x | --vim-id Onap VIM unique id. It is of type UUID. By - default, it is - e74f4b44-28ee-45e4-a1ac-7c3a0ed4a0b7. - -y | --vnfm-id Onap VNFM unique id. It is of type UUID. By - default, it is - 7a74f262-5b96-4445-8a56-2d43b73f6f6c. - -b | --name Onap VNFM name. It is of type STRING. - -c | --type Onap VNFM type. It is of type STRING. - -e | --vendor Onap VNFM vendor. It is of type STRING. - -q | --vnfm-version Onap VNFM version. It is of type STRING. - -g | --url Onap VNFM URL. It is of type STRING. - -i | --username Onap VNFM username. It is of type STRING. - -j | --password Onap VNFM password. It is of type STRING. - -z | --certificate-url Onap VNFM certificate-url. It is of type STRING. - It is optional. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. 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 :::: - - - -vnfm-list ------------------------------------------------ - - -usage: onap vnfm-list - -List the configured vnfm - -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] - [-a | --no-auth] + [-u | --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:: @@ -959,10 +1002,11 @@ where:: Results:: - vnfm-id Onap vnfm id and is of type STRING. - vim-id Onap vnfm id and is of type STRING. - certificate-url Onap vnfm certificate-url and is of type STRING. - resource-version Onap vnfm resource version and is of type STRING. + id 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:: @@ -971,53 +1015,51 @@ Error:: -service-type-create +[18] vlm-revert ----------------------------------------------- -usage: onap service-type-create +usage: onap vlm-revert -Add a service type in Onap +Revert Vendor License Model -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --service-type] [-y | --service-type-id] [-u | --onap-username] + [-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 | --service-type Onap service type. It is of type STRING. - -y | --service-type-id Onap service type uuid. It is of type UUID. It is - optional. By default, it is - 3def24ae-701e-4c98-91a6-859c0f206759. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -x | --vlm-id 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:: @@ -1026,55 +1068,51 @@ Error:: -service-type-delete +[19] vlm-submit ----------------------------------------------- -usage: onap service-type-delete +usage: onap vlm-submit -Delete a service type from Onap +Submit Vendor License Model -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --service-type-id] [-y | --resource-version] [-u | --onap-username] + [-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 | --service-type-id Onap service type uuid. It is of type UUID. It is - optional. By default, it is - 04ebd209-7800-43f4-bca4-aaf61e15783e. - -y | --resource-version Onap service resource version. It is of type - UUID. It is optional. By default, it is - 7b301a17-5eb2-413b-b214-fd1659fdf049. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -x | --vlm-id 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:: @@ -1083,18 +1121,19 @@ Error:: -service-type-list +[20] vsp-add-artifact ----------------------------------------------- -usage: onap service-type-list +usage: onap vsp-add-artifact -List the service types configured in Onap +Upload the CSAR file to VSP -Onap service: aai v11 +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] @@ -1102,6 +1141,9 @@ Options:: where:: + -x | --vsp-id Onap VSP ID. It is of type STRING. + -y | --vsp-version Onap VSP version. It is of type STRING. + -z | --vsp-file CSAR File path. It is of type BINARY. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable ONAP_USERNAME. @@ -1128,96 +1170,33 @@ where:: type BOOL. By default, it is false. -Results:: - - service-type-id Onap cloud service and is of type STRING. - service-type Onap cloud service and is of type STRING. - resource-version Onap cloud service resource version and is of - type STRING. - - Error:: On error, it prints :::: -subscription-create +[21] vsp-checkin ----------------------------------------------- -usage: onap subscription-create +usage: onap vsp-checkin -Create a subscription of a customer for given service in specific cloud region in Onap +Checkin Vendor Software Product -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --customer-name] [-z | --cloud-name] [-r | --cloud-region] - [-c | --cloud-tenant-id] [-e | --service-type] [-u | --onap-username] + [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-h | --help] [-v | --version] [-d | --debug] [-f | --format] [-s | --long] [-t | --no-title] [-a | --no-auth] where:: - -x | --customer-name Onap customer name. It is of type STRING. - -z | --cloud-name Onap cloud name. It is of type STRING. - -r | --cloud-region Onap cloud region. It is of type STRING. - -c | --cloud-tenant-id Onap cloud tenant id. It is of type STRING. - -e | --service-type Onap service type. It is of type STRING. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Error:: - - On error, it prints :::: - - - -cloud-list ------------------------------------------------ - - -usage: onap cloud-list - -List the configured clouds and Onap service subscriptions - -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] - [-a | --no-auth] - -where:: - + -x | --vsp-id Onap VSP ID. It is of type STRING. + -y | --vsp-version VSP version. It is of type STRING. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable ONAP_USERNAME. @@ -1244,56 +1223,33 @@ where:: 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. - - -Error:: +Error:: On error, it prints :::: -ems-register +[22] vsp-checkout ----------------------------------------------- -usage: onap ems-register +usage: onap vsp-checkout -Register a EMS in Onap +Checkout Vendor Software Product -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-z | --ems-id] [-b | --name] [-c | --type] - [-e | --vendor] [-q | --ems-version] [-g | --url] - [-i | --username] [-j | --password] [-x | --remote-path] - [-u | --onap-username] [-p | --onap-password] [-m | --host-url] - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-a | --no-auth] + [-x | --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:: - -z | --ems-id Onap EMS unique id. It is of type UUID. By - default, it is - fe79d2e4-97d2-4921-8069-0934f0832d56. - -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. + -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. @@ -1326,28 +1282,27 @@ Error:: -ems-show +[23] vsp-checkout ----------------------------------------------- -usage: onap ems-show +usage: onap vsp-checkout -Show the details of configured ems +Checkout Vendor Software Product -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --ems-id] [-u | --onap-username] [-p | --onap-password] - [-m | --host-url] [-h | --help] [-v | --version] - [-d | --debug] [-f | --format] [-s | --long] - [-t | --no-title] [-a | --no-auth] + [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] where:: - -x | --ems-id Onap EMS unique id. It is of type UUID. By - default, it is - 2b6c14a1-e661-46f7-8999-a05125b0e026. + -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. @@ -1374,34 +1329,27 @@ where:: type BOOL. By default, it is false. -Results:: - - name Onap ems name and is of type STRING. - type Onap ems type and is of type STRING. - vendor Onap ems vendor and is of type STRING. - version Onap ems version and is of type STRING. - url Onap ems url and is of type STRING. - username Onap ems username and is of type STRING. - - Error:: On error, it prints :::: -sdnc-list +[24] vsp-create ----------------------------------------------- -usage: onap sdnc-list +usage: onap vsp-create -List the configured sdnc +Create Vendor Software Product -Onap service: aai v11 +Onap service: sdc v1.0 Options:: + [-x | --vsp-name] [-y | --vsp-description] [-z | --vsp-category] + [-b | --vsp-subcategory] [-c | --vsp-license-version] [-e | --vsp-vendor-name] + [-g | --vsp-vendor-id] [-i | --license-agreement-id] [-j | --feature-group-id] [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-h | --help] [-v | --version] [-d | --debug] [-f | --format] [-s | --long] [-t | --no-title] @@ -1409,36 +1357,50 @@ Options:: where:: - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -x | --vsp-name Onap VSP Name. It is of type STRING. + -y | --vsp-description Description for VSP. It is of type STRING. It is + optional. + -z | --vsp-category Category of the VSP. It is of type STRING. It is + optional. By default, it is + resourceNewCategory.generic. + -b | --vsp-subcategory Sub Category of VSP. It is of type STRING. It is + optional. By default, it is + resourceNewCategory.generic.abstract. + -c | --vsp-license-version License version. It is of type STRING. It is + optional. By default, it is 1.0. + -e | --vsp-vendor-name License Model Name. It is of type STRING. + -g | --vsp-vendor-id License Model ID. It is of type STRING. + -i | --license-agreement-id License Agreement ID. It is of type STRING. + -j | --feature-group-id Feature Group ID. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. Results:: - sdnc-id Onap sdnc id and is of type STRING. - resource-version Onap sdnc resource version and is of type STRING. + ID VSP ID and is of type STRING. Error:: @@ -1447,26 +1409,25 @@ Error:: -customer-show +[25] vsp-list ----------------------------------------------- -usage: onap customer-show +usage: onap vsp-list -Lists the registetred customers in Onap +List of the Vendor Software Products -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --customer-name] [-u | --onap-username] [-p | --onap-password] - [-m | --host-url] [-h | --help] [-v | --version] - [-d | --debug] [-f | --format] [-s | --long] - [-t | --no-title] [-a | --no-auth] + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] + [-h | --help] [-v | --version] [-d | --debug] + [-f | --format] [-s | --long] [-t | --no-title] + [-a | --no-auth] where:: - -x | --customer-name Onap customer name. It is of type STRING. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable ONAP_USERNAME. @@ -1495,11 +1456,13 @@ where:: 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. + 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:: @@ -1508,101 +1471,27 @@ Error:: -ems-unregister +[26] vsp-package ----------------------------------------------- -usage: onap ems-unregister +usage: onap vsp-package -Un-register a EMS in Onap +Package Vendor Software Product -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --ems-id] [-y | --resource-version] [-u | --onap-username] + [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-h | --help] [-v | --version] [-d | --debug] [-f | --format] [-s | --long] [-t | --no-title] [-a | --no-auth] where:: - -x | --ems-id Onap EMS unique id. It is of type UUID. By - default, it is - efba894e-20f4-4658-9d43-1f8736188d3d. - -y | --resource-version Onap vim resource version. It is of type STRING. - It is optional. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. 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 :::: - - - -sdnc-register ------------------------------------------------ - - -usage: onap sdnc-register - -Register a SDNC in Onap - -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] - [-a | --no-auth] - -where:: - - -x | --location Onap VIM unique id. It is of type UUID. By - default, it is - 0f283039-a3fd-4fe1-ac14-b8cdb3a20b26. - -y | --sdnc-id Onap SDNC unique id. It is of type UUID. By - default, it is - b112c385-90ad-4eb7-ae6d-1f263925e97e. - -b | --name Onap SDNC name. It is of type STRING. - -c | --type Onap SDNC type. It is of type STRING. - -e | --vendor Onap SDNC vendor. It is of type STRING. - -q | --sdnc-version Onap SDNC version. It is of type STRING. - -g | --ip-address Onap SDNC ip address. It is of type STRING. - -k | --port Onap SDNC port. It is of type STRING. - -r | --protocal Onap SDNC protocal. It is of type STRING. - -i | --username Onap SDNC username. It is of type STRING. - -j | --password Onap SDNC password. It is of type STRING. - -z | --product-name Onap SDNC product-name. It is of type STRING. + -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. @@ -1635,47 +1524,27 @@ Error:: -vim-register +[27] vsp-revert ----------------------------------------------- -usage: onap vim-register +usage: onap vsp-revert -Register a VIM under a given cloud region in Onap +Revert Vendor Software Product -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --cloud-name] [-y | --region-name] [-z | --vim-id] - [-b | --name] [-c | --type] [-e | --vendor] - [-q | --vim-version] [-g | --url] [-i | --username] - [-j | --password] [-k | --ssl-cacert] [-l | --ssl-insecure] - [-n | --cloud-domain] [-o | --default-tenant] [-u | --onap-username] + [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-h | --help] [-v | --version] [-d | --debug] [-f | --format] [-s | --long] [-t | --no-title] [-a | --no-auth] where:: - -x | --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 - e6cd00f7-8787-46cf-a4f2-4ceb779e8420. - -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. + -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. @@ -1708,27 +1577,27 @@ Error:: -vim-list +[28] vsp-show ----------------------------------------------- -usage: onap vim-list +usage: onap vsp-show -List the configured vims +Details of the Vendor Software Product -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --cloud-name] [-y | --region-name] [-u | --onap-username] + [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-h | --help] [-v | --version] [-d | --debug] [-f | --format] [-s | --long] [-t | --no-title] [-a | --no-auth] where:: - -x | --cloud-name Onap cloud name. It is of type STRING. - -y | --region-name Onap region name. It 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. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable ONAP_USERNAME. @@ -1757,16 +1626,14 @@ where:: 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. + 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:: @@ -1775,54 +1642,51 @@ Error:: -vnfm-unregister +[29] vsp-submit ----------------------------------------------- -usage: onap vnfm-unregister +usage: onap vsp-submit -Un-register a VNFM in Onap +Submit Vendor Software Product -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --vnfm-id] [-y | --resource-version] [-u | --onap-username] + [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username] [-p | --onap-password] [-m | --host-url] [-h | --help] [-v | --version] [-d | --debug] [-f | --format] [-s | --long] [-t | --no-title] [-a | --no-auth] where:: - -x | --vnfm-id Onap VNFM unique id. It is of type UUID. By - default, it is - d8a2726f-18a6-4bb1-904f-554a3fb70865. - -y | --resource-version Onap vim resource version. It is of type STRING. - It is optional. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -x | --vsp-id Onap VSP ID. It is of type STRING. + -y | --vsp-version VSP version. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. 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:: @@ -1831,28 +1695,27 @@ Error:: -vnfm-show +[30] vsp-validate ----------------------------------------------- -usage: onap vnfm-show +usage: onap vsp-validate -Show the VNFM in Onap +Validated the uploaded Vendor Software Product -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --vnfm-id] [-u | --onap-username] [-p | --onap-password] - [-m | --host-url] [-h | --help] [-v | --version] - [-d | --debug] [-f | --format] [-s | --long] - [-t | --no-title] [-a | --no-auth] + [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] where:: - -x | --vnfm-id Onap VNFM unique id. It is of type UUID. By - default, it is - 6d13f516-da67-4593-9284-15686ac518cd. + -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. @@ -1881,12 +1744,8 @@ where:: 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. + status Validation status and is of type STRING. + errors Validation messages and is of type JSON. Error:: @@ -1895,30 +1754,27 @@ Error:: -subscription-delete +[31] service-model-certify-request ----------------------------------------------- -usage: onap subscription-delete +usage: onap service-model-certify-request -Delete the subscription for a given customer in Onap +Request the certification of Service model in SDC -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --customer-name] [-y | --service-type] [-g | --resource-version] - [-u | --onap-username] [-p | --onap-password] [-m | --host-url] - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-a | --no-auth] + [-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:: - -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. + -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. @@ -1951,60 +1807,51 @@ Error:: -subscription-list +[32] service-model-certify-start ----------------------------------------------- -usage: onap subscription-list +usage: onap service-model-certify-start -Lists the subscription for a given customer in Onap +Starts the certification of Service model in SDC -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --customer-name] [-u | --onap-username] [-p | --onap-password] + [-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:: - -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. + -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:: @@ -2013,54 +1860,51 @@ Error:: -tenant-create +[33] service-model-checkin ----------------------------------------------- -usage: onap tenant-create +usage: onap service-model-checkin -Create a tenant under given cloud region in Onap +Checkin Service model in SDC -Onap service: aai v11 +Onap service: sdc v1.0 Options:: - [-x | --cloud] [-y | --region] [-z | --tenant-id] - [-r | --tenant-name] [-u | --onap-username] [-p | --onap-password] + [-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:: - -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. + -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:: @@ -2069,92 +1913,39 @@ Error:: -service-delete +[34] service-model-create ----------------------------------------------- -usage: onap service-delete +usage: onap service-model-create -Delete a service instance +Create Service model in SDC -Onap service: so v2 +Onap service: sdc v1.0 Options:: - [-x | --service-instace-id] [-u | --onap-username] [-p | --onap-password] - [-m | --host-url] [-h | --help] [-v | --version] - [-d | --debug] [-f | --format] [-s | --long] - [-t | --no-title] [-a | --no-auth] + [-x | --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] + [-a | --no-auth] where:: - -x | --service-instace-id unique id for service instance. It is of type - STRING. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. 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 :::: - - - -vnf-create ------------------------------------------------ - - -usage: onap vnf-create - -Create a VNF - -Onap service: mso v2 - -Options:: - - [-l | --lcp-cloudregion-id] [-z | --tenant-id] [-w | --product-family-id] - [-i | --instance-name] [-r | --supress-rollback] [-y | --service-instance-id] - [-x | --parenet-service-model] [-u | --onap-username] [-p | --onap-password] - [-m | --host-url] [-h | --help] [-v | --version] - [-d | --debug] [-f | --format] [-s | --long] - [-t | --no-title] [-a | --no-auth] - -where:: - - -l | --lcp-cloudregion-id AIC LCP node location identifier. It is of type - STRING. - -z | --tenant-id openstack tenant id (uuid). It is of type STRING. - -w | --product-family-id UUID for product family (named service id in - AAI). It is of type STRING. - -i | --instance-name service instance name. It is of type STRING. - -r | --supress-rollback rollback changes if instantiation fails. It is of - type BOOL. It is optional. By default, it is - false. - -y | --service-instance-id unique id for service instance. It is of type - STRING. - -x | --parenet-service-model parent service model name. It is of type STRING. + -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. @@ -2181,62 +1972,62 @@ where:: type BOOL. By default, it is false. +Results:: + + ID Service ID and is of type STRING. + + Error:: On error, it prints :::: -vnf-delete +[35] service-model-distribute ----------------------------------------------- -usage: onap vnf-delete +usage: onap service-model-distribute -delete a VNF +Distributes the Service model in SDC -Onap service: mso v2 +Onap service: sdc v1.0 Options:: - [-x | --vnf-instace-id] [-y | --service-instace-id] [-l | --lcp-cloudregion-id] - [-z | --tenant-id] [-u | --onap-username] [-p | --onap-password] + [-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:: - -x | --vnf-instace-id id for vnf. It is of type STRING. - -y | --service-instace-id unique id for service instance. It is of type - STRING. - -l | --lcp-cloudregion-id AIC LCP node location identifier. It is of type - STRING. - -z | --tenant-id openstack tenant id (uuid). It is of type STRING. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -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:: @@ -2245,57 +2036,58 @@ Error:: -service-create +[36] service2vf-model-list ----------------------------------------------- -usage: onap service-create +usage: onap service2vf-model-list -Create a service instance using MSO +List the VF in a given service model in SDC -Onap service: mso v2 +Onap service: sdc v1.0 Options:: - [-c | --global-subscriber-id] [-b | --subscriber-name] [-i | --instance-name] - [-r | --supress-rollback] [-u | --onap-username] [-p | --onap-password] + [-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:: - -c | --global-subscriber-id unique id for customer. It is of type STRING. - -b | --subscriber-name subscriber name. It is of type STRING. It is - optional. - -i | --instance-name service instance name. It is of type STRING. - -r | --supress-rollback rollback changes if instantiation fails. It is of - type BOOL. It is optional. By default, it is - false. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -z | --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:: + + 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:: @@ -2304,57 +2096,50 @@ Error:: -vf-module-delete +[37] vf-model-certify-complete ----------------------------------------------- -usage: onap vf-module-delete +usage: onap vf-model-certify-complete -delete a VF module +Complete certifying Virtual function -Onap service: mso v2 +Onap service: sdc v1.0 Options:: - [-x | --vnf-instace-id] [-y | --service-instace-id] [-w | --vf-module-id] - [-l | --lcp-cloudregion-id] [-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] + [-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:: - -x | --vnf-instace-id id for vnf. It is of type STRING. - -y | --service-instace-id unique id for service instance. It is of type - STRING. - -w | --vf-module-id vf module id. It is of type STRING. - -l | --lcp-cloudregion-id AIC LCP node location identifier. It is of type - STRING. - -z | --tenant-id openstack tenant id (uuid). It is of type STRING. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -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:: @@ -2363,62 +2148,50 @@ Error:: -vf-module-create +[38] vf-model-certify-request ----------------------------------------------- -usage: onap vf-module-create +usage: onap vf-model-certify-request -Create a VF Module +Request for certifying Virtual function -Onap service: mso v2 +Onap service: sdc v1.0 Options:: - [-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 | --onap-username] [-p | --onap-password] + [-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:: - -l | --lcp-cloudregion-id AIC LCP node location identifier. It is of type - STRING. - -w | --tenant-id openstack tenant id (uuid). It is of type STRING. - -y | --vnf-instace-id vnf instance id. It is of type STRING. - -x | --service-instace-id unique id for service instance. It is of type - STRING. - -z | --parenet-service-model parent service model name. It is of type STRING. - -r | --supress-rollback rollback changes if instantiation fails. It is of - type BOOL. It is optional. By default, it is - false. - -i | --instance-name service instance name. It is of type STRING. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -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:: @@ -2427,61 +2200,50 @@ Error:: -onap-1.0 -========================== - - -license-model-create +[39] vf-model-certify-start ----------------------------------------------- -usage: onap license-model-create +usage: onap vf-model-certify-start -Create License Model +Start certifying Virtual function Onap service: sdc v1.0 Options:: - [-x | --vendor-name] [-y | --license-model-description] [-u | --onap-username] - [-p | --onap-password] [-m | --host-url] [-h | --help] - [-v | --version] [-d | --debug] [-f | --format] - [-s | --long] [-t | --no-title] [-a | --no-auth] + [-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:: - -x | --vendor-name vendor name. It is of type STRING. - -y | --license-model-description Description for License Model. It is of type - STRING. It is optional. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - ID License Model ID and is of type STRING. + -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:: @@ -2490,72 +2252,50 @@ Error:: -vsp-create +[40] vf-model-checkin ----------------------------------------------- -usage: onap vsp-create +usage: onap vf-model-checkin -Create Vendor Software Product +Checkin Virtual function Onap service: sdc v1.0 Options:: - [-x | --vsp-name] [-y | --vsp-description] [-null | --vsp-category] - [-null | --vsp-subcategory] [-null | --vsp-license-version] [-null | --vsp-vendor-name] - [-null | --vsp-vendor-id] [-null | --license-agreement-id] [-null | --feature-group-id] - [-u | --onap-username] [-p | --onap-password] [-m | --host-url] - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-a | --no-auth] + [-b | --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:: - -x | --vsp-name Onap VSP Name. It is of type STRING. - -y | --vsp-description Description for VSP. It is of type STRING. It is - optional. - -null | --vsp-category Category of the VSP. It is of type STRING. It is - optional. By default, it is - resourceNewCategory.generic. - -null | --vsp-subcategory Sub Category of VSP. It is of type STRING. It is - optional. By default, it is - resourceNewCategory.generic.abstract. - -null | --vsp-license-version License version. It is of type STRING. It is - optional. By default, it is 1.0. - -null | --vsp-vendor-name License Model Name. It is of type STRING. - -null | --vsp-vendor-id License Model ID. It is of type STRING. - -null | --license-agreement-id License Agreement ID. It is of type STRING. - -null | --feature-group-id Feature Group ID. It is of type STRING. - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. 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. + -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:: @@ -2564,25 +2304,32 @@ Error:: -vsp-list +[41] vf-model-create ----------------------------------------------- -usage: onap vsp-list +usage: onap vf-model-create -List of the Vendor Software Products +Create Virtual function from Vendor Software Product 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] - [-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:: + -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. @@ -2611,8 +2358,7 @@ where:: Results:: - ID VSP ID and is of type STRING. - name VSP Name and is of type STRING. + ID VF ID and is of type STRING. Error:: @@ -2621,26 +2367,25 @@ Error:: -vsp-show +[42] vf-model-list ----------------------------------------------- -usage: onap vsp-show +usage: onap vf-model-list -Details of the Vendor Software Product +List the VF resource model in SDC Onap service: sdc v1.0 Options:: - [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password] - [-m | --host-url] [-h | --help] [-v | --version] - [-d | --debug] [-f | --format] [-s | --long] - [-t | --no-title] [-a | --no-auth] + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] + [-h | --help] [-v | --version] [-d | --debug] + [-f | --format] [-s | --long] [-t | --no-title] + [-a | --no-auth] where:: - -x | --vsp-id Onap VSP ID. It is of type STRING. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable ONAP_USERNAME. @@ -2669,9 +2414,14 @@ where:: 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. + 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. + 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:: @@ -2680,26 +2430,26 @@ Error:: -vsp-submit +[43] vf2vfmodule-model-list ----------------------------------------------- -usage: onap vsp-submit +usage: onap vf2vfmodule-model-list -Submit Vendor Software Product +List the VF modules in a given VF model in SDC Onap service: sdc v1.0 Options:: - [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password] + [-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:: - -x | --vsp-id Onap VSP ID. It is of type STRING. + -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. @@ -2726,57 +2476,3250 @@ where:: type BOOL. By default, it is false. +Results:: + + vsp-uuid VSP uuid and is of type STRING. + vsp-version VSP version and is of type STRING. + module-uuid UUID and is of type STRING. + module-invariant-uuid Invariant UUID and is of type STRING. + module-name name and is of type STRING. + module-version version and is of type STRING. + + Error:: On error, it prints :::: -vsp-upload +[44] vlm-aggreement-create ----------------------------------------------- -usage: onap vsp-upload +usage: onap vlm-aggreement-create -Upload the CSAR file to VSP +Create license aggreement Onap service: sdc v1.0 Options:: - [-x | --vsp-id] [-y | --vsp-file] [-u | --onap-username] - [-p | --onap-password] [-m | --host-url] [-h | --help] - [-v | --version] [-d | --debug] [-f | --format] - [-s | --long] [-t | --no-title] [-a | --no-auth] + [-x | --name] [-y | --vlm-id] [-e | --vlm-version] + [-z | --description] [-g | --vlm-feature-group-id] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --name aggreement name. It is of type STRING. + -y | --vlm-id License Model ID. It is of type STRING. + -e | --vlm-version License Model version. It is of type STRING. + -z | --description Description for aggreement. It is of type STRING. + -g | --vlm-feature-group-id VLM feature group. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + ID aggreement ID and is of type STRING. + + +Error:: + + On error, it prints :::: + + + +[45] vlm-aggreement-list +----------------------------------------------- + + +usage: onap vlm-aggreement-list + +List license aggreement + +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 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:: + + On error, it prints :::: + + + +[46] vlm-checkin +----------------------------------------------- + + +usage: onap vlm-checkin + +Checkin Vendor License Model + +Onap service: sdc v1.0 + +Options:: + + [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --vlm-id Onap VLM ID. It is of type STRING. + -y | --vlm-version VLM version. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. 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 :::: + + + +[47] cloud-create +----------------------------------------------- + + +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:: + + On error, it prints :::: + + + +[48] cloud-delete +----------------------------------------------- + + +usage: onap cloud-delete + +Delete a cloud region from Onap + +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] + [-a | --no-auth] + +where:: + + -x | --cloud-name Onap cloud name. It is of type STRING. + -y | --region-name Onap cloud region name. It is of type STRING. + -z | --resource-version Onap cloud region version. It is of type UUID. It + is optional. By default, it is + 87f6a216-22d6-4cf1-921d-0eec5face723. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. 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 :::: + + + +[49] cloud-list +----------------------------------------------- + + +usage: onap cloud-list + +List the configured clouds and Onap service subscriptions + +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] + [-a | --no-auth] + +where:: + + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + cloud Onap cloud and is of type STRING. + region Onap cloud region and is of type STRING. + tenant Onap cloud tenat and is of type STRING. + tenant-id Onap cloud tenat id and is of type STRING. + customer Onap cloud customer and is of type STRING. + service Onap cloud service and is of type STRING. + resource-version Onap cloud resource version and is of type STRING. + + +Error:: + + On error, it prints :::: + + + +[50] customer-create +----------------------------------------------- + + +usage: onap customer-create + +Create a customer in Onap + +Onap service: aai v11 + +Options:: + + [-x | --customer-name] [-y | --subscriber-name] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --customer-name Onap customer name. It is of type STRING. + -y | --subscriber-name Onap subscriber name. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Error:: + + On error, it prints :::: + + + +[51] customer-delete +----------------------------------------------- + + +usage: onap customer-delete + +Delete a customer from Onap + +Onap service: aai v11 + +Options:: + + [-x | --customer-name] [-y | --resource-version] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --customer-name Onap customer name. It is of type STRING. + -y | --resource-version Onap customer resource version. It is of type + UUID. It is optional. By default, it is + 8dac4609-db84-4122-a000-1e319cc92487. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. 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 :::: + + + +[52] customer-list +----------------------------------------------- + + +usage: onap customer-list + +Lists the registetred customers in Onap + +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] + [-a | --no-auth] + +where:: + + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + name Onap customer name and is of type STRING. + resource-version Onap customer resource version and is of type + STRING. + + +Error:: + + On error, it prints :::: + + + +[53] customer-show +----------------------------------------------- + + +usage: onap customer-show + +Lists the registetred customers in Onap + +Onap service: aai v11 + +Options:: + + [-x | --customer-name] [-u | --onap-username] [-p | --onap-password] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --customer-name Onap customer name. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + name Onap customer name and is of type STRING. + subscriber-name Onap subscriber name and is of type STRING. + resource-version Onap subscriber resource version and is of type + STRING. + subscriber-type Onap subscriber type and is of type STRING. + + +Error:: + + On error, it prints :::: + + + +[54] ems-register +----------------------------------------------- + + +usage: onap ems-register + +Register a EMS in Onap + +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] + [-a | --no-auth] + +where:: + + -z | --ems-id Onap EMS unique id. It is of type UUID. By + default, it is + 601d366b-b449-474d-9019-a3fafa6de93c. + -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:: + + On error, it prints :::: + + + +[55] ems-unregister +----------------------------------------------- + + +usage: onap ems-unregister + +Un-register a EMS in Onap + +Onap service: aai v11 + +Options:: + + [-x | --ems-id] [-y | --resource-version] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --ems-id Onap EMS unique id. It is of type UUID. By + default, it is + f52c603d-1ed5-4c49-baff-a119e8a38e5a. + -y | --resource-version Onap vim resource version. It is of type STRING. + It is optional. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Error:: + + On error, it prints :::: + + + +[56] 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] + [-a | --no-auth] + +where:: + + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + ems-id Onap ems id and is of type STRING. + resource-version Onap ems resource version and is of type STRING. + + +Error:: + + On error, it prints :::: + + + +[57] ems-show +----------------------------------------------- + + +usage: onap ems-show + +Show the details of configured ems + +Onap service: aai v11 + +Options:: + + [-x | --ems-id] [-u | --onap-username] [-p | --onap-password] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --ems-id Onap EMS unique id. It is of type UUID. By + default, it is + 900b32e3-f6af-4b54-bacb-bd1a10e1941a. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + name Onap ems name and is of type STRING. + type Onap ems type and is of type STRING. + vendor Onap ems vendor and is of type STRING. + version Onap ems version and is of type STRING. + url Onap ems url and is of type STRING. + username Onap ems username and is of type STRING. + + +Error:: + + On error, it prints :::: + + + +[58] sdnc-register +----------------------------------------------- + + +usage: onap sdnc-register + +Register a SDNC in Onap + +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] + [-a | --no-auth] + +where:: + + -x | --location Onap VIM unique id. It is of type UUID. By + default, it is + 9b3dafd4-adb9-4d3d-ad7b-f60ab345a713. + -y | --sdnc-id Onap SDNC unique id. It is of type UUID. By + default, it is + 3c08d1ec-957f-49b1-abdb-1ca8f8ac2682. + -b | --name Onap SDNC name. It is of type STRING. + -c | --type Onap SDNC type. It is of type STRING. + -e | --vendor Onap SDNC vendor. It is of type STRING. + -q | --sdnc-version Onap SDNC version. It is of type STRING. + -g | --ip-address Onap SDNC ip address. It is of type STRING. + -k | --port Onap SDNC port. It is of type STRING. + -r | --protocal Onap SDNC protocal. It is of type STRING. + -i | --username Onap SDNC username. It is of type STRING. + -j | --password Onap SDNC password. It is of type STRING. + -z | --product-name Onap SDNC product-name. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Error:: + + On error, it prints :::: + + + +[59] sdnc-unregister +----------------------------------------------- + + +usage: onap sdnc-unregister + +Un-register a VNFM in Onap + +Onap service: aai v11 + +Options:: + + [-x | --sdnc-id] [-u | --onap-username] [-p | --onap-password] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --sdnc-id Onap VNFM unique id. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Error:: + + On error, it prints :::: + + + +[60] sdnc-list +----------------------------------------------- + + +usage: onap sdnc-list + +List the configured sdnc + +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] + [-a | --no-auth] + +where:: + + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + sdnc-id Onap sdnc id and is of type STRING. + resource-version Onap sdnc resource version and is of type STRING. + + +Error:: + + On error, it prints :::: + + + +[61] vim-register +----------------------------------------------- + + +usage: onap vim-register + +Register a VIM under a given cloud region in Onap + +Onap service: aai v11 + +Options:: + + [-x | --cloud-name] [-y | --region-name] [-z | --vim-id] + [-b | --name] [-c | --type] [-e | --vendor] + [-q | --vim-version] [-g | --url] [-i | --username] + [-j | --password] [-k | --ssl-cacert] [-l | --ssl-insecure] + [-n | --cloud-domain] [-o | --default-tenant] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --cloud-name Onap cloud name. It is of type STRING. + -y | --region-name Onap region name. It is of type STRING. + -z | --vim-id Onap VIM unique id. It is of type UUID. By + default, it is + 9a1f740c-1b54-44a8-9c1f-9d2450c63444. + -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:: + + On error, it prints :::: + + + +[62] vim-unregister +----------------------------------------------- + + +usage: onap vim-unregister + +Un-register a VIM under from cloud region in Onap + +Onap service: aai v11 + +Options:: + + [-x | --cloud-name] [-y | --region-name] [-z | --vim-id] + [-b | --resource-version] [-u | --onap-username] [-p | --onap-password] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --cloud-name Onap cloud name. It is of type STRING. + -y | --region-name Onap region name. It is of type STRING. + -z | --vim-id Onap VIM unique id. It is of type UUID. By + default, it is + d8671575-365d-41bc-ab85-dddbf3504dbd. + -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:: + + On error, it prints :::: + + + +[63] vim-list +----------------------------------------------- + + +usage: onap vim-list + +List the configured vims + +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 :::: + + + +[64] vnfm-register +----------------------------------------------- + + +usage: onap vnfm-register + +Register a VNFM in Onap + +Onap service: aai v11 + +Options:: + + [-x | --vim-id] [-y | --vnfm-id] [-b | --name] + [-c | --type] [-e | --vendor] [-q | --vnfm-version] + [-g | --url] [-i | --username] [-j | --password] + [-z | --certificate-url] [-u | --onap-username] [-p | --onap-password] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --vim-id Onap VIM unique id. It is of type UUID. By + default, it is + 7eb03bc7-ba8c-4018-a387-217acf76875d. + -y | --vnfm-id Onap VNFM unique id. It is of type UUID. By + default, it is + bbc5abbc-8899-4f98-b9a7-5d36b02498eb. + -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:: + + On error, it prints :::: + + + +[65] vnfm-unregister +----------------------------------------------- + + +usage: onap vnfm-unregister + +Un-register a VNFM in Onap + +Onap service: aai v11 + +Options:: + + [-x | --vnfm-id] [-y | --resource-version] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --vnfm-id Onap VNFM unique id. It is of type UUID. By + default, it is + 711af302-5db6-4520-a158-4940806520a6. + -y | --resource-version Onap vim resource version. It is of type STRING. + It is optional. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Error:: + + On error, it prints :::: + + + +[66] vnfm-list +----------------------------------------------- + + +usage: onap vnfm-list + +List the configured vnfm + +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] + [-a | --no-auth] + +where:: + + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + vnfm-id Onap vnfm id and is of type STRING. + vim-id Onap vnfm id and is of type STRING. + certificate-url Onap vnfm certificate-url and is of type STRING. + resource-version Onap vnfm resource version and is of type STRING. + + +Error:: + + On error, it prints :::: + + + +[67] vnfm-show +----------------------------------------------- + + +usage: onap vnfm-show + +Show the VNFM in Onap + +Onap service: aai v11 + +Options:: + + [-x | --vnfm-id] [-u | --onap-username] [-p | --onap-password] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --vnfm-id Onap VNFM unique id. It is of type UUID. By + default, it is + 8d373e37-6818-4894-95ba-7644041c66ba. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. 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. + + +Error:: + + On error, it prints :::: + + + +[68] service-list +----------------------------------------------- + + +usage: onap service-list + +List created service instance + +Onap service: aai v11 + +Options:: + + [-x | --customer-name] [-y | --service-type] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --customer-name customer name. It is of type STRING. + -y | --service-type service subscription type. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +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. + + +Error:: + + On error, it prints :::: + + + +[69] vf-list +----------------------------------------------- + + +usage: onap vf-list + +List created VF instances for a service instance + +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] + [-a | --no-auth] + +where:: + + -x | --customer-name customer name. It is of type STRING. + -y | --service-type service subscription type. It is of type STRING. + -z | --service-id service ID. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. 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. + + +Error:: + + On error, it prints :::: + + + +[70] vf-show +----------------------------------------------- + + +usage: onap vf-show + +Show details for VF + +Onap service: aai v11 + +Options:: + + [-x | --vf-id] [-u | --onap-username] [-p | --onap-password] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --vf-id VF identifier. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + vf-id VF ID for the given service and is of type STRING. + vf-name VF name and is of type STRING. + vf-type VF name and is of type STRING. + model-invariant-id VF name and is of type STRING. + model-uuid model uuid and is of type STRING. + model-customization-id Model customization id and is of type STRING. + service-id Service ID of parent service and is of type + STRING. + + +Error:: + + On error, it prints :::: + + + +[71] service-type-create +----------------------------------------------- + + +usage: onap service-type-create + +Add a service type in Onap + +Onap service: aai v11 + +Options:: + + [-x | --service-type] [-y | --service-type-id] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --service-type Onap service type. It is of type STRING. + -y | --service-type-id Onap service type uuid. It is of type UUID. It is + optional. By default, it is + 25bdc1fa-5058-40a5-927a-a1970d91ea27. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. 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 :::: + + + +[72] service-type-delete +----------------------------------------------- + + +usage: onap service-type-delete + +Delete a service type from Onap + +Onap service: aai v11 + +Options:: + + [-x | --service-type-id] [-y | --resource-version] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --service-type-id Onap service type uuid. It is of type UUID. It is + optional. By default, it is + 62672986-656e-4d8f-89a2-44505a41c75c. + -y | --resource-version Onap service resource version. It is of type + UUID. It is optional. By default, it is + 2eacdccb-8995-48db-ae43-a17c092c68b8. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. 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 :::: + + + +[73] service-type-list +----------------------------------------------- + + +usage: onap service-type-list + +List the service types configured in Onap + +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] + [-a | --no-auth] + +where:: + + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + service-type-id Onap cloud service and is of type STRING. + service-type Onap cloud service and is of type STRING. + resource-version Onap cloud service resource version and is of + type STRING. + + +Error:: + + On error, it prints :::: + + + +[74] subscription-create +----------------------------------------------- + + +usage: onap subscription-create + +Create a subscription of a customer for given service in specific cloud region in Onap + +Onap service: aai v11 + +Options:: + + [-x | --customer-name] [-z | --cloud-name] [-r | --cloud-region] + [-c | --cloud-tenant-id] [-e | --service-type] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --customer-name Onap customer name. It is of type STRING. + -z | --cloud-name Onap cloud name. It is of type STRING. + -r | --cloud-region Onap cloud region. It is of type STRING. + -c | --cloud-tenant-id Onap cloud tenant id. It is of type STRING. + -e | --service-type Onap service type. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Error:: + + On error, it prints :::: + + + +[75] subscription-delete +----------------------------------------------- + + +usage: onap subscription-delete + +Delete the subscription for a given customer in Onap + +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] + [-a | --no-auth] + +where:: + + -x | --customer-name Onap customer name. It is of type STRING. + -y | --service-type Onap subscribtion id. It is of type STRING. + -g | --resource-version Onap subscription resource version. It is of type + STRING. It is optional. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Error:: + + On error, it prints :::: + + + +[76] subscription-list +----------------------------------------------- + + +usage: onap subscription-list + +Lists the subscription for a given customer in Onap + +Onap service: aai v11 + +Options:: + + [-x | --customer-name] [-u | --onap-username] [-p | --onap-password] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --customer-name Onap customer name. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + service-type Onap service type and is of type STRING. + resource-version Onap subscription resource version and is of type + STRING. + tenant Onap tenant name and is of type STRING. + region Onap region name and is of type STRING. + cloud Onap cloud name and is of type STRING. + + +Error:: + + On error, it prints :::: + + + +[77] tenant-create +----------------------------------------------- + + +usage: onap tenant-create + +Create a tenant under given cloud region in Onap + +Onap service: aai v11 + +Options:: + + [-x | --cloud] [-y | --region] [-z | --tenant-id] + [-r | --tenant-name] [-u | --onap-username] [-p | --onap-password] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --cloud Onap cloud. It is of type STRING. + -y | --region Onap cloud region. It is of type STRING. + -z | --tenant-id Onap cloud tenant id. It is of type STRING. + -r | --tenant-name Onap cloud tenant name. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Error:: + + On error, it prints :::: + + + +[78] tenant-delete +----------------------------------------------- + + +usage: onap tenant-delete + +Delete tenant under given cloud region in Onap + +Onap service: aai v11 + +Options:: + + [-x | --cloud] [-y | --region] [-z | --tenant-id] + [-r | --resource-version] [-u | --onap-username] [-p | --onap-password] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --cloud Onap cloud. It is of type STRING. + -y | --region Onap cloud region. It is of type STRING. + -z | --tenant-id Onap cloud tenant id. It is of type STRING. + -r | --resource-version Onap cloud tenant version. It is of type UUID. It + is optional. By default, it is + f971b569-5fdd-40ff-91ff-de6d3c589910. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. 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 :::: + + + +[79] tenant-list +----------------------------------------------- + + +usage: onap tenant-list + +Lists the tenants under given cloud region in Onap + +Onap service: aai v11 + +Options:: + + [-x | --cloud] [-y | --region] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --cloud Onap cloud. It is of type STRING. + -y | --region Onap cloud region. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + tenant-id Onap tenant-id and is of type STRING. + tenant-name Onap tenant name and is of type STRING. + resource-version Onap tenant resource version and is of type + STRING. + + +Error:: + + On error, it prints :::: + + + +[80] vf-create +----------------------------------------------- + + +usage: onap vf-create + +Create a VF + +Onap service: mso v3 + +Options:: + + [-l | --cloud-region] [-z | --tenant-id] [-w | --product-family] + [-i | --instance-name] [-y | --service-instance-id] [-null | --vf-model-invariant-id] + [-null | --vf-model-uuid] [-null | --vf-model-name] [-null | --vf-model-version] + [-null | --vf-model-customization-id] [-null | --service-model-invariant-id] [-null | --service-model-uuid] + [-null | --service-model-name] [-null | --service-model-version] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -l | --cloud-region cloud region identifier. It is of type STRING. + -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. + -i | --instance-name service instance name. It is of type STRING. + -y | --service-instance-id unique id for service instance. It is of type + STRING. + -null | --vf-model-invariant-id vf model invariant id. It is of type STRING. + -null | --vf-model-uuid model uuid for vf. It is of type STRING. + -null | --vf-model-name vf model name. It is of type STRING. + -null | --vf-model-version vf model version. It is of type STRING. + -null | --vf-model-customization-id vf model customization id. It is of type STRING. + -null | --service-model-invariant-id model invariant id. It is of type STRING. + -null | --service-model-uuid model name version id. It is of type STRING. + -null | --service-model-name service model name. It is of type STRING. + -null | --service-model-version service model version. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + vf-id id for the created vnf and is of type STRING. + + +Error:: + + On error, it prints :::: + + + +[81] vf-module-delete +----------------------------------------------- + + +usage: onap vf-module-delete + +delete a VF module + +Onap service: mso v2 + +Options:: + + [-x | --vnf-instace-id] [-y | --service-instace-id] [-w | --vf-module-id] + [-l | --lcp-cloudregion-id] [-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:: + + -x | --vnf-instace-id id for vnf. It is of type STRING. + -y | --service-instace-id unique id for service instance. It is of type + STRING. + -w | --vf-module-id vf module id. It is of type STRING. + -l | --lcp-cloudregion-id AIC LCP node location identifier. It is of type + STRING. + -z | --tenant-id openstack tenant id (uuid). It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. 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 :::: + + + +[82] vfmodule-create +----------------------------------------------- + + +usage: onap vfmodule-create + +Create a VF module + +Onap service: mso v3 + +Options:: + + [-l | --cloud-region] [-z | --tenant-id] [-null | --vfmodule-invariant-id] + [-null | --vfmodule-uuid] [-null | --vfmodule-name] [-null | --vfmodule-version] + [-i | --module-name] [-null | --service-id] [-y | --vf-id] + [-null | --vf-model-invariant-id] [-null | --vf-model-uuid] [-null | --vf-model-name] + [-null | --vf-model-version] [-null | --vf-model-customization-id] [-null | --service-model-invariant-id] + [-null | --service-model-uuid] [-null | --service-model-name] [-null | --service-model-version] + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] + [-h | --help] [-v | --version] [-d | --debug] + [-f | --format] [-s | --long] [-t | --no-title] + [-a | --no-auth] + +where:: + + -l | --cloud-region cloud region identifier. It is of type STRING. + -z | --tenant-id openstack tenant id. It is of type STRING. + -null | --vfmodule-invariant-id vfmodule model invariant id. It is of type STRING. + -null | --vfmodule-uuid model uuid for vfmodule. It is of type STRING. + -null | --vfmodule-name vfmodule model name. It is of type STRING. + -null | --vfmodule-version vf module version. It is of type STRING. + -i | --module-name vfmodule name. It is of type STRING. + -null | --service-id unique id for service. It is of type STRING. + -y | --vf-id unique id for related VF. It is of type STRING. + -null | --vf-model-invariant-id vf model invariant id. It is of type STRING. + -null | --vf-model-uuid model uuid for vf. It is of type STRING. + -null | --vf-model-name vf model name. It is of type STRING. + -null | --vf-model-version vf model version. It is of type STRING. + -null | --vf-model-customization-id vf model customization id. It is of type STRING. + -null | --service-model-invariant-id model invariant id. It is of type STRING. + -null | --service-model-uuid model name version id. It is of type STRING. + -null | --service-model-name service model name. It is of type STRING. + -null | --service-model-version service model version. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + vfmodule-id id for the created vnf and is of type STRING. + + +Error:: + + On error, it prints :::: + + + +[83] vf-delete +----------------------------------------------- + + +usage: onap vf-delete + +delete a VF + +Onap service: mso v3 + +Options:: + + [-x | --vf-id] [-y | --service-instance-id] [-l | --cloud-region] + [-z | --tenant-id] [-null | --model-invariant-id] [-null | --model-uuid] + [-null | --model-name] [-null | --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:: + + -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. + -null | --model-invariant-id model invariant id for service in SDC catalog. It + is of type STRING. + -null | --model-uuid model uuid for service in SDC catalog. It is of + type STRING. + -null | --model-name model name available in SDC catalog. It is of + type STRING. + -null | --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:: + + On error, it prints :::: + + + +[84] service-create +----------------------------------------------- + + +usage: onap service-create + +Create a service instance using MSO + +Onap service: mso v3 + +Options:: + + [-null | --cloud-region] [-null | --tenant-id] [-null | --model-invariant-id] + [-null | --model-uuid] [-null | --model-name] [-null | --model-version] + [-c | --customer] [-i | --instance-name] [-r | --supress-rollback] + [-null | --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:: + + -null | --cloud-region cloud region identifier. It is of type STRING. + -null | --tenant-id tenant id. It is of type STRING. + -null | --model-invariant-id model invariant id generated by ASDC. It is of + type STRING. + -null | --model-uuid model uuid generated by ASDC. It is of type + STRING. + -null | --model-name model name as provided in ASDC design time. It is + of type STRING. + -null | --model-version model-version. It is of type STRING. + -c | --customer unique id for customer. It is of type STRING. + -i | --instance-name service instance name. It is of type STRING. + -r | --supress-rollback rollback changes if instantiation fails. It is of + type BOOL. It is optional. By default, it is + false. + -null | --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:: + + On error, it prints :::: + + + +[85] service-delete +----------------------------------------------- + + +usage: onap service-delete + +Delete service instance + +Onap service: mso v3 + +Options:: + + [-x | --service-instace-id] [-null | --model-invariant-id] [-null | --model-uuid] + [-null | --model-name] [-null | --model-version] [-c | --customer-name] + [-null | --cloud-region] [-null | --tenant-id] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --service-instace-id unique id for service instance. It is of type + STRING. + -null | --model-invariant-id model invariant id for service in SDC catalog. It + is of type STRING. + -null | --model-uuid model uuid for service in SDC catalog. It is of + type STRING. + -null | --model-name model name available in SDC catalog. It is of + type STRING. + -null | --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. + -null | --cloud-region cloud region id. It is of type STRING. + -null | --tenant-id tenant id. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Error:: + + On error, it prints :::: + + + +onap-1.0 +========================== + + +[1] vsp-checkin +----------------------------------------------- + + +usage: onap vsp-checkin + +Checkin Vendor Software Product + +Onap service: sdc v1.0 + +Options:: + + [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --vsp-id Onap VSP ID. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Error:: + + On error, it prints :::: + + + +[2] vsp-create +----------------------------------------------- + + +usage: onap vsp-create + +Create Vendor Software Product + +Onap service: sdc v1.0 + +Options:: + + [-x | --vsp-name] [-y | --vsp-description] [-null | --vsp-category] + [-null | --vsp-subcategory] [-null | --vlm-version] [-null | --vlm-vendor] + [-null | --vlm-id] [-null | --vlm-agreement-id] [-null | --vlm-feature-group-id] + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] + [-h | --help] [-v | --version] [-d | --debug] + [-f | --format] [-s | --long] [-t | --no-title] + [-a | --no-auth] + +where:: + + -x | --vsp-name Onap VSP Name. It is of type STRING. + -y | --vsp-description Description for VSP. It is of type STRING. It is + optional. + -null | --vsp-category Category of the VSP. It is of type STRING. It is + optional. By default, it is + resourceNewCategory.generic. + -null | --vsp-subcategory Sub Category of VSP. It is of type STRING. It is + optional. By default, it is + resourceNewCategory.generic.abstract. + -null | --vlm-version License version. It is of type STRING. It is + optional. By default, it is 1.0. + -null | --vlm-vendor License Model Name. It is of type STRING. + -null | --vlm-id License Model ID. It is of type STRING. + -null | --vlm-agreement-id License Agreement ID. It is of type STRING. + -null | --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:: + + On error, it prints :::: + + + +[3] vsp-list +----------------------------------------------- + + +usage: onap vsp-list + +List of the Vendor Software Products + +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] + [-a | --no-auth] + +where:: + + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + ID VSP ID and is of type STRING. + name VSP Name and is of type STRING. + + +Error:: + + On error, it prints :::: + + + +[4] vsp-show +----------------------------------------------- + + +usage: onap vsp-show + +Details of the Vendor Software Product + +Onap service: sdc v1.0 + +Options:: + + [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --vsp-id Onap VSP ID. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +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:: + + On error, it prints :::: + + + +[5] vsp-submit +----------------------------------------------- + + +usage: onap vsp-submit + +Submit Vendor Software Product + +Onap service: sdc v1.0 + +Options:: + + [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --vsp-id Onap VSP ID. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Error:: + + On error, it prints :::: + + + +[6] vsp-upload +----------------------------------------------- + + +usage: onap vsp-upload + +Upload the CSAR file to VSP + +Onap service: sdc v1.0 + +Options:: + + [-x | --vsp-id] [-y | --vsp-file] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --vsp-id Onap VSP ID. It is of type STRING. + -y | --vsp-file CSAR File path. It is of type BINARY. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Error:: + + On error, it prints :::: + + + +[7] ep-create +----------------------------------------------- + + +usage: onap ep-create + +Create Entitlement Pool + +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] + [-a | --no-auth] + +where:: + + -x | --ep-name Entitlement Pool name. It is of type STRING. + -y | --license-model-id License Model ID. It is of type STRING. + -z | --ep-description Description for Entitlement Pool. It is of type + STRING. + -q | --threshold-value threshold. It is of type STRING. + -b | --threshold-unit threshold. It is of type STRING. + -c | --entitlement-metric Entitlement Metric. It is of type STRING. + -e | --aggregation-function Aggregation Function. It is of type STRING. + -g | --operational-scope Operational Scope. It is of type STRING. + -k | --reference-number Reference Number. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + ID Entitlement Pool ID and is of type STRING. + + +Error:: + + On error, it prints :::: + + + +[8] ep-show +----------------------------------------------- + + +usage: onap ep-show + +Details of the Entitlement Pool + +Onap service: sdc v1.0 + +Options:: + + [-x | --license-model-id] [-y | --pool-id] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --license-model-id Onap License Model ID. It is of type STRING. + -y | --pool-id Onap Entitlement Pool ID. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + name Entitlement Pool Name and is of type STRING. + ID Entitlement Pool ID and is of type STRING. + description Description for the Entitlement Pool and is of + type STRING. + + +Error:: + + On error, it prints :::: + + + +[9] license-group-create +----------------------------------------------- + + +usage: onap license-group-create + +Create License Group + +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] + [-a | --no-auth] + +where:: + + -x | --group-name group name. It is of type STRING. + -y | --license-model-id License Model ID. It is of type STRING. + -z | --license-group-description Description for License Group. It is of type + STRING. It is optional. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + ID License Group ID and is of type STRING. + + +Error:: + + On error, it prints :::: + + + +[10] license-group-show +----------------------------------------------- + + +usage: onap license-group-show + +Details of the License Group + +Onap service: sdc v1.0 + +Options:: + + [-x | --license-model-id] [-y | --license-group-id] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --license-model-id Onap License Model ID. It is of type STRING. + -y | --license-group-id Onap License Group ID. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + name License Group Name and is of type STRING. + ID License Group ID and is of type STRING. + description Description for the License Group and is of type + STRING. + + +Error:: + + On error, it prints :::: + + + +[11] license-model-create +----------------------------------------------- + + +usage: onap license-model-create + +Create License Model + +Onap service: sdc v1.0 + +Options:: + + [-x | --vendor-name] [-y | --license-model-description] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --vendor-name vendor name. It is of type STRING. + -y | --license-model-description Description for License Model. It is of type + STRING. It is optional. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + -where:: +Results:: - -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. + ID License Model ID and is of type STRING. Error:: @@ -2785,7 +5728,7 @@ Error:: -license-model-show +[12] license-model-show ----------------------------------------------- @@ -2846,26 +5789,25 @@ Error:: -vsp-checkin +[13] cloud-list ----------------------------------------------- -usage: onap vsp-checkin +usage: onap cloud-list -Checkin Vendor Software Product +List the configured clouds and Onap service subscriptions -Onap service: sdc v1.0 +Onap service: aai v8 Options:: - [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password] - [-m | --host-url] [-h | --help] [-v | --version] - [-d | --debug] [-f | --format] [-s | --long] - [-t | --no-title] [-a | --no-auth] + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] + [-h | --help] [-v | --version] [-d | --debug] + [-f | --format] [-s | --long] [-t | --no-title] + [-a | --no-auth] where:: - -x | --vsp-id Onap VSP ID. It is of type STRING. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable ONAP_USERNAME. @@ -2892,13 +5834,23 @@ where:: 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. + + Error:: On error, it prints :::: -customer-create +[14] customer-create ----------------------------------------------- @@ -2951,7 +5903,7 @@ Error:: -customer-delete +[15] customer-delete ----------------------------------------------- @@ -2973,7 +5925,7 @@ where:: -x | --customer-name Onap customer name. It is of type STRING. -y | --resource-version Onap customer resource version. It is of type UUID. It is optional. By default, it is - 143d035b-d9ce-4082-bdad-6f1a8ce808b6. + b4afbd15-39ff-47a8-b243-cdd6e747740c. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable ONAP_USERNAME. @@ -3006,11 +5958,11 @@ Error:: -customer-show +[16] customer-list ----------------------------------------------- -usage: onap customer-show +usage: onap customer-list Lists the registetred customers in Onap @@ -3018,14 +5970,13 @@ Onap service: aai v8 Options:: - [-x | --customer-name] [-u | --onap-username] [-p | --onap-password] - [-m | --host-url] [-h | --help] [-v | --version] - [-d | --debug] [-f | --format] [-s | --long] - [-t | --no-title] [-a | --no-auth] + [-u | --onap-username] [-p | --onap-password] [-m | --host-url] + [-h | --help] [-v | --version] [-d | --debug] + [-f | --format] [-s | --long] [-t | --no-title] + [-a | --no-auth] where:: - -x | --customer-name Onap customer name. It is of type STRING. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable ONAP_USERNAME. @@ -3055,10 +6006,8 @@ where:: 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 + resource-version Onap customer resource version and is of type STRING. - subscriber-type Onap subscriber type and is of type STRING. Error:: @@ -3067,13 +6016,13 @@ Error:: -subscription-list +[17] customer-show ----------------------------------------------- -usage: onap subscription-list +usage: onap customer-show -Lists the subscription for a given customer in Onap +Lists the registetred customers in Onap Onap service: aai v8 @@ -3113,67 +6062,13 @@ where:: type BOOL. By default, it is false. -Results:: - - service-type Onap service type and is of type STRING. - - -Error:: - - On error, it prints :::: - - - -customer-list ------------------------------------------------ - - -usage: onap customer-list - -Lists the registetred customers in Onap - -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] - [-a | --no-auth] - -where:: - - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - Results:: name Onap customer name and is of type STRING. - resource-version Onap customer resource version and is of type + 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:: @@ -3182,68 +6077,7 @@ Error:: -cloud-list ------------------------------------------------ - - -usage: onap cloud-list - -List the configured clouds and Onap service subscriptions - -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] - [-a | --no-auth] - -where:: - - -u | --onap-username Onap user name. It is of type STRING. By default, - it is read from environment variable - ONAP_USERNAME. - -p | --onap-password Onap user password. It is of type STRING. By - default, it is read from environment variable - ONAP_PASSWORD. Secured. - -m | --host-url Onap host url. It is of type URL. By default, it - is read from environment variable ONAP_HOST_URL. - -h | --help Onap command help message. It is of type STRING. - By default, it is false. - -v | --version Onap command service version. It is of type - STRING. By default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - 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:: - - On error, it prints :::: - - - -service-type-create +[18] service-type-create ----------------------------------------------- @@ -3265,7 +6099,7 @@ where:: -x | --service-type Onap service type. It is of type STRING. -y | --service-type-id Onap service type uuid. It is of type UUID. It is optional. By default, it is - e1d759b2-e62f-4c88-b613-5e545bfa3048. + 9c690339-7600-4682-bb64-eedfa173425e. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable ONAP_USERNAME. @@ -3298,7 +6132,7 @@ Error:: -service-type-delete +[19] service-type-delete ----------------------------------------------- @@ -3319,10 +6153,10 @@ where:: -x | --service-type-id Onap service type uuid. It is of type UUID. It is optional. By default, it is - c1321122-aa00-49ca-85ec-390b824ca531. + 34009a67-d99d-454a-95d3-dbd1f512f2e3. -y | --resource-version Onap service resource version. It is of type UUID. It is optional. By default, it is - 1739b97a-f987-4498-bab4-ae2026e627dc. + 95c1ea1b-02ea-40f8-9bfc-f476cd90dbb6. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable ONAP_USERNAME. @@ -3355,7 +6189,7 @@ Error:: -service-type-list +[20] service-type-list ----------------------------------------------- @@ -3414,7 +6248,7 @@ Error:: -subscription-create +[21] subscription-create ----------------------------------------------- @@ -3478,11 +6312,68 @@ Error:: +[22] subscription-list +----------------------------------------------- + + +usage: onap subscription-list + +Lists the subscription for a given customer in Onap + +Onap service: aai v8 + +Options:: + + [-x | --customer-name] [-u | --onap-username] [-p | --onap-password] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --customer-name Onap customer name. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. + + +Results:: + + service-type Onap service type and is of type STRING. + + +Error:: + + On error, it prints :::: + + + cli-1.0 ========================== -schema-validate +[1] schema-validate ----------------------------------------------- @@ -3531,7 +6422,7 @@ Error:: -schema-refresh +[2] schema-refresh ----------------------------------------------- @@ -3576,5 +6467,3 @@ Results:: Error:: On error, it prints :::: - - -- cgit 1.2.3-korg