diff options
| -rw-r--r-- | docs/cmd_help.rst | 8524 | ||||
| -rw-r--r-- | docs/cookbook.rst | 4 |
2 files changed, 4704 insertions, 3824 deletions
diff --git a/docs/cmd_help.rst b/docs/cmd_help.rst index f23e8349..1937869c 100644 --- a/docs/cmd_help.rst +++ b/docs/cmd_help.rst @@ -13,13 +13,13 @@ open-cli ========================== -[1] basic-logout +[1] basic-login ----------------------------------------------- -usage: oclip basic-logout +usage: oclip basic-login -basic logout auth command +basic login auth command Product: open-cli Service: basic-auth @@ -27,379 +27,340 @@ Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-m | --host-url] - -where:: - - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - - -Error:: - - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[2] catalog ------------------------------------------------ - - -usage: oclip catalog - -cli catalog command to find the base path for service. - -Product: open-cli -Service: catalog -Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com - -Options:: - - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-l | --catalog-service-name] [-i | --catalog-service-version] [-m | --host-url] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-u | --host-username] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -l | --catalog-service-name service name registered in catalog service. It is - of type STRING. - -i | --catalog-service-version service version registered in catalog service. It - is of type STRING. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Results:: - catalog-service-host-url Service connection url and is of type STRING. - catalog-service-base-path service base path, to append with host-url for - connecting the service. and is of type STRING. + Authorization Authorization and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[3] schema-refresh +[2] basic-logout ----------------------------------------------- -usage: oclip schema-refresh +usage: oclip basic-logout -Oclip command to refresh schemas stored in open-cli-schema folders. +basic logout auth command Product: open-cli -Service: schema +Service: basic-auth Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - - -Results:: - - sr.no Serial Number and is of type STRING. - command Command name and is of type STRING. - product Command product version and is of type STRING. - schema Schema name and is of type STRING. - ocs-version Schema version and is of type STRING. - type Command type and is of type STRING. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[4] schema-validate +[3] catalog ----------------------------------------------- -usage: oclip schema-validate +usage: oclip catalog -Oclip command to validate schema +cli catalog command to find the base path for service. Product: open-cli -Service: schema +Service: catalog Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-l | --schema-location] [-i | --internal-schema] [-b | --ocs-version] + [-m | --host-url] [-C | --no-catalog] [-l | --catalog-service-name] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-s | --long] [-D | --context] [-i | --catalog-service-version] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -l | --schema-location Schema file location. It is of type URL. - -i | --internal-schema Validate existing schema file. It is of type - BOOL. By default, it is false. - -b | --ocs-version OCS version. It is of type STRING. It is - optional. By default, it is 1.0. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -l | --catalog-service-name service name registered in catalog service. It is + of type STRING. By default, it is . + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -i | --catalog-service-version service version registered in catalog service. It + is of type STRING. By default, it is . Results:: - sl-no Serial Number of error and is of type STRING. - error Schema validation error and is of type STRING. + catalog-service-host-url Service connection url and is of type STRING. + catalog-service-base-path service base path, to append with host-url for + connecting the service. and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[5] basic-login +[4] sample-test-verify ----------------------------------------------- -usage: oclip basic-login +usage: oclip sample-test-verify -basic login auth command +Oclip sample command to test the command features Product: open-cli -Service: basic-auth -Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com +Service: test +Author: null Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Results:: - Authorization Authorization and is of type STRING. + cloud Onap cloud and is of type STRING. + region Onap cloud region and is of type STRING. + tenant Onap cloud tenat and is of type STRING. + tenant-id Onap cloud tenat id and is of type STRING. + customer Onap cloud customer and is of type STRING. + service Onap cloud service and is of type STRING. + resource-version Onap cloud resource version and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -onap-amsterdam -========================== -[1] catalog +[5] schema-refresh ----------------------------------------------- -usage: oclip catalog +usage: oclip schema-refresh -ONAP catalog command to find the base path for service. +Oclip command to refresh schemas stored in open-cli-schema folders. -Product: onap-amsterdam -Service: msb -Author: ONAP CLI Team onap-discuss@lists.onap.org +Product: open-cli +Service: schema +Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-l | --catalog-service-name] [-i | --catalog-service-version] [-m | --host-url] + [-s | --long] [-D | --context] [-h | --help] + [-f | --format] [-t | --no-title] [-v | --version] + [-d | --debug] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -l | --catalog-service-name service name registered in catalog service. It is - of type STRING. - -i | --catalog-service-version service version registered in catalog service. It - is of type STRING. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. Results:: - catalog-service-host-url Service connection url and is of type STRING. - catalog-service-base-path service base path, to append with host-url for - connecting the service. and is of type STRING. + sr.no Serial Number and is of type STRING. + command Command name and is of type STRING. + product Command product version and is of type STRING. + schema Schema name and is of type STRING. + ocs-version Schema version and is of type STRING. + type Command type and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[2] sdc-basic-login +[6] schema-validate ----------------------------------------------- -usage: oclip sdc-basic-login +usage: oclip schema-validate -ONAP basic login auth command +Oclip command to validate schema -Product: onap-amsterdam -Service: sdc-basic-auth -Author: ONAP CLI Team onap-discuss@lists.onap.org +Product: open-cli +Service: schema +Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-s | --long] [-D | --context] [-h | --help] + [-f | --format] [-t | --no-title] [-b | --ocs-version] + [-v | --version] [-d | --debug] [-l | --schema-location] + [-i | --internal-schema] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -b | --ocs-version OCS version. It is of type STRING. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -l | --schema-location Schema file location. It is of type URL. By + default, it is . + -i | --internal-schema Validate existing schema file. It is of type BOOL. Results:: - Authorization Authorization and is of type STRING. - X-TransactionId X-TransactionId and is of type STRING. - X-FromAppId X-FromAppId and is of type STRING. - USER_ID USER_ID for sdc and is of type STRING. + sl-no Serial Number of error and is of type STRING. + error Schema validation error and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + +onap-amsterdam +========================== + -[3] basic-login +[1] basic-login ----------------------------------------------- @@ -413,38 +374,41 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-u | --host-username] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Results:: @@ -456,11 +420,11 @@ Results:: Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[4] basic-logout +[2] basic-logout ----------------------------------------------- @@ -474,794 +438,860 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-m | --host-url] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[5] service-delete +[3] catalog ----------------------------------------------- -usage: oclip service-delete +usage: oclip catalog -Delete service instance (experimental) +ONAP catalog command to find the base path for service. Product: onap-amsterdam -Service: so +Service: msb Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --service-instace-id] [-b | --model-invariant-id] [-i | --model-uuid] - [-e | --model-name] [-g | --model-version] [-c | --customer-name] - [-j | --cloud-region] [-k | --tenant-id] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-l | --catalog-service-name] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-s | --long] [-D | --context] [-i | --catalog-service-version] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --service-instace-id unique id for service instance. It is of type - STRING. - -b | --model-invariant-id model invariant id for service in SDC catalog. It - is of type STRING. - -i | --model-uuid model uuid for service in SDC catalog. It is of - type STRING. - -e | --model-name model name available in SDC catalog. It is of - type STRING. - -g | --model-version model version of service (eg. 1.0). It is of type - STRING. - -c | --customer-name unique id for customer. It is of type STRING. - -j | --cloud-region cloud region id. It is of type STRING. - -k | --tenant-id tenant id. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -l | --catalog-service-name service name registered in catalog service. It is + of type STRING. By default, it is . + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -i | --catalog-service-version service version registered in catalog service. It + is of type STRING. By default, it is . + + +Results:: + + catalog-service-host-url Service connection url and is of type STRING. + catalog-service-base-path service base path, to append with host-url for + connecting the service. and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[6] vf-module-create +[4] cloud-create ----------------------------------------------- -usage: oclip vf-module-create +usage: oclip cloud-create -Create a VF Module +Create a cloud region in Onap Product: onap-amsterdam -Service: so +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-l | --lcp-cloudregion-id] [-w | --tenant-id] [-y | --vnf-instace-id] - [-x | --service-instace-id] [-z | --parenet-service-model] [-r | --supress-rollback] - [-i | --instance-name] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --cloud-name] + [-s | --long] [-D | --context] [-y | --region-name] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -l | --lcp-cloudregion-id AIC LCP node location identifier. It is of type - STRING. - -w | --tenant-id openstack tenant id (uuid). It is of type STRING. - -y | --vnf-instace-id vnf instance id. It is of type STRING. - -x | --service-instace-id unique id for service instance. It is of type - STRING. - -z | --parenet-service-model parent service model name. It is of type STRING. - -r | --supress-rollback rollback changes if instantiation fails. It is of - type BOOL. It is optional. By default, it is - false. - -i | --instance-name service instance name. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --cloud-name Onap cloud name. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --region-name Onap region name. It is of type STRING. By + default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[7] vfmodule-delete +[5] cloud-delete ----------------------------------------------- -usage: oclip vfmodule-delete +usage: oclip cloud-delete -delete a VF module (experimental) +Delete a cloud region from Onap Product: onap-amsterdam -Service: so +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vfmodule-id] [-j | --service-id] [-y | --vf-id] - [-k | --vf-model-invariant-id] [-e | --vfmodule-name] [-g | --vfmodule-version] - [-l | --cloud-region] [-z | --tenant-id] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --cloud-name] + [-z | --resource-version] [-s | --long] [-D | --context] + [-y | --region-name] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vfmodule-id VF module Id. It is of type STRING. - -j | --service-id unique id for service. It is of type STRING. - -y | --vf-id unique id for related VF. It is of type STRING. - -k | --vf-model-invariant-id vf model invariant id. It is of type STRING. - -e | --vfmodule-name vfmodule model name. It is of type STRING. - -g | --vfmodule-version vf module version. It is of type STRING. - -l | --cloud-region cloud region identifier. It is of type STRING. - -z | --tenant-id openstack tenant id. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --cloud-name Onap cloud name. It is of type STRING. By + default, it is . + -z | --resource-version Onap cloud region version. It is of type UUID. It + is optional. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --region-name Onap cloud region name. It is of type STRING. By + default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[8] vfmodule-create +[6] cloud-list ----------------------------------------------- -usage: oclip vfmodule-create +usage: oclip cloud-list -Create a VF module +List the configured clouds and Onap service subscriptions Product: onap-amsterdam -Service: so +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-l | --cloud-region] [-B | --tenant-id] [-b | --vfmodule-invariant-id] - [-c | --vfmodule-uuid] [-e | --vfmodule-name] [-g | --vfmodule-version] - [-i | --module-name] [-j | --service-id] [-y | --vf-id] - [-k | --vf-model-invariant-id] [-A | --vf-model-uuid] [-n | --vf-model-name] - [-o | --vf-model-version] [-q | --vf-model-customization-id] [-r | --service-model-invariant-id] - [-w | --service-model-uuid] [-x | --service-model-name] [-z | --service-model-version] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -l | --cloud-region cloud region identifier. It is of type STRING. - -B | --tenant-id openstack tenant id. It is of type STRING. - -b | --vfmodule-invariant-id vfmodule model invariant id. It is of type STRING. - -c | --vfmodule-uuid model uuid for vfmodule. It is of type STRING. - -e | --vfmodule-name vfmodule model name. It is of type STRING. - -g | --vfmodule-version vf module version. It is of type STRING. - -i | --module-name vfmodule name. It is of type STRING. - -j | --service-id unique id for service. It is of type STRING. - -y | --vf-id unique id for related VF. It is of type STRING. - -k | --vf-model-invariant-id vf model invariant id. It is of type STRING. - -A | --vf-model-uuid model uuid for vf. It is of type STRING. - -n | --vf-model-name vf model name. It is of type STRING. - -o | --vf-model-version vf model version. It is of type STRING. - -q | --vf-model-customization-id vf model customization id. This can be obtained - using SDC portal (Home -> service:xxx -> - Composition -> click on VF for customization id). - It is of type STRING. - -r | --service-model-invariant-id model invariant id. It is of type STRING. - -w | --service-model-uuid model name version id. It is of type STRING. - -x | --service-model-name service model name. It is of type STRING. - -z | --service-model-version service model version. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Results:: - vfmodule-id id for the created vnf and is of type STRING. + cloud Onap cloud and is of type STRING. + region Onap cloud region and is of type STRING. + tenant Onap cloud tenat and is of type STRING. + tenant-id Onap cloud tenat id and is of type STRING. + customer Onap cloud customer and is of type STRING. + service Onap cloud service and is of type STRING. + resource-version Onap cloud resource version and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[9] vf-create +[7] customer-create ----------------------------------------------- -usage: oclip vf-create +usage: oclip customer-create -Create a VF +Create a customer in Onap Product: onap-amsterdam -Service: so +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-l | --cloud-region] [-z | --tenant-id] [-w | --product-family] - [-o | --instance-name] [-y | --service-instance-id] [-b | --vf-model-invariant-id] - [-c | --vf-model-uuid] [-e | --vf-model-name] [-g | --vf-model-version] - [-i | --vf-model-customization-id] [-j | --service-model-invariant-id] [-k | --service-model-uuid] - [-q | --service-model-name] [-n | --service-model-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-y | --subscriber-name] [-C | --no-catalog] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-x | --customer-name] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -l | --cloud-region cloud region identifier. It is of type STRING. - -z | --tenant-id openstack tenant id. It is of type STRING. - -w | --product-family service type for serivce (e.g. vLB). It is of - type STRING. - -o | --instance-name service instance name. It is of type STRING. - -y | --service-instance-id unique id for service instance. It is of type - STRING. - -b | --vf-model-invariant-id vf model invariant id. It is of type STRING. - -c | --vf-model-uuid model uuid for vf. It is of type STRING. - -e | --vf-model-name vf model name. It is of type STRING. - -g | --vf-model-version vf model version. It is of type STRING. - -i | --vf-model-customization-id vf model customization id. It is of type STRING. - -j | --service-model-invariant-id model invariant id. It is of type STRING. - -k | --service-model-uuid model name version id. It is of type STRING. - -q | --service-model-name service model name. It is of type STRING. - -n | --service-model-version service model version. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -y | --subscriber-name Onap subscriber name. It is of type STRING. By + default, it is . + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --customer-name Onap customer name. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. -Results:: +Error:: - vf-id id for the created vnf and is of type STRING. + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + + +[8] customer-delete +----------------------------------------------- + + +usage: oclip customer-delete + +Delete a customer from Onap + +Product: onap-amsterdam +Service: aai +Author: ONAP CLI Team onap-discuss@lists.onap.org + +Options:: + + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --customer-name] + [-y | --resource-version] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] + +where:: + + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --customer-name Onap customer name. It is of type STRING. By + default, it is . + -y | --resource-version Onap customer resource version. It is of type + UUID. It is optional. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[10] service-create +[9] customer-list ----------------------------------------------- -usage: oclip service-create +usage: oclip customer-list -Create a service instance using MSO +Lists the registered customers in Onap Product: onap-amsterdam -Service: so +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-l | --cloud-region] [-b | --tenant-id] [-e | --model-invariant-id] - [-g | --model-uuid] [-i | --model-name] [-j | --model-version] - [-c | --customer] [-k | --instance-name] [-r | --supress-rollback] - [-w | --service-type] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -l | --cloud-region cloud region identifier. It is of type STRING. - -b | --tenant-id tenant id. It is of type STRING. - -e | --model-invariant-id model invariant id generated by ASDC. It is of - type STRING. - -g | --model-uuid model uuid generated by ASDC. It is of type - STRING. - -i | --model-name model name as provided in ASDC design time. It is - of type STRING. - -j | --model-version model-version. It is of type STRING. - -c | --customer unique id for customer. It is of type STRING. - -k | --instance-name service instance name. It is of type STRING. - -r | --supress-rollback rollback changes if instantiation fails. It is of - type BOOL. It is optional. By default, it is - false. - -w | --service-type subscription service type. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Results:: - service-id instance id for the created service. and is of - type STRING. + name Onap customer name and is of type STRING. + resource-version Onap customer resource version and is of type + STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[11] vf-delete +[10] customer-show ----------------------------------------------- -usage: oclip vf-delete +usage: oclip customer-show -delete a VF (experimental) +Retrieves the given registered customer in Onap Product: onap-amsterdam -Service: so +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vf-id] [-y | --service-instance-id] [-l | --cloud-region] - [-z | --tenant-id] [-b | --model-invariant-id] [-c | --model-uuid] - [-e | --model-name] [-g | --model-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --customer-name] + [-s | --long] [-D | --context] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vf-id id for vnf. It is of type STRING. - -y | --service-instance-id unique id for service instance. It is of type - STRING. - -l | --cloud-region Cloud region ID. It is of type STRING. - -z | --tenant-id openstack tenant id (uuid). It is of type STRING. - -b | --model-invariant-id model invariant id for service in SDC catalog. It - is of type STRING. - -c | --model-uuid model uuid for service in SDC catalog. It is of - type STRING. - -e | --model-name model name available in SDC catalog. It is of - type STRING. - -g | --model-version model version of service (eg. 1.0). It is of type - STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --customer-name Onap customer name. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + + +Results:: + + name Onap customer name and is of type STRING. + subscriber-name Onap subscriber name and is of type STRING. + resource-version Onap subscriber resource version and is of type + STRING. + subscriber-type Onap subscriber type and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[12] service-model-add-vf +[11] ems-list ----------------------------------------------- -usage: oclip service-model-add-vf +usage: oclip ems-list -Helps to add VF into service models in SDC +List the configured ems Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --service-model-id] [-y | --vf-id] [-z | --vf-name] - [-b | --vf-version] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --service-model-id Onap Service Name. It is of type STRING. - -y | --vf-id VF ID. It is of type STRING. It is optional. - -z | --vf-name VF ID. It is of type STRING. It is optional. - -b | --vf-version VF version. It is of type STRING. It is optional. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Results:: - ID Service ID and is of type STRING. + ems-id Onap ems id and is of type STRING. + resource-version Onap ems resource version and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[13] vsp-revert +[12] ems-register ----------------------------------------------- -usage: oclip vsp-revert +usage: oclip ems-register -Revert Vendor Software Product +Register a EMS in Onap Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-e | --vendor] [-v | --version] [-d | --debug] + [-c | --type] [-s | --long] [-D | --context] + [-q | --ems-version] [-b | --name] [-i | --username] + [-j | --password] [-u | --host-username] [-g | --url] + [-x | --remote-path] [-a | --no-auth] [-z | --ems-id] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -e | --vendor Onap EMS vendor. It is of type STRING. By + default, it is . + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -c | --type Onap EMS type. It is of type STRING. By default, + it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vsp-id Onap VSP ID. It is of type STRING. - -y | --vsp-version VSP version. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -q | --ems-version Onap EMS version. It is of type STRING. By + default, it is . + -b | --name Onap EMS name. It is of type STRING. By default, + it is . + -i | --username Onap EMS username. It is of type STRING. By + default, it is . + -j | --password Onap EMS password. It is of type STRING. By + default, it is . -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -g | --url Onap EMS URL. It is of type STRING. By default, + it is . + -x | --remote-path Onap EMS remote-path. It is of type STRING. By + default, it is . + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -z | --ems-id Onap EMS unique id. It is of type UUID. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[14] vsp-validate +[13] ems-show ----------------------------------------------- -usage: oclip vsp-validate +usage: oclip ems-show -Validated the uploaded Vendor Software Product +Show the details of configured ems Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --ems-id] + [-s | --long] [-D | --context] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --ems-id Onap EMS unique id. It is of type UUID. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vsp-id Onap VSP ID. It is of type STRING. - -y | --vsp-version VSP version. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Results:: - status Validation status and is of type STRING. - errors Validation messages and is of type JSON. + name Onap ems name and is of type STRING. + type Onap ems type and is of type STRING. + vendor Onap ems vendor and is of type STRING. + version Onap ems version and is of type STRING. + url Onap ems url and is of type STRING. + username Onap ems username and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[15] service-model-approve +[14] ems-unregister ----------------------------------------------- -usage: oclip service-model-approve +usage: oclip ems-unregister -Approves the Service model in SDC +Un-register a EMS in Onap Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-b | --service-model-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-y | --resource-version] + [-x | --ems-id] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -y | --resource-version Onap vim resource version. It is of type STRING. + It is optional. By default, it is . + -x | --ems-id Onap EMS unique id. It is of type UUID. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -b | --service-model-id Service model ID. It is of type STRING. It is + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[16] service-model-certify-start +[15] ep-create ----------------------------------------------- -usage: oclip service-model-certify-start +usage: oclip ep-create -Starts the certification of Service model in SDC +Create Entitlement Pool Product: onap-amsterdam Service: sdc @@ -1269,55 +1299,85 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-b | --service-model-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-b | --threshold-unit] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-x | --ep-name] [-k | --reference-number] [-g | --operational-scope] + [-c | --entitlement-metric] [-z | --ep-description] [-s | --long] + [-D | --context] [-e | --aggregation-function] [-y | --license-model-id] + [-u | --host-username] [-a | --no-auth] [-q | --threshold-value] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -b | --service-model-id Service model ID. It is of type STRING. It is - optional. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -b | --threshold-unit threshold. It is of type STRING. By default, it + is . + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --ep-name Entitlement Pool name. It is of type STRING. By + default, it is . + -k | --reference-number Reference Number. It is of type STRING. By + default, it is . + -g | --operational-scope Operational Scope. It is of type STRING. By + default, it is . + -c | --entitlement-metric Entitlement Metric. It is of type STRING. By + default, it is . + -z | --ep-description Description for Entitlement Pool. It is of type + STRING. By default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -e | --aggregation-function Aggregation Function. It is of type STRING. By + default, it is . + -y | --license-model-id License Model ID. It is of type STRING. By + default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -q | --threshold-value threshold. It is of type STRING. By default, it + is . + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + + +Results:: + + ID Entitlement Pool ID and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[17] service-model-checkin +[16] ep-show ----------------------------------------------- -usage: oclip service-model-checkin +usage: oclip ep-show -Checkin Service model in SDC +Details of the Entitlement Pool Product: onap-amsterdam Service: sdc @@ -1325,55 +1385,71 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-b | --service-model-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-x | --license-model-id] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] [-y | --pool-id] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -b | --service-model-id Service model ID. It is of type STRING. It is + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is optional. + -x | --license-model-id Onap License Model ID. It is of type STRING. By + default, it is . -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -y | --pool-id Onap Entitlement Pool ID. It is of type STRING. + By default, it is . + + +Results:: + + name Entitlement Pool Name and is of type STRING. + ID Entitlement Pool ID and is of type STRING. + description Description for the Entitlement Pool and is of + type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[18] service-model-create +[17] license-group-create ----------------------------------------------- -usage: oclip service-model-create +usage: oclip license-group-create -Create Service model in SDC +Create License Group Product: onap-amsterdam Service: sdc @@ -1381,72 +1457,71 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --name] [-y | --description] [-z | --project-code] - [-b | --category] [-c | --category-display-name] [-e | --icon-id] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-z | --license-group-description] + [-x | --group-name] [-s | --long] [-D | --context] + [-y | --license-model-id] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --name Onap Service Name. It is of type STRING. - -y | --description Description for Service. It is of type STRING. It - is optional. - -z | --project-code Project code. It is of type STRING. It is - optional. - -b | --category Service category. It is of type STRING. It is - optional. By default, it is network l1-3. - -c | --category-display-name Service category display name. It is of type - STRING. It is optional. By default, it is Network - L1-3. - -e | --icon-id Service Icon id. It is of type STRING. It is - optional. By default, it is defaulticon. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -z | --license-group-description Description for License Group. It is of type + STRING. It is optional. By default, it is . + -x | --group-name group name. It is of type STRING. By default, it + is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --license-model-id License Model ID. It is of type STRING. By + default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Results:: - ID Service ID and is of type STRING. + ID License Group ID and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[19] service-model-checkout +[18] license-group-show ----------------------------------------------- -usage: oclip service-model-checkout +usage: oclip license-group-show -Checkout Service model in SDC +Details of the License Group Product: onap-amsterdam Service: sdc @@ -1454,55 +1529,71 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-b | --service-model-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-x | --license-model-id] [-y | --license-group-id] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -b | --service-model-id Service model ID. It is of type STRING. It is + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is optional. + -x | --license-model-id Onap License Model ID. It is of type STRING. By + default, it is . + -y | --license-group-id Onap License Group ID. It is of type STRING. By + default, it is . -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + + +Results:: + + name License Group Name and is of type STRING. + ID License Group ID and is of type STRING. + description Description for the License Group and is of type + STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[20] service-model-certify-request +[19] license-model-create ----------------------------------------------- -usage: oclip service-model-certify-request +usage: oclip license-model-create -Request the certification of Service model in SDC +Create License Model Product: onap-amsterdam Service: sdc @@ -1510,55 +1601,68 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-b | --service-model-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-y | --license-model-description] + [-s | --long] [-D | --context] [-x | --vendor-name] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -b | --service-model-id Service model ID. It is of type STRING. It is - optional. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -y | --license-model-description Description for License Model. It is of type + STRING. It is optional. By default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -x | --vendor-name vendor name. It is of type STRING. By default, it + is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + + +Results:: + + ID License Model ID and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[21] service-model-revert +[20] license-model-show ----------------------------------------------- -usage: oclip service-model-revert +usage: oclip license-model-show -Checkout Service model in SDC +Details of the License Model Product: onap-amsterdam Service: sdc @@ -1566,657 +1670,862 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-b | --service-model-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-x | --license-model-id] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -b | --service-model-id Service model ID. It is of type STRING. It is + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is optional. + -x | --license-model-id Onap License Model ID. It is of type STRING. By + default, it is . -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + + +Results:: + + name License Model Name and is of type STRING. + ID License Model ID and is of type STRING. + description Description for the License Model and is of type + STRING. + status Status of the License Model and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[22] service-model-distribute +[21] microservice-create ----------------------------------------------- -usage: oclip service-model-distribute +usage: oclip microservice-create -Distributes the Service model in SDC +Register microservice into Onap Product: onap-amsterdam -Service: sdc +Service: msb Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-b | --service-model-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + <create-or-update> [-v | --version] [-d | --debug] + [-c | --path] [-y | --service-version] <node-ip> + [-s | --long] [-D | --context] <node-port> + [-x | --service-name] [-r | --service-url] [-b | --enable-ssl] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + create-or-update Onap service create or update. It is of type BOOL. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -c | --path Onap service path. It is of type STRING. It is + optional. By default, it is . + -y | --service-version Onap service version. It is of type STRING. By + default, it is . + node-ip Onap service running node IP. It is of type + STRING. By default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -b | --service-model-id Service model ID. It is of type STRING. It is + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is optional. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. + node-port Onap service running node port. It is of type + STRING. By default, it is . + -x | --service-name Onap service name. It is of type STRING. By + default, it is . + -r | --service-url Onap service base url. It is of type URL. By + default, it is . + -b | --enable-ssl Onap service is enabled with https or not. It is + of type STRING. It is optional. By default, it is + . + + +Results:: + + name Onap service name and is of type STRING. + version Onap service version and is of type STRING. + url Onap service base url and is of type URL. + status Onap service status and is of type DIGIT. + nodes Onap service running nodes and is of type STRING. + enable-ssl Onap service is enabled with https or not and is + of type STRING. + path Onap service path and is of type STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + + +[22] microservice-delete +----------------------------------------------- + + +usage: oclip microservice-delete + +Deletes the micro service from Onap + +Product: onap-amsterdam +Service: msb +Author: ONAP CLI Team onap-discuss@lists.onap.org + +Options:: + + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-y | --service-version] + [-s | --long] [-D | --context] [-x | --service-name] + [-i | --node-ip] [-r | --node-port] + +where:: + -m | --host-url host url in http(s). It is of type URL. By default, it is read from environment variable OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -y | --service-version Onap service version. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -x | --service-name Onap service name. It is of type STRING. By + default, it is . + -i | --node-ip Onap service running node IP. It is of type + STRING. By default, it is . + -r | --node-port Onap service running node port. It is of type + STRING. By default, it is . Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[23] service-model-list +[23] microservice-list ----------------------------------------------- -usage: oclip service-model-list +usage: oclip microservice-list -List the service model in SDC +Lists the registetred micro services in Onap Product: onap-amsterdam -Service: sdc +Service: msb Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. Results:: - 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. + 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 <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[24] service2vf-model-list +[24] microservice-show ----------------------------------------------- -usage: oclip service2vf-model-list +usage: oclip microservice-show -List the VF in a given service model in SDC +Details the registered microservice in Onap Product: onap-amsterdam -Service: sdc +Service: msb Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-z | --service-model-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-y | --service-version] + [-s | --long] [-D | --context] [-x | --service-name] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -z | --service-model-id Service model uuid. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. -m | --host-url host url in http(s). It is of type URL. By default, it is read from environment variable OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -y | --service-version Onap service version. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -x | --service-name Onap service name. It is of type STRING. By + default, it is . Results:: - 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. + 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 <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[25] vf-model-certify-complete +[25] sdc-basic-login ----------------------------------------------- -usage: oclip vf-model-certify-complete +usage: oclip sdc-basic-login -Complete certifying Virtual function +ONAP basic login auth command Product: onap-amsterdam -Service: sdc +Service: sdc-basic-auth Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-b | --vf-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-u | --host-username] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -b | --vf-id VF ID. It is of type STRING. It is optional. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + + +Results:: + + Authorization Authorization and is of type STRING. + X-TransactionId X-TransactionId and is of type STRING. + X-FromAppId X-FromAppId and is of type STRING. + USER_ID USER_ID for sdc and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[26] vf-model-certify-request +[26] sdnc-list ----------------------------------------------- -usage: oclip vf-model-certify-request +usage: oclip sdnc-list -Request for certifying Virtual function +List the configured sdnc Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-b | --vf-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -b | --vf-id VF ID. It is of type STRING. It is optional. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + + +Results:: + + sdnc-id Onap sdnc id and is of type STRING. + resource-version Onap sdnc resource version and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[27] vf-model-certify-start +[27] sdnc-register ----------------------------------------------- -usage: oclip vf-model-certify-start +usage: oclip sdnc-register -Start certifying Virtual function +Register a SDNC in Onap Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-b | --vf-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-g | --ip-address] [-h | --help] [-f | --format] + [-t | --no-title] [-V | --verify] [-e | --vendor] + [-v | --version] [-y | --sdnc-id] [-s | --long] + [-b | --name] [-j | --password] [-a | --no-auth] + [-p | --host-password] [-m | --host-url] [-C | --no-catalog] + [-d | --debug] [-k | --port] [-c | --type] + [-q | --sdnc-version] [-D | --context] [-r | --protocal] + [-z | --product-name] [-i | --username] [-u | --host-username] + [-x | --location] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -g | --ip-address Onap SDNC ip address. It is of type STRING. By + default, it is . + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -e | --vendor Onap SDNC vendor. It is of type STRING. By + default, it is . + -v | --version print service version. It is of type BOOL. + -y | --sdnc-id Onap SDNC unique id. It is of type UUID. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -b | --vf-id VF ID. It is of type STRING. It is optional. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. + attributes. It is of type BOOL. + -b | --name Onap SDNC name. It is of type STRING. By default, + it is . + -j | --password Onap SDNC password. It is of type STRING. By + default, it is . + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. -m | --host-url host url in http(s). It is of type URL. By default, it is read from environment variable OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -d | --debug Enable debug output. It is of type BOOL. + -k | --port Onap SDNC port. It is of type STRING. By default, + it is . + -c | --type Onap SDNC type. It is of type STRING. By default, + it is . + -q | --sdnc-version Onap SDNC version. It is of type STRING. By + default, it is . + -D | --context command context. It is of type MAP. It is + optional. + -r | --protocal Onap SDNC protocal. It is of type STRING. By + default, it is . + -z | --product-name Onap SDNC product-name. It is of type STRING. By + default, it is . + -i | --username Onap SDNC username. It is of type STRING. By + default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -x | --location Onap VIM unique id. It is of type UUID. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[28] vf-model-checkin +[28] sdnc-unregister ----------------------------------------------- -usage: oclip vf-model-checkin +usage: oclip sdnc-unregister -Checkin Virtual function +Un-register a VNFM in Onap Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-b | --vf-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --sdnc-id] + [-s | --long] [-D | --context] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --sdnc-id Onap VNFM unique id. It is of type STRING. By + default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -b | --vf-id VF ID. It is of type STRING. It is optional. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[29] vf-model-create +[29] service-create ----------------------------------------------- -usage: oclip vf-model-create +usage: oclip service-create -Create Virtual function from Vendor Software Product +Create a service instance using MSO Product: onap-amsterdam -Service: sdc +Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --name] [-y | --description] [-z | --vendor-name] - [-b | --vsp-id] [-g | --vsp-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-e | --model-invariant-id] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-l | --cloud-region] [-w | --service-type] [-i | --model-name] + [-c | --customer] [-s | --long] [-D | --context] + [-b | --tenant-id] [-k | --instance-name] [-j | --model-version] + [-u | --host-username] [-r | --supress-rollback] [-a | --no-auth] + [-g | --model-uuid] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --name Onap VF Name. It is of type STRING. - -y | --description Description for VF. It is of type STRING. It is - optional. - -z | --vendor-name Vendor name. It is of type STRING. It is optional. - -b | --vsp-id VSP ID. It is of type STRING. It is optional. - -g | --vsp-version VSP version. It is of type STRING. It is optional. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -e | --model-invariant-id model invariant id generated by ASDC. It is of + type STRING. By default, it is . + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -l | --cloud-region cloud region identifier. It is of type STRING. By + default, it is . + -w | --service-type subscription service type. It is of type STRING. + By default, it is . + -i | --model-name model name as provided in ASDC design time. It is + of type STRING. By default, it is . + -c | --customer unique id for customer. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -b | --tenant-id tenant id. It is of type STRING. By default, it + is . + -k | --instance-name service instance name. It is of type STRING. By + default, it is . + -j | --model-version model-version. It is of type STRING. By default, + it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -r | --supress-rollback rollback changes if instantiation fails. It is of + type BOOL. It is optional. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -g | --model-uuid model uuid generated by ASDC. It is of type + STRING. By default, it is . + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Results:: - ID VF ID and is of type STRING. + service-id instance id for the created service. and is of + type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[30] vf-model-list +[30] service-delete ----------------------------------------------- -usage: oclip vf-model-list +usage: oclip service-delete -List the VF resource model in SDC +Delete service instance (experimental) Product: onap-amsterdam -Service: sdc +Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-e | --model-name] [-C | --no-catalog] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-b | --model-invariant-id] [-j | --cloud-region] [-x | --service-instace-id] + [-i | --model-uuid] [-s | --long] [-D | --context] + [-c | --customer-name] [-g | --model-version] [-k | --tenant-id] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - uuid UUID and is of type STRING. - uniqueid UUID and is of type STRING. - invariant-uuid Invariant UUID and is of type STRING. - name Name and is of type STRING. - version version and is of type STRING. - status status and is of type STRING. - description description and is of type STRING. - vsp-uuid VSP uuid and is of type STRING. - vsp-version VSP version and is of type STRING. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -e | --model-name model name available in SDC catalog. It is of + type STRING. By default, it is . + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -b | --model-invariant-id model invariant id for service in SDC catalog. It + is of type STRING. By default, it is . + -j | --cloud-region cloud region id. It is of type STRING. By + default, it is . + -x | --service-instace-id unique id for service instance. It is of type + STRING. By default, it is . + -i | --model-uuid model uuid for service in SDC catalog. It is of + type STRING. By default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -c | --customer-name unique id for customer. It is of type STRING. By + default, it is . + -g | --model-version model version of service (eg. 1.0). It is of type + STRING. By default, it is . + -k | --tenant-id tenant id. It is of type STRING. By default, it + is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[31] vf2vfmodule-model-list +[31] service-list ----------------------------------------------- -usage: oclip vf2vfmodule-model-list +usage: oclip service-list -List the VF modules in a given VF model in SDC +List created service instance Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-z | --vf-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --customer-name] + [-y | --service-type] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --customer-name customer name. It is of type STRING. By default, + it is . + -y | --service-type service subscription type. It is of type STRING. + By default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -z | --vf-id VF uuid. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Results:: - vsp-uuid VSP uuid and is of type STRING. - vsp-version VSP version and is of type STRING. - module-uuid UUID and is of type STRING. - module-invariant-uuid Invariant UUID and is of type STRING. - module-name name and is of type STRING. - module-version version and is of type STRING. + 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 <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[32] ep-create +[32] service-model-add-vf ----------------------------------------------- -usage: oclip ep-create +usage: oclip service-model-add-vf -Create Entitlement Pool +Helps to add VF into service models in SDC Product: onap-amsterdam Service: sdc @@ -2224,71 +2533,73 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --ep-name] [-y | --license-model-id] [-z | --ep-description] - [-q | --threshold-value] [-b | --threshold-unit] [-c | --entitlement-metric] - [-e | --aggregation-function] [-g | --operational-scope] [-k | --reference-number] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --service-model-id] + [-b | --vf-version] [-y | --vf-id] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-z | --vf-name] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --ep-name Entitlement Pool name. It is of type STRING. - -y | --license-model-id License Model ID. It is of type STRING. - -z | --ep-description Description for Entitlement Pool. It is of type - STRING. - -q | --threshold-value threshold. It is of type STRING. - -b | --threshold-unit threshold. It is of type STRING. - -c | --entitlement-metric Entitlement Metric. It is of type STRING. - -e | --aggregation-function Aggregation Function. It is of type STRING. - -g | --operational-scope Operational Scope. It is of type STRING. - -k | --reference-number Reference Number. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --service-model-id Onap Service Name. It is of type STRING. By + default, it is . + -b | --vf-version VF version. It is of type STRING. It is optional. + By default, it is . + -y | --vf-id VF ID. It is of type STRING. It is optional. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -z | --vf-name VF ID. It is of type STRING. It is optional. By + default, it is . + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Results:: - ID Entitlement Pool ID and is of type STRING. + ID Service ID and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[33] ep-show +[33] service-model-approve ----------------------------------------------- -usage: oclip ep-show +usage: oclip service-model-approve -Details of the Entitlement Pool +Approves the Service model in SDC Product: onap-amsterdam Service: sdc @@ -2296,63 +2607,123 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --license-model-id] [-y | --pool-id] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-b | --service-model-id] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --license-model-id Onap License Model ID. It is of type STRING. - -y | --pool-id Onap Entitlement Pool ID. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -b | --service-model-id Service model ID. It is of type STRING. It is + optional. By default, it is . -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + + +[34] service-model-certify-complete +----------------------------------------------- + + +usage: oclip service-model-certify-complete + +Completes the certification of Service model in SDC + +Product: onap-amsterdam +Service: sdc +Author: ONAP CLI Team onap-discuss@lists.onap.org + +Options:: + + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-b | --service-model-id] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] + +where:: + -m | --host-url host url in http(s). It is of type URL. By default, it is read from environment variable OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -b | --service-model-id Service model ID. It is of type STRING. It is + optional. By default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. -a | --no-auth whether to authenticate user or not. It is of - type BOOL. 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. + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[34] license-group-create +[35] service-model-certify-request ----------------------------------------------- -usage: oclip license-group-create +usage: oclip service-model-certify-request -Create License Group +Request the certification of Service model in SDC Product: onap-amsterdam Service: sdc @@ -2360,63 +2731,61 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --group-name] [-y | --license-model-id] [-z | --license-group-description] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-b | --service-model-id] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --group-name group name. It is of type STRING. - -y | --license-model-id License Model ID. It is of type STRING. - -z | --license-group-description Description for License Group. It is of type - STRING. It is optional. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - ID License Group ID and is of type STRING. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -b | --service-model-id Service model ID. It is of type STRING. It is + optional. By default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[35] license-group-show +[36] service-model-certify-start ----------------------------------------------- -usage: oclip license-group-show +usage: oclip service-model-certify-start -Details of the License Group +Starts the certification of Service model in SDC Product: onap-amsterdam Service: sdc @@ -2424,63 +2793,123 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --license-model-id] [-y | --license-group-id] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-b | --service-model-id] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --license-model-id Onap License Model ID. It is of type STRING. - -y | --license-group-id Onap License Group ID. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -b | --service-model-id Service model ID. It is of type STRING. It is + optional. By default, it is . -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + + +[37] service-model-checkin +----------------------------------------------- + + +usage: oclip service-model-checkin + +Checkin Service model in SDC + +Product: onap-amsterdam +Service: sdc +Author: ONAP CLI Team onap-discuss@lists.onap.org + +Options:: + + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-b | --service-model-id] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] + +where:: + -m | --host-url host url in http(s). It is of type URL. By default, it is read from environment variable OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -b | --service-model-id Service model ID. It is of type STRING. It is + optional. By default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. -a | --no-auth whether to authenticate user or not. It is of - type BOOL. 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. + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[36] license-model-create +[38] service-model-checkout ----------------------------------------------- -usage: oclip license-model-create +usage: oclip service-model-checkout -Create License Model +Checkout Service model in SDC Product: onap-amsterdam Service: sdc @@ -2488,61 +2917,61 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vendor-name] [-y | --license-model-description] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-b | --service-model-id] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vendor-name vendor name. It is of type STRING. - -y | --license-model-description Description for License Model. It is of type - STRING. It is optional. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - ID License Model ID and is of type STRING. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -b | --service-model-id Service model ID. It is of type STRING. It is + optional. By default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[37] vlm-aggreement-create +[39] service-model-create ----------------------------------------------- -usage: oclip vlm-aggreement-create +usage: oclip service-model-create -Create license aggreement +Create Service model in SDC Product: onap-amsterdam Service: sdc @@ -2550,64 +2979,78 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --name] [-y | --vlm-id] [-e | --vlm-version] - [-z | --description] [-g | --vlm-feature-group-id] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-z | --project-code] + [-y | --description] [-e | --icon-id] [-x | --name] + [-c | --category-display-name] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-b | --category] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --name aggreement name. It is of type STRING. - -y | --vlm-id License Model ID. It is of type STRING. - -e | --vlm-version License Model version. It is of type STRING. - -z | --description Description for aggreement. It is of type STRING. - -g | --vlm-feature-group-id VLM feature group. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -z | --project-code Project code. It is of type STRING. It is + optional. By default, it is . + -y | --description Description for Service. It is of type STRING. It + is optional. By default, it is . + -e | --icon-id Service Icon id. It is of type STRING. It is + optional. + -x | --name Onap Service Name. It is of type STRING. By + default, it is . + -c | --category-display-name Service category display name. It is of type + STRING. It is optional. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -b | --category Service category. It is of type STRING. It is + optional. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Results:: - ID aggreement ID and is of type STRING. + ID Service ID and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[38] vlm-checkin +[40] service-model-distribute ----------------------------------------------- -usage: oclip vlm-checkin +usage: oclip service-model-distribute -Checkin Vendor License Model +Distributes the Service model in SDC Product: onap-amsterdam Service: sdc @@ -2615,55 +3058,61 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-b | --service-model-id] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vlm-id Onap VLM ID. It is of type STRING. - -y | --vlm-version VLM version. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -b | --service-model-id Service model ID. It is of type STRING. It is + optional. By default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[39] vlm-create +[41] service-model-list ----------------------------------------------- -usage: oclip vlm-create +usage: oclip service-model-list -Create License Model +List the service model in SDC Product: onap-amsterdam Service: sdc @@ -2671,61 +3120,70 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vendor-name] [-y | --description] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vendor-name vendor name. It is of type STRING. - -y | --description Description for License Model. It is of type - STRING. It is optional. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Results:: - ID License Model ID and is of type UUID. + uuid UUID and is of type STRING. + invariant-uuid Invariant UUID and is of type STRING. + name Name and is of type STRING. + version version and is of type STRING. + status status and is of type STRING. + distribution-status status and is of type STRING. + description description and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[40] vlm-entitlement-pool-list +[42] service-model-revert ----------------------------------------------- -usage: oclip vlm-entitlement-pool-list +usage: oclip service-model-revert -entitlement pool list in a license model +Checkout Service model in SDC Product: onap-amsterdam Service: sdc @@ -2733,261 +3191,257 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-b | --service-model-id] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vlm-id License Model ID. It is of type STRING. - -y | --vlm-version License Model version. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - ID Feature group ID and is of type STRING. - name Feature group name and is of type STRING. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -b | --service-model-id Service model ID. It is of type STRING. It is + optional. By default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[41] vlm-feature-group-create +[43] service-type-create ----------------------------------------------- -usage: oclip vlm-feature-group-create +usage: oclip service-type-create -Create feature group Pool +Add a service type in Onap Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --name] [-y | --vlm-id] [-e | --vlm-version] - [-z | --description] [-g | --vlm-key-group-id] [-b | --vlm-entitle-pool-id] - [-c | --part-number] [-k | --manufacture-reference-number] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-x | --service-type] [-v | --version] [-d | --debug] + [-y | --service-type-id] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --name Feature group name. It is of type STRING. - -y | --vlm-id License Model ID. It is of type STRING. - -e | --vlm-version License Model version. It is of type STRING. - -z | --description Description for feature group. It is of type - STRING. - -g | --vlm-key-group-id VLM keygroup. It is of type STRING. - -b | --vlm-entitle-pool-id VLM Entitlement pool. It is of type STRING. - -c | --part-number Part number. It is of type STRING. - -k | --manufacture-reference-number Manufature Reference Number. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - ID Feature group ID and is of type STRING. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -x | --service-type Onap service type. It is of type STRING. By + default, it is . + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -y | --service-type-id Onap service type uuid. It is of type UUID. It is + optional. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[42] vlm-key-group-create +[44] service-type-delete ----------------------------------------------- -usage: oclip vlm-key-group-create +usage: oclip service-type-delete -Create License Key Group +Delete a service type from Onap Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-c | --vlm-id] [-e | --vlm-version] [-x | --name] - [-y | --type] [-z | --description] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-y | --resource-version] + [-x | --service-type-id] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -c | --vlm-id License Model Id. It is of type STRING. - -e | --vlm-version License Model version. It is of type STRING. - -x | --name name. It is of type STRING. - -y | --type type of group (Universal, unique, one-time). It - is of type STRING. By default, it is Universal. - -z | --description Description for License Key Group. It is of type - STRING. It is optional. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - ID License Model ID and is of type STRING. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -y | --resource-version Onap service resource version. It is of type + UUID. It is optional. + -x | --service-type-id Onap service type uuid. It is of type UUID. It is + optional. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[43] vlm-list +[45] service-type-list ----------------------------------------------- -usage: oclip vlm-list +usage: oclip service-type-list -List License Model +List the service types configured in Onap Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Results:: - id License ID and is of type UUID. - vendor-name Vendor Name and is of type STRING. - vlm-version VLM version and is of type STRING. - status status and is of type STRING. - description License description and is of type STRING. + service-type-id Onap cloud service and is of type STRING. + service-type Onap cloud service and is of type STRING. + resource-version Onap cloud service resource version and is of + type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[44] vlm-submit +[46] service2vf-model-list ----------------------------------------------- -usage: oclip vlm-submit +usage: oclip service2vf-model-list -Submit Vendor License Model +List the VF in a given service model in SDC Product: onap-amsterdam Service: sdc @@ -2995,669 +3449,737 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-z | --service-model-id] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-s | --long] [-D | --context] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vlm-id Onap VLM ID. It is of type STRING. - -y | --vlm-version VLM version. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -z | --service-model-id Service model uuid. It is of type STRING. By + default, it is . + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + + +Results:: + + vf-uuid UUID and is of type STRING. + vf-name name and is of type STRING. + vf-customization-uuid customization UUID and is of type STRING. + vf-version version and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[45] vsp-checkin +[47] subscription-create ----------------------------------------------- -usage: oclip vsp-checkin +usage: oclip subscription-create -Checkin Vendor Software Product +Create a subscription of a customer for given service in specific cloud region in Onap Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --customer-name] + [-z | --cloud-name] [-c | --cloud-tenant-id] [-s | --long] + [-D | --context] [-e | --service-type] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] [-r | --cloud-region] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vsp-id Onap VSP ID. It is of type STRING. - -y | --vsp-version VSP version. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --customer-name Onap customer name. It is of type STRING. By + default, it is . + -z | --cloud-name Onap cloud name. It is of type STRING. By + default, it is . + -c | --cloud-tenant-id Onap cloud tenant id. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -e | --service-type Onap service type. It is of type STRING. By + default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + -r | --cloud-region Onap cloud region. It is of type STRING. By + default, it is . Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[46] vsp-create +[48] subscription-delete ----------------------------------------------- -usage: oclip vsp-create +usage: oclip subscription-delete -Create Vendor Software Product +Delete the subscription for a given customer in Onap Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vsp-name] [-y | --vsp-description] [-z | --vsp-category] - [-b | --vsp-subcategory] [-c | --vlm-version] [-e | --vlm-vendor] - [-g | --vlm-id] [-i | --vlm-agreement-id] [-j | --vlm-feature-group-id] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --customer-name] + [-y | --service-type] [-s | --long] [-D | --context] + [-g | --resource-version] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vsp-name Onap VSP Name. It is of type STRING. - -y | --vsp-description Description for VSP. It is of type STRING. It is - optional. - -z | --vsp-category Category of the VSP. It is of type STRING. It is - optional. By default, it is - resourceNewCategory.generic. - -b | --vsp-subcategory Sub Category of VSP. It is of type STRING. It is - optional. By default, it is - resourceNewCategory.generic.abstract. - -c | --vlm-version License version. It is of type STRING. It is - optional. By default, it is 1.0. - -e | --vlm-vendor License Model vendor. It is of type STRING. - -g | --vlm-id License Model ID. It is of type STRING. - -i | --vlm-agreement-id License Agreement ID. It is of type STRING. - -j | --vlm-feature-group-id Feature Group ID. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - ID VSP ID and is of type STRING. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --customer-name Onap customer name. It is of type STRING. By + default, it is . + -y | --service-type Onap subscribtion id. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -g | --resource-version Onap subscription resource version. It is of type + STRING. It is optional. By default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[47] vsp-package +[49] subscription-list ----------------------------------------------- -usage: oclip vsp-package +usage: oclip subscription-list -Package Vendor Software Product +Lists the subscription for a given customer in Onap Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --customer-name] + [-s | --long] [-D | --context] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --customer-name Onap customer name. It is of type STRING. By + default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vsp-id Onap VSP ID. It is of type STRING. - -y | --vsp-version VSP version. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + + +Results:: + + service-type Onap service type and is of type STRING. + resource-version Onap subscription resource version and is of type + STRING. + tenant Onap tenant name and is of type STRING. + region Onap region name and is of type STRING. + cloud Onap cloud name and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[48] vsp-submit +[50] tenant-create ----------------------------------------------- -usage: oclip vsp-submit +usage: oclip tenant-create -Submit Vendor Software Product +Create a tenant under given cloud region in Onap Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --cloud] + [-z | --tenant-id] [-y | --region] [-s | --long] + [-D | --context] [-r | --tenant-name] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --cloud Onap cloud. It is of type STRING. By default, it + is . + -z | --tenant-id Onap cloud tenant id. It is of type STRING. By + default, it is . + -y | --region Onap cloud region. It is of type STRING. By + default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vsp-id Onap VSP ID. It is of type STRING. - -y | --vsp-version VSP version. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -r | --tenant-name Onap cloud tenant name. It is of type STRING. By + default, it is . -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[49] service-model-certify-complete +[51] tenant-delete ----------------------------------------------- -usage: oclip service-model-certify-complete +usage: oclip tenant-delete -Completes the certification of Service model in SDC +Delete tenant under given cloud region in Onap Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-b | --service-model-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --cloud] + [-z | --tenant-id] [-y | --region] [-r | --resource-version] + [-s | --long] [-D | --context] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -b | --service-model-id Service model ID. It is of type STRING. It is - optional. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. -m | --host-url host url in http(s). It is of type URL. By default, it is read from environment variable OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Error:: - - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[50] license-model-show ------------------------------------------------ - - -usage: oclip license-model-show - -Details of the License Model - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --license-model-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] - -where:: - - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --cloud Onap cloud. It is of type STRING. By default, it + is . + -z | --tenant-id Onap cloud tenant id. It is of type STRING. By + default, it is . + -y | --region Onap cloud region. It is of type STRING. By + default, it is . + -r | --resource-version Onap cloud tenant version. It is of type UUID. It + is optional. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --license-model-id Onap License Model ID. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - name License Model Name and is of type STRING. - ID License Model ID and is of type STRING. - description Description for the License Model and is of type - STRING. - status Status of the License Model and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[51] vlm-aggreement-list +[52] tenant-list ----------------------------------------------- -usage: oclip vlm-aggreement-list +usage: oclip tenant-list -List license aggreement +Lists the tenants under given cloud region in Onap Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --cloud] + [-y | --region] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --cloud Onap cloud. It is of type STRING. By default, it + is . + -y | --region Onap cloud region. It is of type STRING. By + default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vlm-id License Model ID. It is of type STRING. - -y | --vlm-version License Model version. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Results:: - ID aggreement ID and is of type STRING. - name aggreement name and is of type STRING. + 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 <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[52] vlm-checkout +[53] vf-create ----------------------------------------------- -usage: oclip vlm-checkout +usage: oclip vf-create -Checkout Vendor License Model +Create a VF Product: onap-amsterdam -Service: sdc +Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-j | --service-model-invariant-id] [-k | --service-model-uuid] [-q | --service-model-name] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-l | --cloud-region] + [-y | --service-instance-id] [-z | --tenant-id] [-c | --vf-model-uuid] + [-o | --instance-name] [-s | --long] [-e | --vf-model-name] + [-g | --vf-model-version] [-b | --vf-model-invariant-id] [-a | --no-auth] + [-n | --service-model-version] [-p | --host-password] [-m | --host-url] + [-C | --no-catalog] [-i | --vf-model-customization-id] [-d | --debug] + [-D | --context] [-w | --product-family] [-u | --host-username] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vlm-id Onap VLM ID. It is of type STRING. - -y | --vlm-version VLM version. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -j | --service-model-invariant-id model invariant id. It is of type STRING. By + default, it is . + -k | --service-model-uuid model name version id. It is of type STRING. By + default, it is . + -q | --service-model-name service model name. It is of type STRING. By + default, it is . + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -l | --cloud-region cloud region identifier. It is of type STRING. By + default, it is . + -y | --service-instance-id unique id for service instance. It is of type + STRING. By default, it is . + -z | --tenant-id openstack tenant id. It is of type STRING. By + default, it is . + -c | --vf-model-uuid model uuid for vf. It is of type STRING. By + default, it is . + -o | --instance-name service instance name. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -e | --vf-model-name vf model name. It is of type STRING. By default, + it is . + -g | --vf-model-version vf model version. It is of type STRING. By + default, it is . + -b | --vf-model-invariant-id vf model invariant id. It is of type STRING. By + default, it is . + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -n | --service-model-version service model version. It is of type STRING. By + default, it is . + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -i | --vf-model-customization-id vf model customization id. It is of type STRING. + By default, it is . + -d | --debug Enable debug output. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -w | --product-family service type for serivce (e.g. vLB). It is of + type STRING. By default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + + +Results:: + + vf-id id for the created vnf and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[53] vlm-entitlement-pool-create +[54] vf-delete ----------------------------------------------- -usage: oclip vlm-entitlement-pool-create +usage: oclip vf-delete -Create Entitlement Pool +delete a VF (experimental) Product: onap-amsterdam -Service: sdc +Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --name] [-y | --vlm-id] [-e | --vlm-version] - [-z | --description] [-g | --operational-scope] [-k | --manufacture-reference-number] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-e | --model-name] [-C | --no-catalog] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-l | --cloud-region] [-b | --model-invariant-id] [-y | --service-instance-id] + [-z | --tenant-id] [-s | --long] [-D | --context] + [-g | --model-version] [-c | --model-uuid] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] [-x | --vf-id] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --name Entitlement Pool name. It is of type STRING. - -y | --vlm-id License Model ID. It is of type STRING. - -e | --vlm-version License Model version. It is of type STRING. - -z | --description Description for Entitlement Pool. It is of type - STRING. - -g | --operational-scope Operational Scope. It is of type STRING. By - default, it is Availability_Zone. - -k | --manufacture-reference-number Manufature Reference Number. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - ID Entitlement Pool ID and is of type STRING. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -e | --model-name model name available in SDC catalog. It is of + type STRING. By default, it is . + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -l | --cloud-region Cloud region ID. It is of type STRING. By + default, it is . + -b | --model-invariant-id model invariant id for service in SDC catalog. It + is of type STRING. By default, it is . + -y | --service-instance-id unique id for service instance. It is of type + STRING. By default, it is . + -z | --tenant-id openstack tenant id (uuid). It is of type STRING. + By default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -g | --model-version model version of service (eg. 1.0). It is of type + STRING. By default, it is . + -c | --model-uuid model uuid for service in SDC catalog. It is of + type STRING. By default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + -x | --vf-id id for vnf. It is of type STRING. By default, it + is . Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[54] vlm-feature-group-list +[55] vf-list ----------------------------------------------- -usage: oclip vlm-feature-group-list +usage: oclip vf-list -Feature group list in a license model +List created VF instances for a service instance Product: onap-amsterdam -Service: sdc +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --customer-name] + [-y | --service-type] [-s | --long] [-D | --context] + [-z | --service-id] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --customer-name customer name. It is of type STRING. By default, + it is . + -y | --service-type service subscription type. It is of type STRING. + By default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vlm-id License Model ID. It is of type STRING. - -y | --vlm-version License Model version. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -z | --service-id service ID. It is of type STRING. By default, it + is . -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Results:: - ID Feature group ID and is of type STRING. - name Feature group name and is of type STRING. + vf-id VF ID for the given service and is of type STRING. + vf-name VF name and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[55] vlm-key-group-list +[56] vf-model-certify-complete ----------------------------------------------- -usage: oclip vlm-key-group-list +usage: oclip vf-model-certify-complete -key group list in a license model +Complete certifying Virtual function Product: onap-amsterdam Service: sdc @@ -3665,61 +4187,61 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-b | --vf-id] + [-s | --long] [-D | --context] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -b | --vf-id VF ID. It is of type STRING. It is optional. By + default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vlm-id License Model ID. It is of type STRING. - -y | --vlm-version License Model version. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - ID Feature group ID and is of type STRING. - name Feature group name and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[56] vlm-revert +[57] vf-model-certify-request ----------------------------------------------- -usage: oclip vlm-revert +usage: oclip vf-model-certify-request -Revert Vendor License Model +Request for certifying Virtual function Product: onap-amsterdam Service: sdc @@ -3727,55 +4249,61 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vlm-id] [-y | --vlm-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-b | --vf-id] + [-s | --long] [-D | --context] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -b | --vf-id VF ID. It is of type STRING. It is optional. By + default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vlm-id Onap VLM ID. It is of type STRING. - -y | --vlm-version VLM version. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[57] vsp-add-artifact +[58] vf-model-certify-start ----------------------------------------------- -usage: oclip vsp-add-artifact +usage: oclip vf-model-certify-start -Upload the CSAR file to VSP +Start certifying Virtual function Product: onap-amsterdam Service: sdc @@ -3783,57 +4311,61 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vsp-id] [-y | --vsp-version] [-z | --vsp-file] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-b | --vf-id] + [-s | --long] [-D | --context] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -b | --vf-id VF ID. It is of type STRING. It is optional. By + default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vsp-id Onap VSP ID. It is of type STRING. - -y | --vsp-version Onap VSP version. It is of type STRING. - -z | --vsp-file CSAR File path. It is of type BINARY. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[58] vsp-checkout +[59] vf-model-checkin ----------------------------------------------- -usage: oclip vsp-checkout +usage: oclip vf-model-checkin -Checkout Vendor Software Product +Checkin Virtual function Product: onap-amsterdam Service: sdc @@ -3841,55 +4373,61 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-b | --vf-id] + [-s | --long] [-D | --context] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -b | --vf-id VF ID. It is of type STRING. It is optional. By + default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vsp-id Onap VSP ID. It is of type STRING. - -y | --vsp-version VSP version. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[59] vsp-list +[60] vf-model-create ----------------------------------------------- -usage: oclip vsp-list +usage: oclip vf-model-create -List of the Vendor Software Products +Create Virtual function from Vendor Software Product Product: onap-amsterdam Service: sdc @@ -3897,64 +4435,75 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-y | --description] + [-g | --vsp-version] [-x | --name] [-s | --long] + [-D | --context] [-z | --vendor-name] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] [-b | --vsp-id] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -y | --description Description for VF. It is of type STRING. It is + optional. By default, it is . + -g | --vsp-version VSP version. It is of type STRING. It is + optional. By default, it is . + -x | --name Onap VF Name. It is of type STRING. By default, + it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -z | --vendor-name Vendor name. It is of type STRING. It is + optional. By default, it is . -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -b | --vsp-id VSP ID. It is of type STRING. It is optional. By + default, it is . Results:: - ID VSP ID and is of type STRING. - name VSP Name and is of type STRING. - vendor-name Vendor name and is of type STRING. - version Version and is of type STRING. - status status and is of type STRING. - license-id license aggreement and is of type STRING. - license-version license version and is of type STRING. + ID VF ID and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[60] vsp-show +[61] vf-model-list ----------------------------------------------- -usage: oclip vsp-show +usage: oclip vf-model-list -Details of the Vendor Software Product +List the VF resource model in SDC Product: onap-amsterdam Service: sdc @@ -3962,367 +4511,480 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vsp-id] [-y | --vsp-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vsp-id Onap VSP ID. It is of type STRING. - -y | --vsp-version Onap VSP version. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Results:: - name VSP Name and is of type STRING. - ID VSP ID and is of type STRING. - description Description for the VSP and is of type STRING. - vendor-name Vendor name and is of type STRING. - vendor-id Vendor id and is of type STRING. - version Version and is of type STRING. - status status and is of type STRING. - license-id license aggreement and is of type STRING. + uuid UUID and is of type STRING. + uniqueid UUID and is of type STRING. + invariant-uuid Invariant UUID and is of type STRING. + name Name and is of type STRING. + version version and is of type STRING. + status status and is of type STRING. + description description and is of type STRING. + vsp-uuid VSP uuid and is of type STRING. + vsp-version VSP version and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[61] microservice-create +[62] vf-module-create ----------------------------------------------- -usage: oclip microservice-create +usage: oclip vf-module-create -Register microservice into Onap +Create a VF Module Product: onap-amsterdam -Service: msb +Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --service-name] [-y | --service-version] [-r | --service-url] - [-b | --enable-ssl] [-c | --path] <node-ip> - <node-port> <create-or-update> [-m | --host-url] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-w | --tenant-id] [-v | --version] [-d | --debug] + [-y | --vnf-instace-id] [-z | --parenet-service-model] [-x | --service-instace-id] + [-l | --lcp-cloudregion-id] [-s | --long] [-D | --context] + [-i | --instance-name] [-u | --host-username] [-r | --supress-rollback] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --service-name Onap service name. It is of type STRING. - -y | --service-version Onap service version. It is of type STRING. - -r | --service-url Onap service base url. It is of type URL. - -b | --enable-ssl Onap service is enabled with https or not. It is - of type STRING. It is optional. - -c | --path Onap service path. It is of type STRING. It is - optional. - node-ip Onap service running node IP. It is of type - STRING. - node-port Onap service running node port. It is of type - STRING. - create-or-update Onap service create or update. It is of type - BOOL. By default, it is true. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - - -Results:: - - name Onap service name and is of type STRING. - version Onap service version and is of type STRING. - url Onap service base url and is of type URL. - status Onap service status and is of type DIGIT. - nodes Onap service running nodes and is of type STRING. - enable-ssl Onap service is enabled with https or not and is - of type STRING. - path Onap service path and is of type STRING. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -w | --tenant-id openstack tenant id (uuid). It is of type STRING. + By default, it is . + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -y | --vnf-instace-id vnf instance id. It is of type STRING. By + default, it is . + -z | --parenet-service-model parent service model name. It is of type STRING. + By default, it is . + -x | --service-instace-id unique id for service instance. It is of type + STRING. By default, it is . + -l | --lcp-cloudregion-id AIC LCP node location identifier. It is of type + STRING. By default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -i | --instance-name service instance name. It is of type STRING. By + default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -r | --supress-rollback rollback changes if instantiation fails. It is of + type BOOL. It is optional. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[62] microservice-delete +[63] vf-show ----------------------------------------------- -usage: oclip microservice-delete +usage: oclip vf-show -Deletes the micro service from Onap +Show details for VF Product: onap-amsterdam -Service: msb +Service: aai Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --service-name] [-y | --service-version] [-i | --node-ip] - [-r | --node-port] [-m | --host-url] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] [-x | --vf-id] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --service-name Onap service name. It is of type STRING. - -y | --service-version Onap service version. It is of type STRING. - -i | --node-ip Onap service running node IP. It is of type - STRING. - -r | --node-port Onap service running node port. It is of type + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + -x | --vf-id VF identifier. It is of type STRING. By default, + it is . + + +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. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[63] microservice-list +[64] vf2vfmodule-model-list ----------------------------------------------- -usage: oclip microservice-list +usage: oclip vf2vfmodule-model-list -Lists the registetred micro services in Onap +List the VF modules in a given VF model in SDC Product: onap-amsterdam -Service: msb +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-m | --host-url] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-z | --vf-id] + [-s | --long] [-D | --context] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -z | --vf-id VF uuid. It is of type STRING. By default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Results:: - name Onap service name and is of type STRING. - version Onap service version and is of type STRING. - url Onap service base url and is of type URL. - status Onap service status and is of type DIGIT. - nodes Onap service running nodes and is of type JSON. - enable-ssl Onap service is enabled with https or not and is - of type STRING. - path Onap service path and is of type STRING. + 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 <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[64] microservice-show +[65] vfmodule-create ----------------------------------------------- -usage: oclip microservice-show +usage: oclip vfmodule-create -Details the registered microservice in Onap +Create a VF module Product: onap-amsterdam -Service: msb +Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --service-name] [-y | --service-version] [-m | --host-url] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-l | --cloud-region] + [-x | --service-model-name] [-j | --service-id] [-z | --service-model-version] + [-i | --module-name] [-o | --vf-model-version] [-k | --vf-model-invariant-id] + [-s | --long] [-g | --vfmodule-version] [-r | --service-model-invariant-id] + [-n | --vf-model-name] [-a | --no-auth] [-w | --service-model-uuid] + [-p | --host-password] [-m | --host-url] [-C | --no-catalog] + [-d | --debug] [-b | --vfmodule-invariant-id] [-c | --vfmodule-uuid] + [-A | --vf-model-uuid] [-y | --vf-id] [-D | --context] + [-B | --tenant-id] [-e | --vfmodule-name] [-q | --vf-model-customization-id] + [-u | --host-username] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --service-name Onap service name. It is of type STRING. - -y | --service-version Onap service version. It is of type STRING. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -l | --cloud-region cloud region identifier. It is of type STRING. By + default, it is . + -x | --service-model-name service model name. It is of type STRING. By + default, it is . + -j | --service-id unique id for service. It is of type STRING. By + default, it is . + -z | --service-model-version service model version. It is of type STRING. By + default, it is . + -i | --module-name vfmodule name. It is of type STRING. By default, + it is . + -o | --vf-model-version vf model version. It is of type STRING. By + default, it is . + -k | --vf-model-invariant-id vf model invariant id. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -g | --vfmodule-version vf module version. It is of type STRING. By + default, it is . + -r | --service-model-invariant-id model invariant id. It is of type STRING. By + default, it is . + -n | --vf-model-name vf model name. It is of type STRING. By default, + it is . + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -w | --service-model-uuid model name version id. It is of type STRING. By + default, it is . + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -d | --debug Enable debug output. It is of type BOOL. + -b | --vfmodule-invariant-id vfmodule model invariant id. It is of type + STRING. By default, it is . + -c | --vfmodule-uuid model uuid for vfmodule. It is of type STRING. By + default, it is . + -A | --vf-model-uuid model uuid for vf. It is of type STRING. By + default, it is . + -y | --vf-id unique id for related VF. It is of type STRING. + By default, it is . + -D | --context command context. It is of type MAP. It is + optional. + -B | --tenant-id openstack tenant id. It is of type STRING. By + default, it is . + -e | --vfmodule-name vfmodule model name. It is of type STRING. By + default, it is . + -q | --vf-model-customization-id vf model customization id. This can be obtained + using SDC portal (Home -> service:xxx -> + Composition -> click on VF for customization id). + It is of type STRING. By default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. Results:: - 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. + vfmodule-id id for the created vnf and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[65] cloud-delete +[66] vfmodule-delete ----------------------------------------------- -usage: oclip cloud-delete +usage: oclip vfmodule-delete -Delete a cloud region from Onap +delete a VF module (experimental) Product: onap-amsterdam -Service: aai +Service: so Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --cloud-name] [-y | --region-name] [-z | --resource-version] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-l | --cloud-region] + [-j | --service-id] [-z | --tenant-id] [-y | --vf-id] + [-k | --vf-model-invariant-id] [-s | --long] [-D | --context] + [-g | --vfmodule-version] [-x | --vfmodule-id] [-e | --vfmodule-name] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --cloud-name Onap cloud name. It is of type STRING. - -y | --region-name Onap cloud region name. It is of type STRING. - -z | --resource-version Onap cloud region version. It is of type UUID. It - is optional. By default, it is - 806a5679-06be-4efb-b420-b314c28efdeb. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -l | --cloud-region cloud region identifier. It is of type STRING. By + default, it is . + -j | --service-id unique id for service. It is of type STRING. By + default, it is . + -z | --tenant-id openstack tenant id. It is of type STRING. By + default, it is . + -y | --vf-id unique id for related VF. It is of type STRING. + By default, it is . + -k | --vf-model-invariant-id vf model invariant id. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -g | --vfmodule-version vf module version. It is of type STRING. By + default, it is . + -x | --vfmodule-id VF module Id. It is of type STRING. By default, + it is . + -e | --vfmodule-name vfmodule model name. It is of type STRING. By + default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[66] customer-delete +[67] vim-list ----------------------------------------------- -usage: oclip customer-delete +usage: oclip vim-list -Delete a customer from Onap +List the configured vims Product: onap-amsterdam Service: aai @@ -4330,57 +4992,77 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --customer-name] [-y | --resource-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --cloud-name] + [-s | --long] [-D | --context] [-y | --region-name] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --customer-name Onap customer name. It is of type STRING. - -y | --resource-version Onap customer resource version. It is of type - UUID. It is optional. By default, it is - 0c453a65-431c-48f9-ad3b-ed0b4b5859b3. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --cloud-name Onap cloud name. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --region-name Onap region name. It is of type STRING. By + default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + + +Results:: + + vim-id Onap vim id and is of type STRING. + name Onap vim name and is of type STRING. + type Onap vim type and is of type STRING. + vendor Onap vim vendor and is of type STRING. + version Onap vim version and is of type STRING. + url Onap vim url and is of type STRING. + username Onap vim username and is of type STRING. + cloud-domain Onap vim cloud domain and is of type STRING. + default-tenant Onap vim tenant and is of type STRING. + resource-version Onap vim resource version and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[67] customer-list +[68] vim-register ----------------------------------------------- -usage: oclip customer-list +usage: oclip vim-register -Lists the registetred customers in Onap +Register a VIM under a given cloud region in Onap Product: onap-amsterdam Service: aai @@ -4388,60 +5070,90 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-e | --vendor] [-v | --version] + [-x | --cloud-name] [-s | --long] [-k | --ssl-cacert] + [-y | --region-name] [-b | --name] [-j | --password] + [-a | --no-auth] [-n | --cloud-domain] [-z | --vim-id] + [-p | --host-password] [-m | --host-url] [-C | --no-catalog] + [-d | --debug] [-q | --vim-version] [-l | --ssl-insecure] + [-c | --type] [-o | --default-tenant] [-D | --context] + [-i | --username] [-u | --host-username] [-g | --url] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -e | --vendor Onap VIM vendor. It is of type STRING. By + default, it is . + -v | --version print service version. It is of type BOOL. + -x | --cloud-name Onap cloud name. It is of type STRING. By + default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. + attributes. It is of type BOOL. + -k | --ssl-cacert Onap VIM SSL certificate. It is of type TEXT. It + is optional. By default, it is . + -y | --region-name Onap region name. It is of type STRING. By + default, it is . + -b | --name Onap VIM name. It is of type STRING. By default, + it is . + -j | --password Onap VIM password. It is of type STRING. By + default, it is . + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -n | --cloud-domain Onap VIM cloud domain. It is of type STRING. By + default, it is . + -z | --vim-id Onap VIM unique id. It is of type UUID. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. -m | --host-url host url in http(s). It is of type URL. By default, it is read from environment variable OPEN_CLI_HOST_URL. - -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. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -d | --debug Enable debug output. It is of type BOOL. + -q | --vim-version Onap VIM version. It is of type STRING. By + default, it is . + -l | --ssl-insecure Onap VIM insecure. It is of type BOOL. It is + optional. + -c | --type Onap VIM type. It is of type STRING. By default, + it is . + -o | --default-tenant Onap VIM default tenant. It is of type STRING. By + default, it is . + -D | --context command context. It is of type MAP. It is + optional. + -i | --username Onap VIM username. It is of type STRING. By + default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -g | --url Onap VIM URL. It is of type STRING. By default, + it is . Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[68] customer-show +[69] vim-unregister ----------------------------------------------- -usage: oclip customer-show +usage: oclip vim-unregister -Lists the registetred customers in Onap +Un-register a VIM under from cloud region in Onap Product: onap-amsterdam Service: aai @@ -4449,1030 +5161,1053 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --customer-name] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --cloud-name] + [-s | --long] [-D | --context] [-y | --region-name] + [-u | --host-username] [-a | --no-auth] [-z | --vim-id] + [-p | --host-password] [-b | --resource-version] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --customer-name Onap customer name. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - name Onap customer name and is of type STRING. - 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. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --cloud-name Onap cloud name. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --region-name Onap region name. It is of type STRING. By + default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -z | --vim-id Onap VIM unique id. It is of type UUID. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + -b | --resource-version Onap vim resource version. It is of type STRING. + It is optional. By default, it is . Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[69] ems-list +[70] vlm-aggreement-create ----------------------------------------------- -usage: oclip ems-list +usage: oclip vlm-aggreement-create -List the configured ems +Create license aggreement Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-y | --vlm-id] [-C | --no-catalog] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-z | --description] [-x | --name] [-g | --vlm-feature-group-id] + [-s | --long] [-D | --context] [-u | --host-username] + [-a | --no-auth] [-e | --vlm-version] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -y | --vlm-id License Model ID. It is of type STRING. By + default, it is . + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -z | --description Description for aggreement. It is of type STRING. + By default, it is . + -x | --name aggreement name. It is of type STRING. By + default, it is . + -g | --vlm-feature-group-id VLM feature group. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -e | --vlm-version License Model version. It is of type STRING. By + default, it is . + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Results:: - ems-id Onap ems id and is of type STRING. - resource-version Onap ems resource version and is of type STRING. + ID aggreement ID and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[70] sdnc-register +[71] vlm-aggreement-list ----------------------------------------------- -usage: oclip sdnc-register +usage: oclip vlm-aggreement-list -Register a SDNC in Onap +List license aggreement Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --location] [-y | --sdnc-id] [-b | --name] - [-c | --type] [-e | --vendor] [-q | --sdnc-version] - [-g | --ip-address] [-k | --port] [-r | --protocal] - [-i | --username] [-j | --password] [-z | --product-name] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-y | --vlm-version] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-x | --vlm-id] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -y | --vlm-version License Model version. It is of type STRING. By + default, it is . + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vlm-id License Model ID. It is of type STRING. By + default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --location Onap VIM unique id. It is of type UUID. By - default, it is - 32df2939-2901-4908-ba4c-5ddaabf719c5. - -y | --sdnc-id Onap SDNC unique id. It is of type UUID. By - default, it is - ea5db6b0-e8e8-44a9-ae2a-fb9b0d5ab26d. - -b | --name Onap SDNC name. It is of type STRING. - -c | --type Onap SDNC type. It is of type STRING. - -e | --vendor Onap SDNC vendor. It is of type STRING. - -q | --sdnc-version Onap SDNC version. It is of type STRING. - -g | --ip-address Onap SDNC ip address. It is of type STRING. - -k | --port Onap SDNC port. It is of type STRING. - -r | --protocal Onap SDNC protocal. It is of type STRING. - -i | --username Onap SDNC username. It is of type STRING. - -j | --password Onap SDNC password. It is of type STRING. - -z | --product-name Onap SDNC product-name. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + + +Results:: + + ID aggreement ID and is of type STRING. + name aggreement name and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[71] sdnc-list +[72] vlm-checkin ----------------------------------------------- -usage: oclip sdnc-list +usage: oclip vlm-checkin -List the configured sdnc +Checkin Vendor License Model Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-y | --vlm-version] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-x | --vlm-id] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -y | --vlm-version VLM version. It is of type STRING. By default, it + is . + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vlm-id Onap VLM ID. It is of type STRING. By default, it + is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - sdnc-id Onap sdnc id and is of type STRING. - resource-version Onap sdnc resource version and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[72] cloud-create +[73] vlm-checkout ----------------------------------------------- -usage: oclip cloud-create +usage: oclip vlm-checkout -Create a cloud region in Onap +Checkout Vendor License Model Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --cloud-name] [-y | --region-name] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-y | --vlm-version] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-x | --vlm-id] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -y | --vlm-version VLM version. It is of type STRING. By default, it + is . + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vlm-id Onap VLM ID. It is of type STRING. By default, it + is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --cloud-name Onap cloud name. It is of type STRING. - -y | --region-name Onap region name. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[73] ems-register +[74] vlm-create ----------------------------------------------- -usage: oclip ems-register +usage: oclip vlm-create -Register a EMS in Onap +Create License Model Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-z | --ems-id] [-b | --name] [-c | --type] - [-e | --vendor] [-q | --ems-version] [-g | --url] - [-i | --username] [-j | --password] [-x | --remote-path] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-y | --description] + [-s | --long] [-D | --context] [-x | --vendor-name] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -y | --description Description for License Model. It is of type + STRING. It is optional. By default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -z | --ems-id Onap EMS unique id. It is of type UUID. By - default, it is - 5888ad8e-c90c-4120-8a7e-dbdfe567db1c. - -b | --name Onap EMS name. It is of type STRING. - -c | --type Onap EMS type. It is of type STRING. - -e | --vendor Onap EMS vendor. It is of type STRING. - -q | --ems-version Onap EMS version. It is of type STRING. - -g | --url Onap EMS URL. It is of type STRING. - -i | --username Onap EMS username. It is of type STRING. - -j | --password Onap EMS password. It is of type STRING. - -x | --remote-path Onap EMS remote-path. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -x | --vendor-name vendor name. It is of type STRING. By default, it + is . -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + + +Results:: + + ID License Model ID and is of type UUID. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[74] ems-unregister +[75] vlm-entitlement-pool-create ----------------------------------------------- -usage: oclip ems-unregister +usage: oclip vlm-entitlement-pool-create -Un-register a EMS in Onap +Create Entitlement Pool Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --ems-id] [-y | --resource-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-y | --vlm-id] [-C | --no-catalog] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-z | --description] [-k | --manufacture-reference-number] [-x | --name] + [-g | --operational-scope] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-e | --vlm-version] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --ems-id Onap EMS unique id. It is of type UUID. By - default, it is - 34953098-9d3f-4438-95e8-9d9ce430d7d3. - -y | --resource-version Onap vim resource version. It is of type STRING. - It is optional. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -y | --vlm-id License Model ID. It is of type STRING. By + default, it is . + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -z | --description Description for Entitlement Pool. It is of type + STRING. By default, it is . + -k | --manufacture-reference-number Manufature Reference Number. It is of type + STRING. By default, it is . + -x | --name Entitlement Pool name. It is of type STRING. By + default, it is . + -g | --operational-scope Operational Scope. It is of type STRING. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -e | --vlm-version License Model version. It is of type STRING. By + default, it is . + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + + +Results:: + + ID Entitlement Pool ID and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[75] ems-show +[76] vlm-entitlement-pool-list ----------------------------------------------- -usage: oclip ems-show +usage: oclip vlm-entitlement-pool-list -Show the details of configured ems +entitlement pool list in a license model Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --ems-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-y | --vlm-version] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-x | --vlm-id] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -y | --vlm-version License Model version. It is of type STRING. By + default, it is . + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vlm-id License Model ID. It is of type STRING. By + default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --ems-id Onap EMS unique id. It is of type UUID. By - default, it is - 44b59f48-34cb-4f07-84fb-b8b1033570df. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Results:: - name Onap ems name and is of type STRING. - type Onap ems type and is of type STRING. - vendor Onap ems vendor and is of type STRING. - version Onap ems version and is of type STRING. - url Onap ems url and is of type STRING. - username Onap ems username and is of type STRING. + ID Feature group ID and is of type STRING. + name Feature group name and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[76] sdnc-unregister +[77] vlm-feature-group-create ----------------------------------------------- -usage: oclip sdnc-unregister +usage: oclip vlm-feature-group-create -Un-register a VNFM in Onap +Create feature group Pool Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --sdnc-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-y | --vlm-id] [-C | --no-catalog] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-c | --part-number] [-v | --version] + [-d | --debug] [-z | --description] [-b | --vlm-entitle-pool-id] + [-k | --manufacture-reference-number] [-x | --name] [-g | --vlm-key-group-id] + [-s | --long] [-D | --context] [-u | --host-username] + [-a | --no-auth] [-e | --vlm-version] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --sdnc-id Onap VNFM unique id. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -y | --vlm-id License Model ID. It is of type STRING. By + default, it is . + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -c | --part-number Part number. It is of type STRING. By default, it + is . + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -z | --description Description for feature group. It is of type + STRING. By default, it is . + -b | --vlm-entitle-pool-id VLM Entitlement pool. It is of type STRING. By + default, it is . + -k | --manufacture-reference-number Manufature Reference Number. It is of type + STRING. By default, it is . + -x | --name Feature group name. It is of type STRING. By + default, it is . + -g | --vlm-key-group-id VLM keygroup. It is of type STRING. By default, + it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -e | --vlm-version License Model version. It is of type STRING. By + default, it is . + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + + +Results:: + + ID Feature group ID and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[77] vim-register +[78] vlm-feature-group-list ----------------------------------------------- -usage: oclip vim-register +usage: oclip vlm-feature-group-list -Register a VIM under a given cloud region in Onap +Feature group list in a license model Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --cloud-name] [-y | --region-name] [-z | --vim-id] - [-b | --name] [-c | --type] [-e | --vendor] - [-q | --vim-version] [-g | --url] [-i | --username] - [-j | --password] [-k | --ssl-cacert] [-l | --ssl-insecure] - [-n | --cloud-domain] [-o | --default-tenant] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-y | --vlm-version] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-x | --vlm-id] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -y | --vlm-version License Model version. It is of type STRING. By + default, it is . + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vlm-id License Model ID. It is of type STRING. By + default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --cloud-name Onap cloud name. It is of type STRING. - -y | --region-name Onap region name. It is of type STRING. - -z | --vim-id Onap VIM unique id. It is of type UUID. By - default, it is - b7eae86a-0e63-4804-93a9-4127a7c1d747. - -b | --name Onap VIM name. It is of type STRING. - -c | --type Onap VIM type. It is of type STRING. - -e | --vendor Onap VIM vendor. It is of type STRING. - -q | --vim-version Onap VIM version. It is of type STRING. - -g | --url Onap VIM URL. It is of type STRING. - -i | --username Onap VIM username. It is of type STRING. - -j | --password Onap VIM password. It is of type STRING. - -k | --ssl-cacert Onap VIM SSL certificate. It is of type TEXT. It - is optional. - -l | --ssl-insecure Onap VIM insecure. It is of type BOOL. It is - optional. By default, it is false. - -n | --cloud-domain Onap VIM cloud domain. It is of type STRING. - -o | --default-tenant Onap VIM default tenant. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Error:: - - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - -[78] vim-unregister ------------------------------------------------ - - -usage: oclip vim-unregister - -Un-register a VIM under from cloud region in Onap - -Product: onap-amsterdam -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --cloud-name] [-y | --region-name] [-z | --vim-id] - [-b | --resource-version] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] - -where:: +Results:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --cloud-name Onap cloud name. It is of type STRING. - -y | --region-name Onap region name. It is of type STRING. - -z | --vim-id Onap VIM unique id. It is of type UUID. By - default, it is - 98319f86-9d39-4d59-8a89-7902f2214056. - -b | --resource-version Onap vim resource version. It is of type STRING. - It is optional. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + ID Feature group ID and is of type STRING. + name Feature group name and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[79] vim-list +[79] vlm-key-group-create ----------------------------------------------- -usage: oclip vim-list +usage: oclip vlm-key-group-create -List the configured vims +Create License Key Group Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --cloud-name] [-y | --region-name] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-z | --description] + [-x | --name] [-s | --long] [-D | --context] + [-y | --type] [-c | --vlm-id] [-u | --host-username] + [-a | --no-auth] [-e | --vlm-version] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -z | --description Description for License Key Group. It is of type + STRING. It is optional. By default, it is . + -x | --name name. It is of type STRING. By default, it is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --cloud-name Onap cloud name. It is of type STRING. - -y | --region-name Onap region name. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --type type of group (Universal, unique, one-time). It + is of type STRING. + -c | --vlm-id License Model Id. It is of type STRING. By + default, it is . -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -e | --vlm-version License Model version. It is of type STRING. By + default, it is . -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Results:: - vim-id Onap vim id and is of type STRING. - name Onap vim name and is of type STRING. - type Onap vim type and is of type STRING. - vendor Onap vim vendor and is of type STRING. - version Onap vim version and is of type STRING. - url Onap vim url and is of type STRING. - username Onap vim username and is of type STRING. - cloud-domain Onap vim cloud domain and is of type STRING. - default-tenant Onap vim tenant and is of type STRING. - resource-version Onap vim resource version and is of type STRING. + ID License Model ID and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[80] vnfm-register +[80] vlm-key-group-list ----------------------------------------------- -usage: oclip vnfm-register +usage: oclip vlm-key-group-list -Register a VNFM in Onap +key group list in a license model Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vim-id] [-y | --vnfm-id] [-b | --name] - [-c | --type] [-e | --vendor] [-q | --vnfm-version] - [-g | --url] [-i | --username] [-j | --password] - [-z | --certificate-url] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-y | --vlm-version] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-x | --vlm-id] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vim-id Onap VIM unique id. It is of type UUID. By - default, it is - f3e8293e-7315-4945-8f8e-a0dd13a880cc. - -y | --vnfm-id Onap VNFM unique id. It is of type UUID. By - default, it is - c35aee19-2416-4f13-9fd2-bc76e70db99c. - -b | --name Onap VNFM name. It is of type STRING. - -c | --type Onap VNFM type. It is of type STRING. - -e | --vendor Onap VNFM vendor. It is of type STRING. - -q | --vnfm-version Onap VNFM version. It is of type STRING. - -g | --url Onap VNFM URL. It is of type STRING. - -i | --username Onap VNFM username. It is of type STRING. - -j | --password Onap VNFM password. It is of type STRING. - -z | --certificate-url Onap VNFM certificate-url. It is of type STRING. - It is optional. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -y | --vlm-version License Model version. It is of type STRING. By + default, it is . + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vlm-id License Model ID. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + + +Results:: + + ID Feature group ID and is of type STRING. + name Feature group name and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[81] vnfm-unregister +[81] vlm-list ----------------------------------------------- -usage: oclip vnfm-unregister +usage: oclip vlm-list -Un-register a VNFM in Onap +List License Model Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vnfm-id] [-y | --resource-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vnfm-id Onap VNFM unique id. It is of type UUID. By - default, it is - 2cbe3dc0-97cb-41e9-b8db-411e6a0975e6. - -y | --resource-version Onap vim resource version. It is of type STRING. - It is optional. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + + +Results:: + + id 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:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[82] vnfm-list +[82] vlm-revert ----------------------------------------------- -usage: oclip vnfm-list +usage: oclip vlm-revert -List the configured vnfm +Revert Vendor License Model Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-y | --vlm-version] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-x | --vlm-id] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -y | --vlm-version VLM version. It is of type STRING. By default, it + is . + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vlm-id Onap VLM ID. It is of type STRING. By default, it + is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - vnfm-id Onap vnfm id and is of type STRING. - vim-id Onap vnfm id and is of type STRING. - certificate-url Onap vnfm certificate-url and is of type STRING. - resource-version Onap vnfm resource version and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[83] vnfm-show +[83] vlm-submit ----------------------------------------------- -usage: oclip vnfm-show +usage: oclip vlm-submit -Show the VNFM in Onap +Submit Vendor License Model Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vnfm-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-y | --vlm-version] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-x | --vlm-id] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -y | --vlm-version VLM version. It is of type STRING. By default, it + is . + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vlm-id Onap VLM ID. It is of type STRING. By default, it + is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vnfm-id Onap VNFM unique id. It is of type UUID. By - default, it is - 472dea25-b892-4b6f-912f-e61430d258da. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - name Onap 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 <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[84] service-list +[84] vnfm-list ----------------------------------------------- -usage: oclip service-list +usage: oclip vnfm-list -List created service instance +List the configured vnfm Product: onap-amsterdam Service: aai @@ -5480,66 +6215,67 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --customer-name] [-y | --service-type] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --customer-name customer name. It is of type STRING. - -y | --service-type service subscription type. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Results:: - service-id instance id of service and is of type STRING. - service-name Service name and is of type STRING. - model-invariant-id Model invariant id of service model and is of - type STRING. - model-uuid Model uuid for service model and is of type - STRING. - description service description and is of type STRING. + vnfm-id Onap vnfm id and is of type STRING. + vim-id Onap vnfm id and is of type STRING. + certificate-url Onap vnfm certificate-url and is of type STRING. + resource-version Onap vnfm resource version and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[85] vf-list +[85] vnfm-register ----------------------------------------------- -usage: oclip vf-list +usage: oclip vnfm-register -List created VF instances for a service instance +Register a VNFM in Onap Product: onap-amsterdam Service: aai @@ -5547,63 +6283,80 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --customer-name] [-y | --service-type] [-z | --service-id] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-e | --vendor] [-v | --version] [-d | --debug] + [-y | --vnfm-id] [-c | --type] [-x | --vim-id] + [-s | --long] [-D | --context] [-b | --name] + [-i | --username] [-j | --password] [-u | --host-username] + [-g | --url] [-a | --no-auth] [-q | --vnfm-version] + [-p | --host-password] [-z | --certificate-url] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --customer-name customer name. It is of type STRING. - -y | --service-type service subscription type. It is of type STRING. - -z | --service-id service ID. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - vf-id VF ID for the given service and is of type STRING. - vf-name VF name and is of type STRING. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -e | --vendor Onap VNFM vendor. It is of type STRING. By + default, it is . + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -y | --vnfm-id Onap VNFM unique id. It is of type UUID. + -c | --type Onap VNFM type. It is of type STRING. By default, + it is . + -x | --vim-id Onap VIM unique id. It is of type UUID. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -b | --name Onap VNFM name. It is of type STRING. By default, + it is . + -i | --username Onap VNFM username. It is of type STRING. By + default, it is . + -j | --password Onap VNFM password. It is of type STRING. By + default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -g | --url Onap VNFM URL. It is of type STRING. By default, + it is . + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -q | --vnfm-version Onap VNFM version. It is of type STRING. By + default, it is . + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + -z | --certificate-url Onap VNFM certificate-url. It is of type STRING. + It is optional. By default, it is . Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[86] vf-show +[86] vnfm-show ----------------------------------------------- -usage: oclip vf-show +usage: oclip vnfm-show -Show details for VF +Show the VNFM in Onap Product: onap-amsterdam Service: aai @@ -5611,66 +6364,70 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --vf-id] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --vnfm-id] + [-s | --long] [-D | --context] [-u | --host-username] + [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vnfm-id Onap VNFM unique id. It is of type UUID. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --vf-id VF identifier. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Results:: - vf-id VF ID for the given service and is of type STRING. - vf-name VF name and is of type STRING. - vf-type VF name and is of type STRING. - model-invariant-id VF name and is of type STRING. - model-uuid model uuid and is of type STRING. - model-customization-id Model customization id and is of type STRING. - service-id Service ID of parent service and is of type - STRING. + 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 <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[87] service-type-create +[87] vnfm-unregister ----------------------------------------------- -usage: oclip service-type-create +usage: oclip vnfm-unregister -Add a service type in Onap +Un-register a VNFM in Onap Product: onap-amsterdam Service: aai @@ -5678,666 +6435,785 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --service-type] [-y | --service-type-id] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-y | --resource-version] + [-x | --vnfm-id] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -y | --resource-version Onap vim resource version. It is of type STRING. + It is optional. By default, it is . + -x | --vnfm-id Onap VNFM unique id. It is of type UUID. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --service-type Onap service type. It is of type STRING. - -y | --service-type-id Onap service type uuid. It is of type UUID. It is - optional. By default, it is - a6c6f62a-19a3-4b7c-9add-e31ccd337510. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[88] service-type-delete +[88] vsp-add-artifact ----------------------------------------------- -usage: oclip service-type-delete +usage: oclip vsp-add-artifact -Delete a service type from Onap +Upload the CSAR file to VSP Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --service-type-id] [-y | --resource-version] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-version] + [-z | --vsp-file] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --service-type-id Onap service type uuid. It is of type UUID. It is - optional. By default, it is - f610d2cb-710a-4603-9aed-b66db1675d20. - -y | --resource-version Onap service resource version. It is of type - UUID. It is optional. By default, it is - 0d1f018e-6e47-48c7-95af-5d15d8a6e8ea. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vsp-id Onap VSP ID. It is of type STRING. By default, it + is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --vsp-version Onap VSP version. It is of type STRING. By + default, it is . + -z | --vsp-file CSAR File path. It is of type BINARY. By default, + it is . Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[89] service-type-list +[89] vsp-checkin ----------------------------------------------- -usage: oclip service-type-list +usage: oclip vsp-checkin -List the service types configured in Onap +Checkin Vendor Software Product Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-version] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vsp-id Onap VSP ID. It is of type STRING. By default, it + is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --vsp-version VSP version. It is of type STRING. By default, it + is . -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. - - -Results:: - - service-type-id Onap cloud service and is of type STRING. - service-type Onap cloud service and is of type STRING. - resource-version Onap cloud service resource version and is of - type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[90] subscription-create +[90] vsp-checkout ----------------------------------------------- -usage: oclip subscription-create +usage: oclip vsp-checkout -Create a subscription of a customer for given service in specific cloud region in Onap +Checkout Vendor Software Product Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --customer-name] [-z | --cloud-name] [-r | --cloud-region] - [-c | --cloud-tenant-id] [-e | --service-type] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-version] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --customer-name Onap customer name. It is of type STRING. - -z | --cloud-name Onap cloud name. It is of type STRING. - -r | --cloud-region Onap cloud region. It is of type STRING. - -c | --cloud-tenant-id Onap cloud tenant id. It is of type STRING. - -e | --service-type Onap service type. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vsp-id Onap VSP ID. It is of type STRING. By default, it + is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --vsp-version VSP version. It is of type STRING. By default, it + is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[91] subscription-delete +[91] vsp-create ----------------------------------------------- -usage: oclip subscription-delete +usage: oclip vsp-create -Delete the subscription for a given customer in Onap +Create Vendor Software Product Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --customer-name] [-y | --service-type] [-g | --resource-version] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-j | --vlm-feature-group-id] [-C | --no-catalog] + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-v | --version] [-d | --debug] + [-e | --vlm-vendor] [-b | --vsp-subcategory] [-z | --vsp-category] + [-x | --vsp-name] [-s | --long] [-D | --context] + [-y | --vsp-description] [-i | --vlm-agreement-id] [-c | --vlm-version] + [-u | --host-username] [-a | --no-auth] [-g | --vlm-id] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --customer-name Onap customer name. It is of type STRING. - -y | --service-type Onap subscribtion id. It is of type STRING. - -g | --resource-version Onap subscription resource version. It is of type - STRING. It is optional. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -j | --vlm-feature-group-id Feature Group ID. It is of type STRING. By + default, it is . + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -e | --vlm-vendor License Model vendor. It is of type STRING. By + default, it is . + -b | --vsp-subcategory Sub Category of VSP. It is of type STRING. It is + optional. + -z | --vsp-category Category of the VSP. It is of type STRING. It is + optional. + -x | --vsp-name Onap VSP Name. It is of type STRING. By default, + it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --vsp-description Description for VSP. It is of type STRING. It is + optional. By default, it is . + -i | --vlm-agreement-id License Agreement ID. It is of type STRING. By + default, it is . + -c | --vlm-version License version. It is of type STRING. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -g | --vlm-id License Model ID. It is of type STRING. By + default, it is . + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + + +Results:: + + ID VSP ID and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[92] subscription-list +[92] vsp-list ----------------------------------------------- -usage: oclip subscription-list +usage: oclip vsp-list -Lists the subscription for a given customer in Onap +List of the Vendor Software Products Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --customer-name] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-u | --host-username] [-a | --no-auth] + [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --customer-name Onap customer name. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Results:: - service-type Onap service type and is of type STRING. - resource-version Onap subscription resource version and is of type - STRING. - tenant Onap tenant name and is of type STRING. - region Onap region name and is of type STRING. - cloud Onap cloud name and is of type STRING. + ID VSP ID and is of type STRING. + name VSP Name and is of type STRING. + vendor-name Vendor name and is of type STRING. + version Version and is of type STRING. + status status and is of type STRING. + license-id license aggreement and is of type STRING. + license-version license version and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[93] tenant-create +[93] vsp-package ----------------------------------------------- -usage: oclip tenant-create +usage: oclip vsp-package -Create a tenant under given cloud region in Onap +Package Vendor Software Product Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --cloud] [-y | --region] [-z | --tenant-id] - [-r | --tenant-name] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-version] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vsp-id Onap VSP ID. It is of type STRING. By default, it + is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --cloud Onap cloud. It is of type STRING. - -y | --region Onap cloud region. It is of type STRING. - -z | --tenant-id Onap cloud tenant id. It is of type STRING. - -r | --tenant-name Onap cloud tenant name. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --vsp-version VSP version. It is of type STRING. By default, it + is . -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[94] tenant-delete +[94] vsp-revert ----------------------------------------------- -usage: oclip tenant-delete +usage: oclip vsp-revert -Delete tenant under given cloud region in Onap +Revert Vendor Software Product Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --cloud] [-y | --region] [-z | --tenant-id] - [-r | --resource-version] [-u | --host-username] [-p | --host-password] - [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-version] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --cloud Onap cloud. It is of type STRING. - -y | --region Onap cloud region. It is of type STRING. - -z | --tenant-id Onap cloud tenant id. It is of type STRING. - -r | --resource-version Onap cloud tenant version. It is of type UUID. It - is optional. By default, it is - b9ea4541-bff0-419b-80cb-0cabad805aad. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vsp-id Onap VSP ID. It is of type STRING. By default, it + is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --vsp-version VSP version. It is of type STRING. By default, it + is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[95] tenant-list +[95] vsp-show ----------------------------------------------- -usage: oclip tenant-list +usage: oclip vsp-show -Lists the tenants under given cloud region in Onap +Details of the Vendor Software Product Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --cloud] [-y | --region] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-version] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vsp-id Onap VSP ID. It is of type STRING. By default, it + is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --cloud Onap cloud. It is of type STRING. - -y | --region Onap cloud region. It is of type STRING. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --vsp-version Onap VSP version. It is of type STRING. By + default, it is . -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. Results:: - tenant-id Onap tenant-id and is of type STRING. - tenant-name Onap tenant name and is of type STRING. - resource-version Onap tenant resource version and is of type - STRING. + 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:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[96] cloud-list +[96] vsp-submit ----------------------------------------------- -usage: oclip cloud-list +usage: oclip vsp-submit -List the configured clouds and Onap service subscriptions +Submit Vendor Software Product Product: onap-amsterdam -Service: aai +Service: sdc Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-u | --host-username] [-p | --host-password] [-m | --host-url] - [-a | --no-auth] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-version] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vsp-id Onap VSP ID. It is of type STRING. By default, it + is . -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --vsp-version VSP version. It is of type STRING. By default, it + is . -u | --host-username Host user name. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_USERNAME. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. -p | --host-password Host user password. It is of type STRING. By default, it is read from environment variable OPEN_CLI_HOST_PASSWORD. Secured. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + + +[97] vsp-validate +----------------------------------------------- + + +usage: oclip vsp-validate + +Validated the uploaded Vendor Software Product + +Product: onap-amsterdam +Service: sdc +Author: ONAP CLI Team onap-discuss@lists.onap.org + +Options:: + + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-version] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] + +where:: + -m | --host-url host url in http(s). It is of type URL. By default, it is read from environment variable OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --vsp-id Onap VSP ID. It is of type STRING. By default, it + is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --vsp-version VSP version. It is of type STRING. By default, it + is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. Results:: - cloud Onap cloud and is of type STRING. - region Onap cloud region and is of type STRING. - tenant Onap cloud tenat and is of type STRING. - tenant-id Onap cloud tenat id and is of type STRING. - customer Onap cloud customer and is of type STRING. - service Onap cloud service and is of type STRING. - resource-version Onap cloud resource version and is of type STRING. + status Validation status and is of type STRING. + errors Validation messages and is of type JSON. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[97] customer-create +sample-helloworld +========================== + + +[1] hello-world ----------------------------------------------- -usage: oclip customer-create +usage: oclip hello-world -Create a customer in Onap +First cmd hello world -Product: onap-amsterdam -Service: aai +Product: sample-helloworld +Service: hello-world Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-x | --customer-name] [-y | --subscriber-name] [-u | --host-username] - [-p | --host-password] [-m | --host-url] [-a | --no-auth] + [-s | --long] [-D | --context] [-h | --help] + [-f | --format] [-t | --no-title] [-v | --version] + [-d | --debug] [-b | --name] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -x | --customer-name Onap customer name. It is of type STRING. - -y | --subscriber-name Onap subscriber name. It is of type STRING. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -p | --host-password Host user password. It is of type STRING. By - default, it is read from environment variable - OPEN_CLI_HOST_PASSWORD. Secured. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. - -a | --no-auth whether to authenticate user or not. It is of - type BOOL. By default, it is false. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -b | --name name of the person. It is of type STRING. -Error:: +Results:: + + output hello world output and is of type STRING. - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> +Error:: + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -sample-helloworld -========================== -[1] hello-world-http +[2] hello-world-http ----------------------------------------------- @@ -6353,31 +7229,36 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-b | --name] [-m | --host-url] + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-s | --long] + [-D | --context] [-b | --name] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. - -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -b | --name name of the person. It is of type STRING. By - default, it is ${DEMO_NAME}. - -m | --host-url host url in http(s). It is of type URL. By - default, it is read from environment variable - OPEN_CLI_HOST_URL. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog whether to use given host-url directly without + looking into catalog, it will overrid the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify verify the command using available command sample + file and mocking file. By default it goes with + mock style. To enable the verification in real + time, set DISABLE_MOCKING=true in the context + param. It is of type BOOL. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -b | --name name of the person. It is of type STRING. Results:: @@ -6387,17 +7268,17 @@ Results:: Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> -[2] hello-world +[3] hello-world-snmp ----------------------------------------------- -usage: oclip hello-world +usage: oclip hello-world-snmp -First cmd hello world +Sample yaml usin snmp profile Product: sample-helloworld Service: hello-world @@ -6405,35 +7286,34 @@ Author: ONAP CLI Team onap-discuss@lists.onap.org Options:: - [-h | --help] [-v | --version] [-d | --debug] - [-f | --format] [-s | --long] [-t | --no-title] - [-b | --name] + [-s | --long] [-D | --context] [-x | --agent] + [-h | --help] [-f | --format] [-t | --no-title] + [-v | --version] [-d | --debug] where:: - -h | --help print help message. It is of type STRING. By - default, it is false. - -v | --version print service version. It is of type STRING. By - default, it is false. - -d | --debug Enable debug output. It is of type BOOL. By - default, it is false. - -f | --format Output formats, supported formats such as table, - csv, json, yaml. It is of type STRING. By - default, it is table. -s | --long whether to print all attributes or only short - attributes. It is of type BOOL. By default, it is - false. - -t | --no-title whether to print title or not. It is of type - BOOL. By default, it is false. - -b | --name name of the person. It is of type STRING. By - default, it is ${env:DEMO_NAME}. + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -x | --agent agent address (eg. "udp:127.0.0.1/161"). It is of + type STRING. By default, it is . + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. Results:: - output hello world output and is of type STRING. + hostname hostname of agent and is of type STRING. + location hostname of agent and is of type STRING. Error:: - On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + diff --git a/docs/cookbook.rst b/docs/cookbook.rst index df2e437a..9e68b2f7 100644 --- a/docs/cookbook.rst +++ b/docs/cookbook.rst @@ -4,8 +4,8 @@ .. _cli_cookbook: -Cook-book -========= +CLI cook-book +============= To Run OCLIP on local docker machine --------------------------------------- |