diff options
Diffstat (limited to 'docs/cmd_help.rst')
| -rw-r--r-- | docs/cmd_help.rst | 8957 |
1 files changed, 3 insertions, 8954 deletions
diff --git a/docs/cmd_help.rst b/docs/cmd_help.rst index d7e1b07f..cf912c84 100644 --- a/docs/cmd_help.rst +++ b/docs/cmd_help.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 Huawei Technologies Co., Ltd. +.. Copyright 2017-18 Huawei Technologies Co., Ltd. .. toctree:: @@ -11,255 +11,7 @@ open-cli ========================== - - -[1] basic-login ------------------------------------------------ - - -usage: oclip basic-login - -basic login auth command - -Product: open-cli -Service: basic-auth -Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com - -Options:: - - [-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:: - - -m | --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:: - - Authorization Authorization and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[2] basic-logout ------------------------------------------------ - - -usage: oclip basic-logout - -basic logout auth command - -Product: open-cli -Service: basic-auth -Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com - -Options:: - - [-m | --host-url] [-C | --no-catalog] [-h | --help] - [-f | --format] [-t | --no-title] [-V | --verify] - [-v | --version] [-d | --debug] [-s | --long] - [-D | --context] - -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. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[3] 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:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[4] sample-test-verify ------------------------------------------------ - - -usage: oclip sample-test-verify - -Oclip sample command to test the command features - -Product: open-cli -Service: test -Author: null - -Options:: - - [-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:: - - -m | --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:: - - 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[5] schema-refresh +[1] schema-refresh ----------------------------------------------- @@ -307,7 +59,7 @@ Error:: -[6] schema-validate +[2] schema-validate ----------------------------------------------- @@ -353,8706 +105,3 @@ Results:: Error:: On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -onap-amsterdam -========================== - - -[1] basic-login ------------------------------------------------ - - -usage: oclip basic-login - -ONAP basic login auth command - -Product: onap-amsterdam -Service: basic-auth -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] [-u | --host-username] [-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. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -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:: - - Authorization Authorization and is of type STRING. - X-TransactionId X-TransactionId and is of type STRING. - X-FromAppId X-FromAppId and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[2] basic-logout ------------------------------------------------ - - -usage: oclip basic-logout - -ONAP basic logout auth command - -Product: onap-amsterdam -Service: basic-auth -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] - -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. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[3] catalog ------------------------------------------------ - - -usage: oclip catalog - -ONAP catalog command to find the base path for service. - -Product: onap-amsterdam -Service: msb -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[4] cloud-create ------------------------------------------------ - - -usage: oclip cloud-create - -Create a cloud region in 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 | --cloud-name] - [-s | --long] [-D | --context] [-y | --region-name] - [-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 | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[5] cloud-delete ------------------------------------------------ - - -usage: oclip cloud-delete - -Delete a cloud region 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 | --cloud-name] - [-z | --resource-version] [-s | --long] [-D | --context] - [-y | --region-name] [-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 | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[6] cloud-list ------------------------------------------------ - - -usage: oclip cloud-list - -List the configured clouds and Onap service subscriptions - -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] [-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. - -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:: - - 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[7] customer-create ------------------------------------------------ - - -usage: oclip customer-create - -Create a customer in Onap - -Product: onap-amsterdam -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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. - - -Error:: - - 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[9] customer-list ------------------------------------------------ - - -usage: oclip customer-list - -Lists the registered customers in 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] [-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. - -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. - resource-version Onap customer resource version and is of type - STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[10] customer-show ------------------------------------------------ - - -usage: oclip customer-show - -Retrieves the given registered customer in 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] - [-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 . - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[11] ems-list ------------------------------------------------ - - -usage: oclip ems-list - -List the configured ems - -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] [-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. - -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:: - - 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[12] ems-register ------------------------------------------------ - - -usage: oclip ems-register - -Register a EMS in 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] - [-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:: - - -m | --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 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. - -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. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[13] ems-show ------------------------------------------------ - - -usage: oclip ems-show - -Show the details of configured ems - -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 | --ems-id] - [-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 | --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. - -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 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[14] ems-unregister ------------------------------------------------ - - -usage: oclip ems-unregister - -Un-register a EMS in 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] [-y | --resource-version] - [-x | --ems-id] [-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. - -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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[15] ep-create ------------------------------------------------ - - -usage: oclip ep-create - -Create Entitlement Pool - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[16] ep-show ------------------------------------------------ - - -usage: oclip ep-show - -Details of the Entitlement Pool - -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] [-x | --license-model-id] [-u | --host-username] - [-a | --no-auth] [-p | --host-password] [-y | --pool-id] - -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. - -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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[17] license-group-create ------------------------------------------------ - - -usage: oclip license-group-create - -Create License Group - -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] [-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:: - - -m | --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 License Group ID and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[18] license-group-show ------------------------------------------------ - - -usage: oclip license-group-show - -Details of the License Group - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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. - -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. - - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[19] license-model-create ------------------------------------------------ - - -usage: oclip license-model-create - -Create License Model - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[20] 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:: - - [-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:: - - -m | --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. - -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. - - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[21] microservice-create ------------------------------------------------ - - -usage: oclip microservice-create - -Register microservice into 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] - <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:: - - -m | --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. - 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. - -D | --context command context. It is of type MAP. It is - optional. - 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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[23] microservice-list ------------------------------------------------ - - -usage: oclip microservice-list - -Lists the registetred micro services in 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] [-s | --long] - [-D | --context] - -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. - - -Results:: - - name Onap service name and is of type STRING. - version Onap service version and is of type STRING. - url Onap service base url and is of type URL. - status Onap service status and is of type DIGIT. - nodes Onap service running nodes and is of type JSON. - enable-ssl Onap service is enabled with https or not and is - of type STRING. - path Onap service path and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[24] microservice-show ------------------------------------------------ - - -usage: oclip microservice-show - -Details the registered microservice in 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] - -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. - -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:: - - 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[25] sdc-basic-login ------------------------------------------------ - - -usage: oclip sdc-basic-login - -ONAP basic login auth command - -Product: onap-amsterdam -Service: sdc-basic-auth -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] [-u | --host-username] [-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. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -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:: - - 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[26] sdnc-list ------------------------------------------------ - - -usage: oclip sdnc-list - -List the configured sdnc - -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] [-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. - -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:: - - 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[27] sdnc-register ------------------------------------------------ - - -usage: oclip sdnc-register - -Register a SDNC in Onap - -Product: onap-amsterdam -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -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. - -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. - -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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[28] sdnc-unregister ------------------------------------------------ - - -usage: oclip sdnc-unregister - -Un-register a VNFM in 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 | --sdnc-id] - [-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 | --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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[29] service-create ------------------------------------------------ - - -usage: oclip service-create - -Create a service instance using MSO - -Product: onap-amsterdam -Service: so -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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:: - - service-id instance id for the created service. and is of - type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[30] service-delete ------------------------------------------------ - - -usage: oclip service-delete - -Delete service instance (experimental) - -Product: onap-amsterdam -Service: so -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[31] service-list ------------------------------------------------ - - -usage: oclip service-list - -List created service instance - -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 | --service-type] [-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 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. - -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 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[32] service-model-add-vf ------------------------------------------------ - - -usage: oclip service-model-add-vf - -Helps to add VF into service models 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] [-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:: - - -m | --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 Service ID and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[33] service-model-approve ------------------------------------------------ - - -usage: oclip service-model-approve - -Approves the 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. - -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. - -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> - - - -[35] service-model-certify-request ------------------------------------------------ - - -usage: oclip service-model-certify-request - -Request 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. - -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> - - - -[36] service-model-certify-start ------------------------------------------------ - - -usage: oclip service-model-certify-start - -Starts 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. - -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. - -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> - - - -[38] service-model-checkout ------------------------------------------------ - - -usage: oclip service-model-checkout - -Checkout 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. - -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> - - - -[39] service-model-create ------------------------------------------------ - - -usage: oclip service-model-create - -Create 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] [-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:: - - -m | --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 Service ID and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[40] service-model-distribute ------------------------------------------------ - - -usage: oclip service-model-distribute - -Distributes the 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. - -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> - - - -[41] service-model-list ------------------------------------------------ - - -usage: oclip service-model-list - -List the 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] [-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. - -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:: - - 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[42] service-model-revert ------------------------------------------------ - - -usage: oclip service-model-revert - -Checkout 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. - -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> - - - -[43] service-type-create ------------------------------------------------ - - -usage: oclip service-type-create - -Add a service type in 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] - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[44] service-type-delete ------------------------------------------------ - - -usage: oclip service-type-delete - -Delete a service type 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] [-y | --resource-version] - [-x | --service-type-id] [-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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[45] service-type-list ------------------------------------------------ - - -usage: oclip service-type-list - -List the service types configured in 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] [-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. - -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-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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[46] service2vf-model-list ------------------------------------------------ - - -usage: oclip service2vf-model-list - -List the VF in a given 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] [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[47] subscription-create ------------------------------------------------ - - -usage: oclip subscription-create - -Create a subscription of a customer for given service in specific cloud region in 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] - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[48] subscription-delete ------------------------------------------------ - - -usage: oclip subscription-delete - -Delete the subscription for a given customer in 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 | --service-type] [-s | --long] [-D | --context] - [-g | --resource-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 | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[49] subscription-list ------------------------------------------------ - - -usage: oclip subscription-list - -Lists the subscription for a given customer in 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] - [-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 . - -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-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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[50] tenant-create ------------------------------------------------ - - -usage: oclip tenant-create - -Create a tenant under given cloud region in 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 | --cloud] - [-z | --tenant-id] [-y | --region] [-s | --long] - [-D | --context] [-r | --tenant-name] [-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 | --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. - -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. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[51] tenant-delete ------------------------------------------------ - - -usage: oclip tenant-delete - -Delete tenant under given cloud region in 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 | --cloud] - [-z | --tenant-id] [-y | --region] [-r | --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 | --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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[52] tenant-list ------------------------------------------------ - - -usage: oclip tenant-list - -Lists the tenants under given cloud region in 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 | --cloud] - [-y | --region] [-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 | --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. - -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:: - - 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[53] vf-create ------------------------------------------------ - - -usage: oclip vf-create - -Create a VF - -Product: onap-amsterdam -Service: so -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[54] vf-delete ------------------------------------------------ - - -usage: oclip vf-delete - -delete a VF (experimental) - -Product: onap-amsterdam -Service: so -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[55] vf-list ------------------------------------------------ - - -usage: oclip vf-list - -List created VF instances for a service instance - -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 | --service-type] [-s | --long] [-D | --context] - [-z | --service-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. - -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. - -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. - - -Results:: - - vf-id VF ID for the given service and is of type STRING. - vf-name VF name and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[56] vf-model-certify-complete ------------------------------------------------ - - -usage: oclip vf-model-certify-complete - -Complete certifying Virtual function - -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] [-b | --vf-id] - [-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. - -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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[57] vf-model-certify-request ------------------------------------------------ - - -usage: oclip vf-model-certify-request - -Request for certifying Virtual function - -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] [-b | --vf-id] - [-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. - -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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[58] vf-model-certify-start ------------------------------------------------ - - -usage: oclip vf-model-certify-start - -Start certifying Virtual function - -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] [-b | --vf-id] - [-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. - -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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[59] vf-model-checkin ------------------------------------------------ - - -usage: oclip vf-model-checkin - -Checkin Virtual function - -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] [-b | --vf-id] - [-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. - -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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[60] vf-model-create ------------------------------------------------ - - -usage: oclip vf-model-create - -Create Virtual function from 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] [-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:: - - -m | --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 | --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. - -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. - -b | --vsp-id VSP ID. It is of type STRING. It is optional. By - default, it is . - - -Results:: - - ID VF ID and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[61] vf-model-list ------------------------------------------------ - - -usage: oclip vf-model-list - -List the VF resource 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] [-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. - -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:: - - 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[62] vf-module-create ------------------------------------------------ - - -usage: oclip vf-module-create - -Create a VF Module - -Product: onap-amsterdam -Service: so -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] - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[63] vf-show ------------------------------------------------ - - -usage: oclip vf-show - -Show details for VF - -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] [-s | --long] - [-D | --context] [-u | --host-username] [-a | --no-auth] - [-p | --host-password] [-x | --vf-id] - -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. - -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. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[64] vf2vfmodule-model-list ------------------------------------------------ - - -usage: oclip vf2vfmodule-model-list - -List the VF modules in a given VF 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] [-z | --vf-id] - [-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. - -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:: - - 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[65] vfmodule-create ------------------------------------------------ - - -usage: oclip vfmodule-create - -Create a VF module - -Product: onap-amsterdam -Service: so -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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 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:: - - vfmodule-id id for the created vnf and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[66] vfmodule-delete ------------------------------------------------ - - -usage: oclip vfmodule-delete - -delete a VF module (experimental) - -Product: onap-amsterdam -Service: so -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] [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[67] vim-list ------------------------------------------------ - - -usage: oclip vim-list - -List the configured vims - -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 | --cloud-name] - [-s | --long] [-D | --context] [-y | --region-name] - [-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 | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[68] vim-register ------------------------------------------------ - - -usage: oclip vim-register - -Register a VIM under a given cloud region in Onap - -Product: onap-amsterdam -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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 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 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. - -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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[69] 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:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[70] vlm-aggreement-create ------------------------------------------------ - - -usage: oclip vlm-aggreement-create - -Create license aggreement - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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:: - - ID aggreement ID and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[71] vlm-aggreement-list ------------------------------------------------ - - -usage: oclip vlm-aggreement-list - -List license aggreement - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 aggreement ID and is of type STRING. - name aggreement name and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[72] vlm-checkin ------------------------------------------------ - - -usage: oclip vlm-checkin - -Checkin Vendor License Model - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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. - -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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[73] vlm-checkout ------------------------------------------------ - - -usage: oclip vlm-checkout - -Checkout Vendor License Model - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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. - -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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[74] vlm-create ------------------------------------------------ - - -usage: oclip vlm-create - -Create License Model - -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] [-y | --description] - [-s | --long] [-D | --context] [-x | --vendor-name] - [-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. - -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. - -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 UUID. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[75] vlm-entitlement-pool-create ------------------------------------------------ - - -usage: oclip vlm-entitlement-pool-create - -Create Entitlement Pool - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[76] vlm-entitlement-pool-list ------------------------------------------------ - - -usage: oclip vlm-entitlement-pool-list - -entitlement pool list in a license model - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[77] vlm-feature-group-create ------------------------------------------------ - - -usage: oclip vlm-feature-group-create - -Create feature group Pool - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[78] vlm-feature-group-list ------------------------------------------------ - - -usage: oclip vlm-feature-group-list - -Feature group list in a license model - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[79] vlm-key-group-create ------------------------------------------------ - - -usage: oclip vlm-key-group-create - -Create License Key Group - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 | --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. - -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. - - -Results:: - - ID License Model ID and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[80] vlm-key-group-list ------------------------------------------------ - - -usage: oclip vlm-key-group-list - -key group list in a license model - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[81] vlm-list ------------------------------------------------ - - -usage: oclip vlm-list - -List License Model - -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] [-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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[82] vlm-revert ------------------------------------------------ - - -usage: oclip vlm-revert - -Revert Vendor License Model - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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. - -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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[83] vlm-submit ------------------------------------------------ - - -usage: oclip vlm-submit - -Submit Vendor License Model - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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. - -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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[84] vnfm-list ------------------------------------------------ - - -usage: oclip vnfm-list - -List the configured vnfm - -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] [-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. - -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:: - - 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[85] vnfm-register ------------------------------------------------ - - -usage: oclip vnfm-register - -Register a VNFM in 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] - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[86] vnfm-show ------------------------------------------------ - - -usage: oclip vnfm-show - -Show the VNFM in 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 | --vnfm-id] - [-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 | --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. - -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 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[87] vnfm-unregister ------------------------------------------------ - - -usage: oclip vnfm-unregister - -Un-register a VNFM in 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] [-y | --resource-version] - [-x | --vnfm-id] [-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. - -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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[88] vsp-add-artifact ------------------------------------------------ - - -usage: oclip vsp-add-artifact - -Upload the CSAR file to VSP - -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] - [-z | --vsp-file] - -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 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[89] vsp-checkin ------------------------------------------------ - - -usage: oclip vsp-checkin - -Checkin 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. - -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> - - - -[90] vsp-checkout ------------------------------------------------ - - -usage: oclip vsp-checkout - -Checkout 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. - -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> - - - -[91] vsp-create ------------------------------------------------ - - -usage: oclip vsp-create - -Create Vendor Software Product - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[92] vsp-list ------------------------------------------------ - - -usage: oclip vsp-list - -List of the Vendor Software Products - -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] [-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. - -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 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[93] vsp-package ------------------------------------------------ - - -usage: oclip vsp-package - -Package Vendor Software Product - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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. - -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> - - - -[94] vsp-revert ------------------------------------------------ - - -usage: oclip vsp-revert - -Revert 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. - -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> - - - -[95] vsp-show ------------------------------------------------ - - -usage: oclip vsp-show - -Details of the 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 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. - - -Results:: - - name VSP Name and is of type STRING. - ID VSP ID and is of type STRING. - description Description for the VSP and is of type STRING. - vendor-name Vendor name and is of type STRING. - vendor-id Vendor id and is of type STRING. - version Version and is of type STRING. - status status and is of type STRING. - license-id license aggreement and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[96] vsp-submit ------------------------------------------------ - - -usage: oclip vsp-submit - -Submit Vendor Software Product - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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. - -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. - -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:: - - status Validation status and is of type STRING. - errors Validation messages and is of type JSON. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -sample-helloworld -========================== - - -[1] hello-world ------------------------------------------------ - - -usage: oclip hello-world - -First cmd hello world - -Product: sample-helloworld -Service: hello-world -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-s | --long] [-D | --context] [-h | --help] - [-f | --format] [-t | --no-title] [-v | --version] - [-d | --debug] [-b | --name] - -where:: - - -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. - - -Results:: - - output hello world output and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[2] hello-world-http ------------------------------------------------ - - -usage: oclip hello-world-http - -First cmd hello world using http runing under -lighttpd in cli at http://<cli-ip>:8080/version.json - - -Product: sample-helloworld -Service: hello-world -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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:: - - output hello world output and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[3] hello-world-snmp ------------------------------------------------ - - -usage: oclip hello-world-snmp - -Sample yaml usin snmp profile - -Product: sample-helloworld -Service: hello-world -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-s | --long] [-D | --context] [-x | --agent] - [-h | --help] [-f | --format] [-t | --no-title] - [-v | --version] [-d | --debug] - -where:: - - -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 | --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:: - - hostname hostname of agent and is of type STRING. - location hostname of agent and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - -onap-beijing -========================== - - -[1] basic-login ------------------------------------------------ - - -usage: oclip basic-login - -ONAP basic login auth command - -Product: onap-beijing -Service: basic-auth -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] [-u | --host-username] [-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. - -u | --host-username Host user name. It is of type STRING. By default, - it is read from environment variable - OPEN_CLI_HOST_USERNAME. - -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:: - - Authorization Authorization and is of type STRING. - X-TransactionId X-TransactionId and is of type STRING. - X-FromAppId X-FromAppId and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[2] basic-logout ------------------------------------------------ - - -usage: oclip basic-logout - -ONAP basic logout auth command - -Product: onap-beijing -Service: basic-auth -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] - -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. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[3] catalog ------------------------------------------------ - - -usage: oclip catalog - -ONAP catalog command to find the base path for service. - -Product: onap-beijing -Service: msb -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[4] cloud-create ------------------------------------------------ - - -usage: oclip cloud-create - -Create a cloud region in Onap - -Product: onap-beijing -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 | --cloud-name] - [-s | --long] [-D | --context] [-y | --region-name] - [-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 | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[5] cloud-delete ------------------------------------------------ - - -usage: oclip cloud-delete - -Delete a cloud region from Onap - -Product: onap-beijing -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 | --cloud-name] - [-z | --resource-version] [-s | --long] [-D | --context] - [-y | --region-name] [-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 | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[6] cloud-list ------------------------------------------------ - - -usage: oclip cloud-list - -List the configured clouds and Onap service subscriptions - -Product: onap-beijing -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] [-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. - -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:: - - 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[7] customer-create ------------------------------------------------ - - -usage: oclip customer-create - -Create a customer in Onap - -Product: onap-beijing -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[8] customer-delete ------------------------------------------------ - - -usage: oclip customer-delete - -Delete a customer from Onap - -Product: onap-beijing -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[9] customer-list ------------------------------------------------ - - -usage: oclip customer-list - -Lists the registered customers in Onap - -Product: onap-beijing -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] [-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. - -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. - resource-version Onap customer resource version and is of type - STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[10] customer-show ------------------------------------------------ - - -usage: oclip customer-show - -Retrieves the given registered customer in Onap - -Product: onap-beijing -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] - [-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 . - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[11] ems-list ------------------------------------------------ - - -usage: oclip ems-list - -List the configured ems - -Product: onap-beijing -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] [-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. - -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:: - - 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[12] ems-register ------------------------------------------------ - - -usage: oclip ems-register - -Register a EMS in Onap - -Product: onap-beijing -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] - [-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:: - - -m | --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 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. - -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. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[13] ems-show ------------------------------------------------ - - -usage: oclip ems-show - -Show the details of configured ems - -Product: onap-beijing -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 | --ems-id] - [-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 | --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. - -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 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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[14] ems-unregister ------------------------------------------------ - - -usage: oclip ems-unregister - -Un-register a EMS in Onap - -Product: onap-beijing -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] [-y | --resource-version] - [-x | --ems-id] [-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. - -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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[15] ep-create ------------------------------------------------ - - -usage: oclip ep-create - -Create Entitlement Pool - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[16] ep-show ------------------------------------------------ - - -usage: oclip ep-show - -Details of the Entitlement Pool - -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] [-x | --license-model-id] [-u | --host-username] - [-a | --no-auth] [-p | --host-password] [-y | --pool-id] - -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. - -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. - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[17] generic-search ------------------------------------------------ - - -usage: oclip generic-search - -generic-search - -Product: onap-beijing -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-m | --host-url] [-r | --start-node-type] [-C | --no-catalog] - [-h | --help] [-f | --format] [-t | --no-title] - [-V | --verify] [-v | --version] [-d | --debug] - [-k | --key] [-z | --value] [-s | --long] - [-D | --context] [-e | --depth] [-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. - -r | --start-node-type start-node-type. 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. - -k | --key key. It is of type STRING. By default, it is . - -z | --value value. 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 | --depth search depth. It is of type DIGIT. 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:: - - resource-type Onap result-type and is of type STRING. - resource-link Onap resource-link and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[18] license-group-create ------------------------------------------------ - - -usage: oclip license-group-create - -Create License Group - -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] [-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:: - - -m | --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 License Group ID and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[19] license-group-show ------------------------------------------------ - - -usage: oclip license-group-show - -Details of the License Group - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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. - -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. - - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[20] license-model-create ------------------------------------------------ - - -usage: oclip license-model-create - -Create License Model - -Product: onap-amsterdam -Service: sdc -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-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:: - - -m | --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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[21] 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:: - - [-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:: - - -m | --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. - -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. - - -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 <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[22] logic-link-create ------------------------------------------------ - - -usage: oclip logic-link-create - -Create a logic-link - -Product: onap-beijing -Service: aai -Author: ONAP CLI Team onap-discuss@lists.onap.org - -Options:: - - [-m | --host-url] [-g | --prov-status] [-C | --no-catalog] - [-h | --help] [-f | --format] [-t | --no-title] - [-V | --verify] [-v | --version] [-d | --debug] - [-w | --in-maint] [-s | --long] [-D | --context] - [-n | --name] [-j | --link-role] [-x | --speed-units] - [-u | --host-username] [-r | --relationship] [-a | --no-auth] - [-p | --host-password] [-i | --link-type] [-q | --speed-value] - [-z | --link-id] - -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. - -g | --prov-status Prov Status of this device (not under canopi - control) Valid values [PREPROV/NVTPROV/PROV]. It - is of type STRING. It is optional. 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. - -w | --in-maint Used to indicate whether or not this object is in - maintenance mode (maintenance mode = true). 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. - -n | --name logic-link-name. It is of type STRING. By - default, it is . - -j | --link-role link-role. It is of type STRING. It is optional. - By default, it is . - -x | --speed-units speed-units. 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. - -r | --relationship relationship. It is of type JSON. It's - recommended to input the complete path of the - file, which is having the value for it. 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. - -i | --link-type link-type. It is of type STRING. It is optional. - By default, it is . - -q | --speed-value speed-value. It is of type STRING. It is - optional. By default, it is . - -z | --link-id link-id. It is of type STRING. It is optional. By - default, it is . - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[23] logic-link-delete ------------------------------------------------ - - -usage: oclip logic-link-delete - -Delete logic-link-delete from Onap - -Product: onap-beijing -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] [-n | --logic-link-name] - [-s | --long] [-D | --context] [-u | --host-username] - [-a | --no-auth] [-p | --host-password] [-b | --resource-version] - -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. - -n | --logic-link-name Onap logic-link 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. - -b | --resource-version Onap logic-link-name resource version. It is of - type UUID. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[24] logic-link-list ------------------------------------------------ - - -usage: oclip logic-link-list - -show detail for one single logic-link - -Product: onap-beijing -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] [-n | --name] - [-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. - -n | --name logic-link-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:: - - logic-link-name Onap logic-link name and is of type STRING. - logic-link-id Onap logic-link id and is of type STRING. - in-maint Onap in-maint and is of type STRING. - speed-value Onap speed-value and is of type STRING. - speed-units Onap speed-units and is of type STRING. - prov-status Onap prov-status and is of type STRING. - link-role Onap link-role and is of type STRING. - resource-version Onap resource-version and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> - - - -[25] logic-link-list ------------------------------------------------ - - -usage: oclip logic-link-list - -show detail for one single logic-link - -Product: onap-beijing -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] [-n | --name] - [-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. - -n | --name logic-link-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:: - - logic-link-name Onap logic-link name and is of type STRING. - logic-link-id Onap logic-link id and is of type STRING. - in-maint Onap in-maint and is of type STRING. - speed-value Onap speed-value and is of type STRING. - speed-units Onap speed-units and is of type STRING. - prov-status Onap prov-status and is of type STRING. - link-role Onap link-role and is of type STRING. - resource-version Onap resource-version and is of type STRING. - - -Error:: - - On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
\ No newline at end of file |