diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cmd_help.rst | 8957 | ||||
| -rw-r--r-- | docs/cmd_help_onap_amsterdam.rst | 9058 | ||||
| -rw-r--r-- | docs/cmd_help_onap_beijing.rst | 1751 | ||||
| -rw-r--r-- | docs/cmd_sample.rst | 1360 | ||||
| -rw-r--r-- | docs/cmd_sample_onap_amsterdam.rst | 1290 | ||||
| -rw-r--r-- | docs/cookbook.rst | 2 | ||||
| -rw-r--r-- | docs/pnf_on_boarding.rst (renamed from docs/step_to_import_PNF.rst) | 2 | ||||
| -rw-r--r-- | docs/user_guide.rst | 9 |
8 files changed, 12111 insertions, 10318 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 diff --git a/docs/cmd_help_onap_amsterdam.rst b/docs/cmd_help_onap_amsterdam.rst new file mode 100644 index 00000000..873d9694 --- /dev/null +++ b/docs/cmd_help_onap_amsterdam.rst @@ -0,0 +1,9058 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2018 Huawei Technologies Co., Ltd. + + +.. toctree:: + :maxdepth: 2 + + +.. _cli_cmd_help: + +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 +----------------------------------------------- + + +usage: oclip schema-refresh + +Oclip command to refresh schemas stored in open-cli-schema folders. + +Product: open-cli +Service: schema +Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com + +Options:: + + [-s | --long] [-D | --context] [-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. + -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:: + + sr.no Serial Number and is of type STRING. + command Command name and is of type STRING. + product Command product version and is of type STRING. + schema Schema name and is of type STRING. + ocs-version Schema version and is of type STRING. + type Command type and is of type STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + + + +[6] schema-validate +----------------------------------------------- + + +usage: oclip schema-validate + +Oclip command to validate schema + +Product: open-cli +Service: schema +Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com + +Options:: + + [-s | --long] [-D | --context] [-h | --help] + [-f | --format] [-t | --no-title] [-b | --ocs-version] + [-v | --version] [-d | --debug] [-l | --schema-location] + [-i | --internal-schema] + +where:: + + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -b | --ocs-version OCS version. It is of type STRING. It is optional. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -l | --schema-location Schema file location. It is of type URL. By + default, it is . + -i | --internal-schema Validate existing schema file. It is of type BOOL. + + +Results:: + + sl-no Serial Number of error and is of type STRING. + error Schema validation error and is of type STRING. + + +Error:: + + On error, it prints <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 diff --git a/docs/cmd_help_onap_beijing.rst b/docs/cmd_help_onap_beijing.rst new file mode 100644 index 00000000..0ee93852 --- /dev/null +++ b/docs/cmd_help_onap_beijing.rst @@ -0,0 +1,1751 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2018 Huawei Technologies Co., Ltd. + + +.. toctree:: + :maxdepth: 2 + + +.. _cli_cmd_help: + + +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> diff --git a/docs/cmd_sample.rst b/docs/cmd_sample.rst index 3c3013af..1c652e4e 100644 --- a/docs/cmd_sample.rst +++ b/docs/cmd_sample.rst @@ -1,1368 +1,10 @@ .. 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. .. _cli_cmd_sample: -onap-amsterdam -============== - - - -cloud-delete ------------- - -input:: - - --cloud-name huawei-cloud-test --region-name bangalore-test --resource-version 1509027982352 - - -cloud-create ------------- - -input:: - - --cloud-name huawei-cloud --region-name bangalore - - -cloud-list ----------- - -output:: - - +--------------+------------+------------------+ - |cloud |region |resource-version | - +--------------+------------+------------------+ - |huawei-cloud |bangalore |1509027332165 | - +--------------+------------+------------------+ - |Rackspace |RegionOne |1508827902543 | - +--------------+------------+------------------+ - -vnfm-list ---------- - -output:: - - +--------------------------------------+--------------------------------------+------------------+------------------+ - |vnfm-id |vim-id |certificate-url |resource-version | - +--------------------------------------+--------------------------------------+------------------+------------------+ - |c0ecd788-22f4-49a4-a969-68051cd517e7 |acc5e14e-1320-4ab5-97fe-b7cc82ad03f2 | |1509094328901 | - +--------------------------------------+--------------------------------------+------------------+------------------+ - -vnfm-unregister ---------------- - -input:: - - --vnfm-id c0ecd788-22f4-49a4-a969-68051cd517e7 --resource-version 1509094328901 - - -vnfm-show ---------- - -input:: - - --vnfm-id c0ecd788-22f4-49a4-a969-68051cd517e7 - -output:: - - +----------+------------------+ - |property |value | - +----------+------------------+ - |name |vnfm1 | - +----------+------------------+ - |type |OpenStack | - +----------+------------------+ - |vendor |ONAP | - +----------+------------------+ - |version |1.0 | - +----------+------------------+ - |url |http://10.0.1.1 | - +----------+------------------+ - -vnfm-register -------------- - -input:: - - --vim-id acc5e14e-1320-4ab5-97fe-b7cc82ad03f2 --name vnfm1 --type OpenStack --vendor ONAP --vnfm-version 1.0 --url http://10.0.1.1 --username admin --password password - - -vim-list --------- - -input:: - - --cloud-name huawei-cloud --region-name bangalore --long - -output:: - - +--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+ - |vim-id |name |type |vendor |version |url |username |cloud-domain |default-tenant |resource-version | - +--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+ - |acc5e14e-1320-4ab5-97fe-b7cc82ad03f2 |RegionOne |OpenStack |Devstack |newton |http://192.168.16.149/identity |onap |default |onap |1509093477505 | - +--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+ - |810edb5a-42e9-462d-9587-96bc9272ac27 |vim1 |OpenStack |Devstack |newton |http://192.168.16.149/identity |onap |default |onap |1509093590932 | - +--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+ - -vim-register ------------- - -input:: - - --cloud-name huawei-cloud --region-name bangalore --name vim1 --type OpenStack --vendor Devstack --vim-version newton --url http://192.168.16.149/identity --username onap --password onap --cloud-domain default --default-tenant onap - - -vim-unregister --------------- - -input:: - - --vim-id 810edb5a-42e9-462d-9587-96bc9272ac27 --cloud-name huawei-cloud --region-name bangalore --resource-version 1509093590932 - - -ems-register ------------- - -input:: - - --name ems1 --type ems --vendor boco --ems-version 1.0 --url http://10.0.0.1 --username admin --password password --remote-path sample - - -ems-unregister --------------- - -input:: - - --ems-id 51a480ed-649c-4c47-a84b-f966dc4f9554 --resource-version 1509095358658 - - -ems-list --------- - -output:: - - +--------------------------------------+------------------+ - |ems-id |resource-version | - +--------------------------------------+------------------+ - |51a480ed-649c-4c47-a84b-f966dc4f9554 |1509095358658 | - +--------------------------------------+------------------+ - -ems-show --------- - -input:: - - --ems-id 51a480ed-649c-4c47-a84b-f966dc4f9554 - -output:: - - +------+------+--------+----------+------------------+ - |name |type |vendor |version |url | - +------+------+--------+----------+------------------+ - |ems1 |ems |boco |1.0 |http://10.0.0.1 | - +------+------+--------+----------+------------------+ - -subscription-delete -------------------- - -input:: - - --customer-name kanag --service-type vFW-kanag --resource-version 1509079144326 - - -subscription-list ------------------ - -input:: - - --customer-name kanag - -output:: - - +--------------+------------------+ - |service-type |resource-version | - +--------------+------------------+ - |vFW-kanag |1509079144326 | - +--------------+------------------+ - -subscription-create -------------------- - -input:: - - --customer-name kanag --cloud-name huawei-cloud --cloud-region bangalore --cloud-tenant-id e18173e6-6a13-4614-a13c-3859e7321103 --service-type vFW-kanag - - -customer-delete ---------------- - -input:: - - --customer-name test --resource-version 1509029022293 - - -customer-show -------------- - -input:: - - --customer-name kanag --long - -output:: - - +--------+------------------+------------------+------------------+ - |name |subscriber-name |resource-version |subscriber-type | - +--------+------------------+------------------+------------------+ - |kanag |kanag |1509029007060 |INFRA | - +--------+------------------+------------------+------------------+ - -customer-create ---------------- - -input:: - - --customer-name test --subscriber-name test - - -customer-list -------------- - -output:: - - +----------------+------------------+ - |name |resource-version | - +----------------+------------------+ - |test |1509029022293 | - +----------------+------------------+ - |kanag |1509029007060 | - +----------------+------------------+ - |Demonstration |1508827908763 | - +----------------+------------------+ - -vf-show -------- - -input:: - - --vf-id 1a667ce8-8b8b-4f59-ba5c-b162ae462fef -m https://192.168.17.111:8443 -u AAI -p AAI - -output:: - - +------------------------+--------------------------------------+ - |property |value | - +------------------------+--------------------------------------+ - |vf-id |1a667ce8-8b8b-4f59-ba5c-b162ae462fef | - +------------------------+--------------------------------------+ - |vf-name |vlb-cli-sample-8 | - +------------------------+--------------------------------------+ - |vf-type |demoVLB/null | - +------------------------+--------------------------------------+ - |model-invariant-id |cc34cd54-dd7c-44cd-8847-f9577c6f1a49 | - +------------------------+--------------------------------------+ - |model-uuid |8b1f63f3-e0cc-4c27-8903-fafe2f25bfbe | - +------------------------+--------------------------------------+ - |model-customization-id |cf893f5a-1bb1-4e32-a92b-2456e12178f8 | - +------------------------+--------------------------------------+ - |service-id |2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee | - +------------------------+--------------------------------------+ - -service-list ------------- - -input:: - - -x Demonstration -y vLB --long - -output:: - - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |service-id |service-name |model-invariant-id |model-uuid |description | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |1db042a9-6b28-4290-baba-872d32eeecf2 |sample-instance |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |9244629b-4ae4-48a0-bac0-b76937105ec7 |demo-vlb-vid |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |912d6d8d-9534-41d0-9323-289e81d4e399 |sample-instance-3 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |26b4ea72-d119-4345-95c8-568b08a093aa |sample-service-onap-cli-2 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |b2ebdb88-cfa5-496f-93a5-d535accbf56a |sample-instance-1 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |01eb6e59-5c28-4c76-85c7-a6b1e48058b9 |sample-service-onap-cli-4 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |03acb854-647b-4cf9-bfd8-a76083bb7266 |sample-service-onap-cli-3 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |14a9d485-63de-4ce2-b763-133ec3ce3d23 |sample-service-onap-cli-8 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |fdb98970-9de8-48a3-a321-d02693d2d1ad |sample-service-onap-cli-9 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |50de14d5-73d6-458e-880e-de8278b6f944 |test |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee |sample-instance-cli-10 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |4415727d-dc2a-4378-a3a7-bc4411d391c7 |sample-service-onap-cli-5 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - -vf-list -------- - -input:: - - -x Demonstration -y vLB --service-id 2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee - -output:: - - +--------------------------------------+--------------------+ - |vf-id |vf-name | - +--------------------------------------+--------------------+ - |1a667ce8-8b8b-4f59-ba5c-b162ae462fef |vlb-cli-sample-8 | - +--------------------------------------+--------------------+ - |048c2c4a-ee30-41a1-bb55-c4e7fe1a9a0d |vlb-cli-sample-11 | - +--------------------------------------+--------------------+ - |c37c401f-a839-4b6e-9c65-33e023c412ee |vlb-cli-sample-10 | - +--------------------------------------+--------------------+ - |b544f164-97c9-483a-98eb-eafd1f808e79 |vlb-cli-sample-5 | - +--------------------------------------+--------------------+ - |5ef95bd9-4d7a-4d06-879e-0c7964f9de65 |vlb-cli-sample-4 | - +--------------------------------------+--------------------+ - |eb29edb5-0a9f-4bc6-a7bf-3211341fffc2 |vlb-cli-sample-9 | - +--------------------------------------+--------------------+ - |2a152730-f6eb-4dc6-9b81-7a6f6f263d71 |vlb-cli-sample-1 | - +--------------------------------------+--------------------+ - |f53cd512-e172-410e-87b4-37064b5b5f8c |vlb-cli-sample-7 | - +--------------------------------------+--------------------+ - |f4bfcd6a-2ea1-42ab-853a-5d863b150c40 |vlb-cli-sample-3 | - +--------------------------------------+--------------------+ - |4bb4beaa-5b6b-414e-97d8-53949bbb5c5e |vlb-cli-sample-6 | - +--------------------------------------+--------------------+ - -service-type-list ------------------ - -output:: - - +--------------------------------------+--------------+------------------+ - |service-type-id |service-type |resource-version | - +--------------------------------------+--------------+------------------+ - |2733fe6f-8725-48fa-8609-092a34106dba |vIMS |1508827920395 | - +--------------------------------------+--------------+------------------+ - |bc549d9d-2335-4b07-9f03-3a85439c0bbb |vFW-kanag |1509029699189 | - +--------------------------------------+--------------+------------------+ - |de1fa33f-f676-42e5-b79a-a39825c19b1d |test |1509029708094 | - +--------------------------------------+--------------+------------------+ - |1482d2f2-b9e6-4421-a2f6-31959278db6f |vCPE |1508827919819 | - +--------------------------------------+--------------+------------------+ - |4426c557-e012-47eb-85cc-6128fa4f55c1 |vLB |1508827918467 | - +--------------------------------------+--------------+------------------+ - |dd04cc4b-6283-480d-8c5a-2c7bba8497ea |vFW |1508827917148 | - +--------------------------------------+--------------+------------------+ - -service-type-delete -------------------- - -input:: - - --service-type-id de1fa33f-f676-42e5-b79a-a39825c19b1d --resource-version 1509029708094 - - -service-type-create -------------------- - -input:: - - --service-type test - - -microservice-create -------------------- - -input:: - - --service-name test --service-version v1 --service-url /test --path /test 10.0.0.1 8080 - -output:: - - +----------+--------------+ - |property |value | - +----------+--------------+ - |name |test | - +----------+--------------+ - |version |v1 | - +----------+--------------+ - |url |/test | - +----------+--------------+ - |status |1 | - +----------+--------------+ - -microservice-list ------------------ - -input:: - - --long - -output:: - - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |name |version |url |status |nodes |enable-ssl |path | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-actions |v11 |/aai/v11/actions |1 |10.0.1.1:8443 |true | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-actions-deprecated |v11 |/aai/v11/actions |1 |10.0.1.1:8443 |true |/aai/v11/actions | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-business |v11 |/aai/v11/business |1 |10.0.1.1:8443 |true | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-business-deprecated |v11 |/aai/v11/business |1 |10.0.1.1:8443 |true |/aai/v11/business | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-cloudInfrastructure |v11 |/aai/v11/cloud-infrastructure |1 |10.0.1.1:8443 |true | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-cloudInfrastructure-deprecated |v11 |/aai/v11/cloud-infrastructure |1 |10.0.1.1:8443 |true |/aai/v11/cloud-infrastructure | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-esr-gui |v1 |/esr-gui |1 |10.0.14.1:9519 |false |/iui/aai-esr-gui | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-esr-server |v1 |/api/aai-esr-server/v1 |1 |172.17.0.5:9518 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-externalSystem |v11 |/aai/v11/external-system |1 |10.0.14.1:9518 |true | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-externalSystem-deprecated |v11 |/aai/v11/external-system |1 |10.0.1.1:8443 |true |/aai/v11/external-system | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-network |v11 |/aai/v11/network |1 |10.0.1.1:8443 |true | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-network-deprecated |v11 |/aai/v11/network |1 |10.0.1.1:8443 |true |/aai/v11/network | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-search |v11 |/aai/v11/search |1 |10.0.1.1:8443 |true | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-search-deprecated |v11 |/aai/v11/search |1 |10.0.1.1:8443 |true |/aai/v11/search | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-service-design-and-creation |v11 |/aai/v11/service-design-and-creation |1 |10.0.1.1:8443 |true | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-service-design-and-creation-deprecated |v11 |/aai/v11/service-design-and-creation |1 |10.0.1.1:8443 |true |/aai/v11/service-design-and-creation | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |activiti |v1 |/api/activiti/v1 |1 |10.0.1.1:8443 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |activiti-rest |v1 |/activiti-rest |1 |10.0.14.1:8804 |false |/activiti-rest | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |catalog |v1 |/api/catalog/v1 |1 |10.0.14.1:8804 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |emsdriver |v1 |/api/emsdriver/v1 |1 |172.17.0.15:8806 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |gvnfmdriver |v1 |/api/gvnfmdriver/v1 |1 |10.0.14.1:8806 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |huaweivnfmdriver |v1 |/api/huaweivnfmdriver/v1 |1 |10.0.14.1:8206 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |jujuvnfmdriver |v1 |/api/jujuvnfmdriver/v1 |1 |172.17.0.17:8484 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |multicloud |v0 |/api/multicloud/v0 |1 |10.0.14.1:8484 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |multicloud-ocata |v0 |/api/multicloud-ocata/v0 |1 |10.0.14.1:8482 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |multicloud-titanium_cloud |v0 |/api/multicloud-titanium_cloud/v0 |1 |10.0.14.1:8483 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |multicloud-vio |v0 |/api/multicloud-vio/v0 |1 |10.0.14.1:9001 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |nokia-vnfm-driver |v1 |/api/nokiavnfmdriver/v1 |1 |10.0.14.1:9006 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |nokiavnfmdriver |v1 |/api/nokiavnfmdriver/v1 |1 |10.0.14.1:9005 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |nslcm |v1 |/api/nslcm/v1 |1 |10.0.14.1:9004 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |policy-pdp |v1 |/pdp |1 |172.17.0.27:8486 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |policy-pdp-deprecated |v1 |/pdp |1 |10.0.14.1:8485 |false |/pdp | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |portal |v2 |/ |1 |172.17.0.20:8403 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |resmgr |v1 |/api/resmgr/v1 |1 |10.0.14.1:8403 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |sdc |v1 |/sdc/v1 |1 |10.0.6.1:8081 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |sdc-deprecated |v1 |/sdc/v1 |1 |10.0.6.1:8081 |false |/sdc/v1 | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |sdnc |v1 |/restconf |1 |10.0.9.1:8989 |false |/restconf | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |so |v1 |/ecomp/mso/infra |1 |10.0.14.1:8480 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |so-deprecated |v1 |/ecomp/mso/infra |1 |10.0.3.1:8080 |false |/ecomp/mso/infra | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |usecase-ui |v1 |/usecase-ui |1 |10.0.3.1:8080 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |usecaseui |v1 |/api/usecaseui/server/v1 |1 |10.0.7.1:8282 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |usecaseui-gui |v1 |/iui/usecaseui |1 |10.0.5.1:8080 |false |/iui/usecaseui | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |vnflcm |v1 |/api/vnflcm/v1 |1 |10.0.5.1:8080 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |vnfmgr |v1 |/api/vnfmgr/v1 |1 |172.17.0.11:8080 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |vnfres |v1 |/api/vnfres/v1 |1 |10.0.14.1:8901 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |workflow |v1 |/api/workflow/v1 |1 |10.0.14.1:8900 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |ztesdncdriver |v1 |/api/ztesdncdriver/v1 |1 |10.0.14.1:8801 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |ztevmanagerdriver |v1 |/api/ztevmanagerdriver/v1 |1 |172.17.0.22:8801 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |172.17.0.23:8803 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |10.0.14.1:8803 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |172.17.0.24:8802 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |10.0.14.1:8802 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |10.0.14.1:8805 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |172.17.0.25:8411 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |10.0.14.1:8411 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |10.0.14.1:8410 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |172.17.0.26:8410 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - -microservice-show ------------------ - -input:: - - --service-name test --service-version v1 --long - -output:: - - +------------+----------------+ - |property |value | - +------------+----------------+ - |name |test | - +------------+----------------+ - |version |v1 | - +------------+----------------+ - |url |/test | - +------------+----------------+ - |status |1 | - +------------+----------------+ - |nodes |10.0.0.1:8080 | - +------------+----------------+ - |enable-ssl |false | - +------------+----------------+ - |path |/test | - +------------+----------------+ - -microservice-delete -------------------- - -input:: - - --service-name test --service-version v1 --host-url http://192.168.17.23:80 --node-ip 23.14.15.156 --node-port 80 - - -vlm-feature-group-list ----------------------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0 - -output:: - - +----------------------------------+--------------+ - |ID |name | - +----------------------------------+--------------+ - |3a2fb75b52a54e9c8093e7c154210f9e |kanag-cli-fg | - +----------------------------------+--------------+ - -vlm-submit ----------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 1.1 - - -vlm-revert ----------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 0.1 - - -vlm-entitlement-pool-list -------------------------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0 - -output:: - - +----------------------------------+--------------------------+ - |ID |name | - +----------------------------------+--------------------------+ - |dae0a02f2173444e82bfa765601abcc9 |797153a1-d8f6-4eb0-abfc | - +----------------------------------+--------------------------+ - |aa61080fd965455ba5edbf60f4e375ef |kanag-cli-ep | - +----------------------------------+--------------------------+ - -vlm-checkout ------------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 0.1 - - -vlm-aggreement-create ---------------------- - -input:: - - --name kanag-cli-la --description kanag cli la --vlm-feature-group-id 3a2fb75b52a54e9c8093e7c154210f9e --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 1.1 - -output:: - - +----------+----------------------------------+ - |property |value | - +----------+----------------------------------+ - |ID |77e151d0503b45ecb7e40f5f5f1a887e | - +----------+----------------------------------+ - -vlm-key-group-create --------------------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --name kanag-cli-kg --description Kanag CLI key group -d --vlm-version 0.1 - -output:: - - |property |value | - +----------+----------------------------------+ - |ID |c37a1f205f444161a573f55dfec5f170 | - +----------+----------------------------------+ - -vlm-feature-group-create ------------------------- - -input:: - - --name kanag-cli-fg --description Kanag cli feature group --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 0.1 --vlm-key-group-id c37a1f205f444161a573f55dfec5f170 --vlm-entitle-pool-id aa61080fd965455ba5edbf60f4e375ef --part-number 123455 --manufacture-reference-number mkr123456 - -output:: - - +----------+----------------------------------+ - |property |value | - +----------+----------------------------------+ - |ID |3a2fb75b52a54e9c8093e7c154210f9e | - +----------+----------------------------------+ - -vlm-create ----------- - -input:: - - --vendor-name kanag-cli --description First License created from CLI - -output:: - - +----------+----------------------------------+ - |property |value | - +----------+----------------------------------+ - |ID |cf2d907d998e44698ce3b4cded5f66a7 | - +----------+----------------------------------+ - -vlm-entitlement-pool-create ---------------------------- - -input:: - - --name kanag-cli-ep --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --description kanag vlm ep --manufacture-reference-number mkr123456 -d --vlm-version 0.1 - -output:: - - +----------+----------------------------------+ - |property |value | - +----------+----------------------------------+ - |ID |aa61080fd965455ba5edbf60f4e375ef | - +----------+----------------------------------+ - -vlm-checkin ------------ - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 1.1 - - -vlm-key-group-list ------------------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0 - -output:: - - +----------------------------------+----------------------+ - |ID |name | - +----------------------------------+----------------------+ - |c37a1f205f444161a573f55dfec5f170 |kanag-cli-kg | - +----------------------------------+----------------------+ - |f0a684fa680b44979edee03fcc12ca85 |kanag-cli-key-group | - +----------------------------------+----------------------+ - -vlm-aggreement-list -------------------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0 - -output:: - - +----------------------------------+--------------+ - |ID |name | - +----------------------------------+--------------+ - |1e2edfccaca847f896070d0fac26667a |sf | - +----------------------------------+--------------+ - |77e151d0503b45ecb7e40f5f5f1a887e |kanag-cli-la | - +----------------------------------+--------------+ - -vlm-list --------- - -input:: - - --long - -output:: - - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |id |vendor-name |vlm-version |status |description | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |b5ea95a60e3b483da03d0911968cd778 |ciLicensef008e06a |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |84352b5d014c4d5382ce856d7597aebf |ciLicense5c11752c |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |8e13a8b2e1f34374ad578edc9c912f11 |ciLicenseaf880546 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |9f7053ae1aa04b8c9fa3d991f944a49b |ciLicensecce293bb |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |3f47950121bf4e31a058b4870020bc2f |ciLicense7d28e221 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |6fc132eca87d4e49b56357b9d83843a5 |ciLicense02ddba7e |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |0094601590ec4e709e560e928c44232a |ciLicense9acc959f |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |8f82813eb6304957911955e077d9be6f |ciLicensee5394ee2 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |b620898b5e5e4231a30a2ccecd39927e |ciLicense3eed3665 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |12cce4998b874d5e8096070f9c5d7395 |ciLicense372060ea |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |78fd596a39534d51953e867adaef78f6 |ciLicense36e962a4 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |651180d666c54887880b673884e03481 |ciLicensef9a1b52b |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |dd10e18e3af54234a20897ad65bfa311 |ciLicense76f62092 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |cf2d907d998e44698ce3b4cded5f66a7 |kanag-cli |2.0 |Final |First License created from CLI | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |144497a1b7924e0fa73004573730e1b8 |Test |0.1 |Locked |test | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |9af398f516da4e63b4ec8d344866533b |4718de22-00d3-4607-b666 |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |1173c7be5fea4db799b1a5ef9512e57e |Kanag |4.0 |Final |Kanagaraj M @ HTIPL | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |fc0fdcc825a54ca3b08e40f473b72d05 |test-vendor |1.0 |Final |test | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |b66c5e1b4af3432ca2f6cd05adf72340 |0138a2e2-52bf-4f0b-81cd |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |34c2c72e992742e3b7ceb78bfcd21ebb |48fa02ef-e79b-4707-895e |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |4bbd11c581ce4bb187a0a37131e5bb60 |1e5d1422-1f5f-42fe-a98e |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |1329476d73014587839fd3ede08c3103 |3029be5e-9135-4083-bd2e |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |2ca684a9805b40f9993239e77b82fb52 |c6ba2ef6-fe82-4f32-ad50 |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |1a49df7b78654777a71f64f2c6c2468f |01eb54a1-f1ff-41a2-aafc |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |5e571e8a25c8404da04f2a0ec179f576 |a920b10d-c516-4380-835a |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |4b1e1efd8bb944bdbc0c3e74a9402967 |ciLicense7d8bbcab |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |816c04fd4ee849f2b80435e0944189fa |ciLicense09c55d35 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |9408208f5b6d4eb997dff1b901f1fb95 |ciLicense6bfd9421 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |eda4e9d1cae14cad95befc1728629574 |ciLicense81acf730 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |022140c2dc4e40bbae096aa1fb5cfbe9 |ciLicensef3f5a4fa |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |19f92b345cae423ab4ea6c5527d55ef6 |ciLicense9fddd8db |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |492d9259fc3e493d8fa6afd488054508 |ciLicense9a46fd22 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |a5da3e50ed72483fbfb134bac84b31f6 |ciLicensed955b6d7 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |9ff65b0b943141a7b99481bbcaedc294 |ciLicensef21d8db3 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - -vsp-show --------- - -input:: - - --vsp-id a8cd007fa101470e98516cd4549c568f --vsp-version 1.0 --long - -output:: - - +--------------+----------------------------------+ - |property |value | - +--------------+----------------------------------+ - |name |847cb26a-59a6-475a-94dd | - +--------------+----------------------------------+ - |ID |a8cd007fa101470e98516cd4549c568f | - +--------------+----------------------------------+ - |description |vendor software product | - +--------------+----------------------------------+ - |vendor-name |01eb54a1-f1ff-41a2-aafc | - +--------------+----------------------------------+ - |vendor-id |1a49df7b78654777a71f64f2c6c2468f | - +--------------+----------------------------------+ - |version |1.0 | - +--------------+----------------------------------+ - |status |Final | - +--------------+----------------------------------+ - |license-id |99e3783033de443db69d05996341e28d | - +--------------+----------------------------------+ - -vsp-checkin ------------ - -input:: - - --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1 - - -vsp-submit ----------- - -input:: - - --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1 - - -vsp-create ----------- - -input:: - - --vsp-name kanag-cli-VLB --vsp-description VLB created from CLI --vlm-agreement-id 77e151d0503b45ecb7e40f5f5f1a887e --vlm-version 2.0 --vlm-feature-group-id 3a2fb75b52a54e9c8093e7c154210f9e --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-vendor Kanag-cli - -output:: - - +----------+----------------------------------+ - |property |value | - +----------+----------------------------------+ - |ID |f19cad8343794e93acb9cda2e4126281 | - +----------+----------------------------------+ - -vsp-list --------- - -output:: - - +----------------------------------+----------------------------------------------------+----------+------------+ - |ID |name |version |status | - +----------------------------------+----------------------------------------------------+----------+------------+ - |f19cad8343794e93acb9cda2e4126281 |kanag-cli-VLB |2.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |ff5bba2672a44654b186d70cf6bc9d95 |kanagVLB |0.1 |Locked | - +----------------------------------+----------------------------------------------------+----------+------------+ - |aa1f969cf1ae4897aed5fe08d4d19a5a |ciVFOnboarded-vCSCF_aligned-08dc1256 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |f22e285e6b354033bd9a2c1cf9268a6e |ciVFOnboarded-Huawei_vMME-2b29f653 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |3430c70e504c45d59cd7ccb4a388f26d |ciVFOnboarded-Huawei_vPCRF_aligned_fixed-51f1da14 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |c1ec9ea4fbd240cd9e69070a7ac17ee8 |ciVFOnboarded-vSBC_aligned-7260da5f |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |4668d80cbca64beb98423c924b35d3ac |ciVFOnboarded-Huawei_vHSS-79402346 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |10e8667c8b3d4e86a406e806430b989e |ciVFOnboarded-vLB-6265cbc3 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |9de86126015f4349a41e5a5f5e3eacf4 |ciVFOnboarded-base_vfw-199667fb |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |9641f81b61504fa8af6885818b1ee34b |ciVFOnboarded-vgmux-a195f793 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |dea92da0ad90419c8f437222680a2333 |ciVFOnboarded-vgw-abaa9d6d |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |9e4654364fe04d9ebe2a2485d67d6676 |ciVFOnboarded-infra-fceb5908 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |93b5df6c2f3d4a7dae362b111b0ed047 |ciVFOnboarded-vbrgemu-bcfb002c |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |9c9a9000fc714e9d8a6baf495418ab96 |ciVFOnboarded-base_vvg-07839bb9 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |63898b542cdd46b6b15ac771abda86cb |ciVFOnboarded-vbng-008f4205 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |5ca119e2326045d1857ae3f04a816434 |kanag-cli-vfw |0.2 |Available | - +----------------------------------+----------------------------------------------------+----------+------------+ - |e65baf44883e4868ba96f9faed9ba97a |600a2ebf-1f94-4a4c-b18d |0.3 |Available | - +----------------------------------+----------------------------------------------------+----------+------------+ - |61bad2139ee742cf891ca6ecc5f39972 |test-vsp-123 |0.2 |Locked | - +----------------------------------+----------------------------------------------------+----------+------------+ - |77527347f94947589431cb7c1938da2e |05a0dd09-c3d0-4534-93ab |0.3 |Locked | - +----------------------------------+----------------------------------------------------+----------+------------+ - |8f08a17b9a4c4538b51a3064468baec0 |test-vsp |0.3 |Locked | - +----------------------------------+----------------------------------------------------+----------+------------+ - |b1caa2ec31ba4b738cbe5aab362b35aa |Kanag-VSP |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |03774c7cfcac4054bdab346142214533 |ef35d3c9-a8c6-457c-a115 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |54bc478b7a9847db82156edad5d1f79f |5d11dda4-fb32-4df6-86eb |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |5f5121f701df4fe588c966002a342fdf |136ab241-88ff-443a-88e8 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |0cefd6ef5ad84d2995d66d0a24d2e92e |8fd2e5c8-981d-4a14-ba77 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |c212437049004e74b4ef0afb25ba41b8 |74361ede-ef8c-43f1-9d82 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |a8cd007fa101470e98516cd4549c568f |847cb26a-59a6-475a-94dd |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |59c07e069c7642e9afbc6117965a6c2f |ciVFOnboarded-vLB-3fbbe6d0 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |65b7b4b564f34b5689b3786386600e5a |ciVFOnboarded-vCSCF_aligned-a5e83f2c |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |a75d123c802e465db80ae7c8e5a0b4d0 |ciVFOnboarded-base_vfw-548fb561 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |1f33fcc682cb484a952b96326f549aff |ciVFOnboarded-vgmux-5e7cab8c |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |bafdf7192a73436588044296aa225ed4 |ciVFOnboarded-vgw-8b2ea35e |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |c34167a92e5c4c3392badd5a2da2a267 |ciVFOnboarded-infra-0766a3d1 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |b160564a4b754a9e8a19d2fa924f3f96 |ciVFOnboarded-vbrgemu-806fb59e |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |c5ccbc48510240318b698a4f1e1cb620 |ciVFOnboarded-vbng-c9fa1c07 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |34ac9b3e990f4ce093d2dd1b8e0f73d6 |ciVFOnboarded-base_vvg-e8b8c6ca |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - -vsp-upload ----------- - -input:: - - --vsp-id E563CB23A6BE49AF9A84CF579DAFB929 --vsp-file /home/user/vFW.zip - - -vsp-package ------------ - -input:: - - --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.2 - - -vsp-checkout ------------- - -input:: - - --onap-username cs0008 --onap-password demo123456! --host-url http://localhost:8080 --vsp-id E563CB23A6BE49AF9A84CF579DAFB929 - - -vsp-validate ------------- - -input:: - - --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1 - -output:: - - +----------+----------------------------------------------------+ - |property |value | - +----------+----------------------------------------------------+ - |status |Success | - +----------+----------------------------------------------------+ - |errors |{dnsscaling.yaml=[{"level":"WARNING","message":"WA | - | |RNING: Port 'Fixed_IPS' Parameter Name not | - | |aligned with Guidelines, Parameter Name | - | |[vlb_private_net_id], Resource ID | - | |[vdns_2_private_0_port]. As a result, VF\/VFC | - | |Profile may miss this information"},{"level":"WARN | - | |ING","message":"WARNING: Port 'Fixed_IPS' | - | |Parameter Name not aligned with Guidelines, | - | |Parameter Name [onap_private_subnet_id], Resource | - | |ID [vdns_2_private_1_port]. As a result, VF\/VFC | - | |Profile may miss this information"},{"level":"WARN | - | |ING","message":"WARNING: Nova Server naming | - | |convention in image, flavor and name properties | - | |is not consistent, Resource ID [vdns_2]"}], base_v | - | |lb.yaml=[{"level":"WARNING","message":"WARNING: | - | |Port 'Fixed_IPS' Parameter Name not aligned with | - | |Guidelines, Parameter Name | - | |[onap_private_subnet_id], Resource ID | - | |[vlb_private_1_port]. As a result, VF\/VFC | - | |Profile may miss this information"},{"level":"WARN | - | |ING","message":"WARNING: Port 'Fixed_IPS' | - | |Parameter Name not aligned with Guidelines, | - | |Parameter Name [onap_private_subnet_id], Resource | - | |ID [vdns_private_1_port]. As a result, VF\/VFC | - | |Profile may miss this information"},{"level":"WARN | - | |ING","message":"WARNING: Port 'Fixed_IPS' | - | |Parameter Name not aligned with Guidelines, | - | |Parameter Name [onap_private_subnet_id], Resource | - | |ID [vpg_private_1_port]. As a result, VF\/VFC | - | |Profile may miss this information"},{"level":"WARN | - | |ING","message":"WARNING: A resource is connected | - | |twice to the same network role, Network Role | - | |[vdns_0], Resource ID [onap_private]"},{"level":"W | - | |ARNING","message":"WARNING: Nova Server naming | - | |convention in image, flavor and name properties | - | |is not consistent, Resource ID | - | |[vdns_0]"},{"level":"WARNING","message":"WARNING: | - | |Missing Nova Server Metadata property, Resource | - | |ID | - | |[vpg_0]"},{"level":"WARNING","message":"WARNING: | - | |A resource is connected twice to the same network | - | |role, Network Role [vpg_0], Resource ID [onap_priv | - | |ate]"},{"level":"WARNING","message":"WARNING: | - | |Nova Server naming convention in image, flavor | - | |and name properties is not consistent, Resource | - | |ID [vpg_0]"}]} | - +----------+----------------------------------------------------+ - -vsp-revert ----------- - -input:: - - --vsp-id e65baf44883e4868ba96f9faed9ba97a --vsp-version 0.2 - - -vsp-checkout ------------- - -input:: - - --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1 - - -service-model-checkin ---------------------- - -input:: - - --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 - - -service-model-certify-request ------------------------------ - -input:: - - --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 - - -service2vf-model-list ---------------------- - -input:: - - --service-model-id 0f4203a8-a314-47bb-9a7d-28157652cec4 - -output:: - - +--------------------------------------+--------------------------+--------------------------------------+------------+ - |vf-uuid |vf-name |vf-customization-uuid |vf-version | - +--------------------------------------+--------------------------+--------------------------------------+------------+ - |047b9ff8-2414-45b7-b753-26342369f160 |847cb26a-59a6-475a-94dd |cf893f5a-1bb1-4e32-a92b-2456e12178f8 |1.0 | - +--------------------------------------+--------------------------+--------------------------------------+------------+ - -service-model-certify-start ---------------------------- - -input:: - - --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 - - -service-model-add-vf --------------------- - -input:: - - --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 --vf-id 828be6cf-c11b-4759-ac37-b1b79f86a4b4 --vf-name kanag-cli-VLB --vf-version 1.0 -d - -output:: - - +----------+----------------------------------------------------+ - |property |value | - +----------+----------------------------------------------------+ - |ID |7b427dbf-685b-4ba9-8838-a9b3b3c8e584.828be6cf-c11b | - | |-4759-ac37-b1b79f86a4b4.kanagclivlb0 | - +----------+----------------------------------------------------+ - -service-model-certify-complete ------------------------------- - -input:: - - --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 - - -service-model-list ------------------- - -output:: - - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |uuid |invariant-uuid |name |version |status |distribution-status | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |0f4203a8-a314-47bb-9a7d-28157652cec4 |1de901ed-17af-4b03-bc1f-41659cfa27cb |demoVLB |1.0 |CERTIFIED |DISTRIBUTED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |5ca7c6cb-78dc-4cf5-ab02-52c9ffb8c884 |9288833a-5dd6-4f9d-84ff-b34de06011c6 |kanagVLB |0.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |75caf010-9f14-424d-93c4-9f8fe8be7970 |b51013b7-e2bb-4abb-8f45-8e32113264b3 |demoVFW |1.0 |CERTIFIED |DISTRIBUTION_APPROVED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |fa9d6078-2d59-4c03-b97e-b57436680513 |5790901b-c109-4fc3-947a-ab71aa064251 |vLB-kanag |0.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |ba5a19b1-3219-4f30-bfd3-3b2f700c0157 |c4425f23-fc9a-4cbf-a3b7-12e69054806b |kanag-cli-VLB |1.0 |CERTIFIED |DISTRIBUTION_APPROVED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |5b054e09-9cc3-49bd-8962-e014465e295b |3a6a08c8-9bbe-4650-a1c5-687fb1012b98 |Kanag-vFW-Service |1.0 |CERTIFIED |DISTRIBUTED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |c9aa6a9c-dddd-4019-8f7b-70c09de68e96 |dd04c1c2-beb2-4b6c-997d-c94fae54fb57 |demoVCPE |1.0 |CERTIFIED |DISTRIBUTED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |f2a9f7e3-ead9-4585-8f5f-665acc6cff1c |b51013b7-e2bb-4abb-8f45-8e32113264b3 |demoVFW |1.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |d2df45ed-89c1-4d23-a605-bae03ee1f14f |566c6ab2-f32e-4022-acd3-cf2bf17ae6fc |a6484bba-671f-49c2-92fc |0.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - -service-model-create --------------------- - -input:: - - --name kanag-cli-VLB --description VLB created from CLI --project-code kanag-123456 - -output:: - - +----------+--------------------------------------+ - |property |value | - +----------+--------------------------------------+ - |ID |7b427dbf-685b-4ba9-8838-a9b3b3c8e584 | - +----------+--------------------------------------+ - -service-model-distribute ------------------------- - -input:: - - --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 - - -vf2vfmodule-model-list ----------------------- - -input:: - - --vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff - -output:: - - +----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+ - |vsp-uuid |vsp-version |module-uuid |module-invariant-uuid |module-name |module-version | - +----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+ - |f19cad8343794e93acb9cda2e4126281 |2.0 |f2fbc712-7adc-4a62-aa24-485ae076bdc7 |a610a6b9-adfb-4f9f-ada2-c054194092ad |KanagCliVlb..base_vlb..module-0 |1 | - +----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+ - | | |c420e361-900a-4705-9329-868e7fa6d9a5 |cde91552-bdb8-4cae-b4c2-c63069d77fe1 |KanagCliVlb..dnsscaling..module-1 |1 | - +----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+ - -vf-model-certify-request ------------------------- - -input:: - - --vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff - - -vf-model-create ---------------- - -input:: - - --name kanag-cli-VLB --description VF created from CLI --vendor-name Kanag-cli --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 2.0 - -output:: - - +----------+--------------------------------------+ - |property |value | - +----------+--------------------------------------+ - |ID |66269482-0b27-40e3-9c4d-6a26fb67d9ff | - +----------+--------------------------------------+ - -vf-model-certify-start ----------------------- - -input:: - - --vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff - - -vf-model-list -------------- - -output:: - - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |uuid |uniqueid |invariant-uuid |name |version |status | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |9859e26c-2af2-427b-a837-04a47996d52a |dac5b070-e53b-44b3-8034-46c9cf797de3 |d3d50449-a81a-497f-97b3-4eb770ea67e7 |Kanag-VSP |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |8b1f63f3-e0cc-4c27-8903-fafe2f25bfbe |047b9ff8-2414-45b7-b753-26342369f160 |cc34cd54-dd7c-44cd-8847-f9577c6f1a49 |847cb26a-59a6-475a-94dd |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |46c89121-b37f-4192-8841-25c93165b843 |828be6cf-c11b-4759-ac37-b1b79f86a4b4 |2d455337-57eb-4edf-a8b9-9f87fd85bc0e |kanag-cli-VLB |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |c763b7f8-6bc3-42a2-afa7-04157f79b629 |6e29f979-6f36-4c0d-8605-e59da8d62cb7 |1bd7f899-01dc-4d7f-97d8-f38ba6b40dd9 |74361ede-ef8c-43f1-9d82 |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |94d78d38-d5ae-4a92-9d9e-fb79fc55195a |3a3fb778-1c0e-41a1-9a04-f7ddaaf93d73 |414da4ea-e482-4ed2-9941-bd90108376fa |136ab241-88ff-443a-88e8 |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |3575fbff-614c-4418-93c7-133dc4fc59b6 |f4be1629-c9a1-4f32-8f34-11eddabffc13 |7fd3788f-a065-4270-bb95-852eae3a94b3 |ef35d3c9-a8c6-457c-a115 |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |87c5f870-809f-4488-aae5-80ef0fd9e085 |372e2c66-ee59-4488-a6a6-546c28b3a151 |244b380b-acf1-4545-8d35-d6d01bc32fd6 |5d11dda4-fb32-4df6-86eb |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |d49dd5ee-bc53-44d7-a067-e4cba9a3be1a |23018f7f-fbce-479e-a77b-6b98ebf03266 |6bc22345-395d-4358-8954-45963761f968 |8fd2e5c8-981d-4a14-ba77 |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - -vf-model-certify-complete -------------------------- - -input:: - - --vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff - - -vf-model-checkin ----------------- - -input:: - - --vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff - - -service-create --------------- - -input:: - - --cloud-region RegionOne --tenant-id onap --model-invariant-id 1de901ed-17af-4b03-bc1f-41659cfa27cb --model-uuid ace39141-09ec-4068-b06d-ac6b23bdc6e0 --model-name demoVLB --model-version 1.0 -c Demonstration --instance-name sample-service-onap-cli-13 --service-type vLB - -output:: - - +--------------+--------------------------------------+ - |property |value | - +--------------+--------------------------------------+ - |service-id |957949b4-f857-497c-81b0-832ce7bb9434 | - +--------------+--------------------------------------+ - -vf-create ---------- - -input:: - - --cloud-region RegionOne --tenant-id onap --product-family vLB --instance-name vlb-cli-sample-11 --service-instance-id 2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee --vf-model-invariant-id cc34cd54-dd7c-44cd-8847-f9577c6f1a49 --vf-model-uuid 8b1f63f3-e0cc-4c27-8903-fafe2f25bfbe --vf-model-name 847cb26a-59a6-475a-94dd --vf-model-version 1.0 --vf-model-customization-id cf893f5a-1bb1-4e32-a92b-2456e12178f8 --service-model-invariant-id 1de901ed-17af-4b03-bc1f-41659cfa27cb --service-model-uuid ace39141-09ec-4068-b06d-ac6b23bdc6e0 --service-model-name demoVLB --service-model-version 1.0 -m http://192.168.17.121:8080 -u InfraPortalClient -p password1$ - -output:: - - +--------------+--------------------------------------+ - |property |value | - +--------------+--------------------------------------+ - |vf-id |048c2c4a-ee30-41a1-bb55-c4e7fe1a9a0d | - +--------------+--------------------------------------+ -openecomp -========= - - - -vsp-create ----------- - -input:: - - --onap-username cs0008 --onap-password demo123456! --host-url http://locahost:8080 --vsp-name demo-vsp2 --vsp-vendor-name 5aa8a88c --vsp-vendor-id DBB202617952486691C1E35C9 621CD4E --license-agreement-id E19DBDDB137B494385F9535325BFD585 --feature-group-id 94835F096DAF4ED78781A394A4F22AD1 - -output:: - - +----------+----------------------------------+ - |property |value | - +----------+----------------------------------+ - |ID |6897DFFF8E864F84AD17A34B7FB936A3 | - +----------+----------------------------------+ - -vsp-submit ----------- - -input:: - - --onap-username cs0008 --onap-password demo123456! --host-url http://localhost:8080 --vsp-id E563CB23A6BE49AF9A84CF579DAFB929 - - -vsp-list --------- - -input:: - - --onap-username cs0008 --onap-password demo123456! --host-url http://localhost:8080 - -output:: - - +----------------------------------+------------+ - |ID |name | - +----------------------------------+------------+ - |E563CB23A6BE49AF9A84CF579DAFB929 |demo-vsp2 | - +----------------------------------+------------+ - |79E62AA736C34E359B869E757D3DDBBE |demo-vsp1 | - +----------------------------------+------------+ - |928B828EE3CC46B99B92D7B9A2AB2118 |demo-vsp | - +----------------------------------+------------+ - -vsp-checkin ------------ - -input:: - - --onap-username cs0008 --onap-password demo123456! --host-url http://localhost:8080 --vsp-id E563CB23A6BE49AF9A84CF579DAFB929 - - -vsp-upload ----------- - -input:: - - --onap-username cs0008 --onap-password demo123456! --host-url http://localhost:8080 --vsp-id E563CB23A6BE49AF9A84CF579DAFB929 --vsp-file /home/user/vFW.zip - - -vsp-show --------- - -input:: - - --onap-username cs0008 --onap-password demo123456! --host-url http://localhost:8080 --vsp-id 2DEB6CB4B082415BB7A697C9CD1273BA - -output:: - - +----------+----------------------------------+--------------------------+ - |name |ID |description | - +----------+----------------------------------+--------------------------+ - |test-vsp |2DEB6CB4B082415BB7A697C9CD1273BA |vendor software product | - +----------+----------------------------------+--------------------------+ - open-cli ======== diff --git a/docs/cmd_sample_onap_amsterdam.rst b/docs/cmd_sample_onap_amsterdam.rst new file mode 100644 index 00000000..fd767d03 --- /dev/null +++ b/docs/cmd_sample_onap_amsterdam.rst @@ -0,0 +1,1290 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2018 Huawei Technologies Co., Ltd. + +.. _cli_cmd_sample: + + +onap-amsterdam +============== + + + +cloud-delete +------------ + +input:: + + --cloud-name huawei-cloud-test --region-name bangalore-test --resource-version 1509027982352 + + +cloud-create +------------ + +input:: + + --cloud-name huawei-cloud --region-name bangalore + + +cloud-list +---------- + +output:: + + +--------------+------------+------------------+ + |cloud |region |resource-version | + +--------------+------------+------------------+ + |huawei-cloud |bangalore |1509027332165 | + +--------------+------------+------------------+ + |Rackspace |RegionOne |1508827902543 | + +--------------+------------+------------------+ + +vnfm-list +--------- + +output:: + + +--------------------------------------+--------------------------------------+------------------+------------------+ + |vnfm-id |vim-id |certificate-url |resource-version | + +--------------------------------------+--------------------------------------+------------------+------------------+ + |c0ecd788-22f4-49a4-a969-68051cd517e7 |acc5e14e-1320-4ab5-97fe-b7cc82ad03f2 | |1509094328901 | + +--------------------------------------+--------------------------------------+------------------+------------------+ + +vnfm-unregister +--------------- + +input:: + + --vnfm-id c0ecd788-22f4-49a4-a969-68051cd517e7 --resource-version 1509094328901 + + +vnfm-show +--------- + +input:: + + --vnfm-id c0ecd788-22f4-49a4-a969-68051cd517e7 + +output:: + + +----------+------------------+ + |property |value | + +----------+------------------+ + |name |vnfm1 | + +----------+------------------+ + |type |OpenStack | + +----------+------------------+ + |vendor |ONAP | + +----------+------------------+ + |version |1.0 | + +----------+------------------+ + |url |http://10.0.1.1 | + +----------+------------------+ + +vnfm-register +------------- + +input:: + + --vim-id acc5e14e-1320-4ab5-97fe-b7cc82ad03f2 --name vnfm1 --type OpenStack --vendor ONAP --vnfm-version 1.0 --url http://10.0.1.1 --username admin --password password + + +vim-list +-------- + +input:: + + --cloud-name huawei-cloud --region-name bangalore --long + +output:: + + +--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+ + |vim-id |name |type |vendor |version |url |username |cloud-domain |default-tenant |resource-version | + +--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+ + |acc5e14e-1320-4ab5-97fe-b7cc82ad03f2 |RegionOne |OpenStack |Devstack |newton |http://192.168.16.149/identity |onap |default |onap |1509093477505 | + +--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+ + |810edb5a-42e9-462d-9587-96bc9272ac27 |vim1 |OpenStack |Devstack |newton |http://192.168.16.149/identity |onap |default |onap |1509093590932 | + +--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+ + +vim-register +------------ + +input:: + + --cloud-name huawei-cloud --region-name bangalore --name vim1 --type OpenStack --vendor Devstack --vim-version newton --url http://192.168.16.149/identity --username onap --password onap --cloud-domain default --default-tenant onap + + +vim-unregister +-------------- + +input:: + + --vim-id 810edb5a-42e9-462d-9587-96bc9272ac27 --cloud-name huawei-cloud --region-name bangalore --resource-version 1509093590932 + + +ems-register +------------ + +input:: + + --name ems1 --type ems --vendor boco --ems-version 1.0 --url http://10.0.0.1 --username admin --password password --remote-path sample + + +ems-unregister +-------------- + +input:: + + --ems-id 51a480ed-649c-4c47-a84b-f966dc4f9554 --resource-version 1509095358658 + + +ems-list +-------- + +output:: + + +--------------------------------------+------------------+ + |ems-id |resource-version | + +--------------------------------------+------------------+ + |51a480ed-649c-4c47-a84b-f966dc4f9554 |1509095358658 | + +--------------------------------------+------------------+ + +ems-show +-------- + +input:: + + --ems-id 51a480ed-649c-4c47-a84b-f966dc4f9554 + +output:: + + +------+------+--------+----------+------------------+ + |name |type |vendor |version |url | + +------+------+--------+----------+------------------+ + |ems1 |ems |boco |1.0 |http://10.0.0.1 | + +------+------+--------+----------+------------------+ + +subscription-delete +------------------- + +input:: + + --customer-name kanag --service-type vFW-kanag --resource-version 1509079144326 + + +subscription-list +----------------- + +input:: + + --customer-name kanag + +output:: + + +--------------+------------------+ + |service-type |resource-version | + +--------------+------------------+ + |vFW-kanag |1509079144326 | + +--------------+------------------+ + +subscription-create +------------------- + +input:: + + --customer-name kanag --cloud-name huawei-cloud --cloud-region bangalore --cloud-tenant-id e18173e6-6a13-4614-a13c-3859e7321103 --service-type vFW-kanag + + +customer-delete +--------------- + +input:: + + --customer-name test --resource-version 1509029022293 + + +customer-show +------------- + +input:: + + --customer-name kanag --long + +output:: + + +--------+------------------+------------------+------------------+ + |name |subscriber-name |resource-version |subscriber-type | + +--------+------------------+------------------+------------------+ + |kanag |kanag |1509029007060 |INFRA | + +--------+------------------+------------------+------------------+ + +customer-create +--------------- + +input:: + + --customer-name test --subscriber-name test + + +customer-list +------------- + +output:: + + +----------------+------------------+ + |name |resource-version | + +----------------+------------------+ + |test |1509029022293 | + +----------------+------------------+ + |kanag |1509029007060 | + +----------------+------------------+ + |Demonstration |1508827908763 | + +----------------+------------------+ + +vf-show +------- + +input:: + + --vf-id 1a667ce8-8b8b-4f59-ba5c-b162ae462fef -m https://192.168.17.111:8443 -u AAI -p AAI + +output:: + + +------------------------+--------------------------------------+ + |property |value | + +------------------------+--------------------------------------+ + |vf-id |1a667ce8-8b8b-4f59-ba5c-b162ae462fef | + +------------------------+--------------------------------------+ + |vf-name |vlb-cli-sample-8 | + +------------------------+--------------------------------------+ + |vf-type |demoVLB/null | + +------------------------+--------------------------------------+ + |model-invariant-id |cc34cd54-dd7c-44cd-8847-f9577c6f1a49 | + +------------------------+--------------------------------------+ + |model-uuid |8b1f63f3-e0cc-4c27-8903-fafe2f25bfbe | + +------------------------+--------------------------------------+ + |model-customization-id |cf893f5a-1bb1-4e32-a92b-2456e12178f8 | + +------------------------+--------------------------------------+ + |service-id |2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee | + +------------------------+--------------------------------------+ + +service-list +------------ + +input:: + + -x Demonstration -y vLB --long + +output:: + + +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ + |service-id |service-name |model-invariant-id |model-uuid |description | + +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ + |1db042a9-6b28-4290-baba-872d32eeecf2 |sample-instance |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | + +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ + |9244629b-4ae4-48a0-bac0-b76937105ec7 |demo-vlb-vid |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | + +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ + |912d6d8d-9534-41d0-9323-289e81d4e399 |sample-instance-3 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | + +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ + |26b4ea72-d119-4345-95c8-568b08a093aa |sample-service-onap-cli-2 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | + +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ + |b2ebdb88-cfa5-496f-93a5-d535accbf56a |sample-instance-1 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | + +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ + |01eb6e59-5c28-4c76-85c7-a6b1e48058b9 |sample-service-onap-cli-4 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | + +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ + |03acb854-647b-4cf9-bfd8-a76083bb7266 |sample-service-onap-cli-3 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | + +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ + |14a9d485-63de-4ce2-b763-133ec3ce3d23 |sample-service-onap-cli-8 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | + +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ + |fdb98970-9de8-48a3-a321-d02693d2d1ad |sample-service-onap-cli-9 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | + +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ + |50de14d5-73d6-458e-880e-de8278b6f944 |test |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | + +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ + |2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee |sample-instance-cli-10 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | + +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ + |4415727d-dc2a-4378-a3a7-bc4411d391c7 |sample-service-onap-cli-5 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | + +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ + +vf-list +------- + +input:: + + -x Demonstration -y vLB --service-id 2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee + +output:: + + +--------------------------------------+--------------------+ + |vf-id |vf-name | + +--------------------------------------+--------------------+ + |1a667ce8-8b8b-4f59-ba5c-b162ae462fef |vlb-cli-sample-8 | + +--------------------------------------+--------------------+ + |048c2c4a-ee30-41a1-bb55-c4e7fe1a9a0d |vlb-cli-sample-11 | + +--------------------------------------+--------------------+ + |c37c401f-a839-4b6e-9c65-33e023c412ee |vlb-cli-sample-10 | + +--------------------------------------+--------------------+ + |b544f164-97c9-483a-98eb-eafd1f808e79 |vlb-cli-sample-5 | + +--------------------------------------+--------------------+ + |5ef95bd9-4d7a-4d06-879e-0c7964f9de65 |vlb-cli-sample-4 | + +--------------------------------------+--------------------+ + |eb29edb5-0a9f-4bc6-a7bf-3211341fffc2 |vlb-cli-sample-9 | + +--------------------------------------+--------------------+ + |2a152730-f6eb-4dc6-9b81-7a6f6f263d71 |vlb-cli-sample-1 | + +--------------------------------------+--------------------+ + |f53cd512-e172-410e-87b4-37064b5b5f8c |vlb-cli-sample-7 | + +--------------------------------------+--------------------+ + |f4bfcd6a-2ea1-42ab-853a-5d863b150c40 |vlb-cli-sample-3 | + +--------------------------------------+--------------------+ + |4bb4beaa-5b6b-414e-97d8-53949bbb5c5e |vlb-cli-sample-6 | + +--------------------------------------+--------------------+ + +service-type-list +----------------- + +output:: + + +--------------------------------------+--------------+------------------+ + |service-type-id |service-type |resource-version | + +--------------------------------------+--------------+------------------+ + |2733fe6f-8725-48fa-8609-092a34106dba |vIMS |1508827920395 | + +--------------------------------------+--------------+------------------+ + |bc549d9d-2335-4b07-9f03-3a85439c0bbb |vFW-kanag |1509029699189 | + +--------------------------------------+--------------+------------------+ + |de1fa33f-f676-42e5-b79a-a39825c19b1d |test |1509029708094 | + +--------------------------------------+--------------+------------------+ + |1482d2f2-b9e6-4421-a2f6-31959278db6f |vCPE |1508827919819 | + +--------------------------------------+--------------+------------------+ + |4426c557-e012-47eb-85cc-6128fa4f55c1 |vLB |1508827918467 | + +--------------------------------------+--------------+------------------+ + |dd04cc4b-6283-480d-8c5a-2c7bba8497ea |vFW |1508827917148 | + +--------------------------------------+--------------+------------------+ + +service-type-delete +------------------- + +input:: + + --service-type-id de1fa33f-f676-42e5-b79a-a39825c19b1d --resource-version 1509029708094 + + +service-type-create +------------------- + +input:: + + --service-type test + + +microservice-create +------------------- + +input:: + + --service-name test --service-version v1 --service-url /test --path /test 10.0.0.1 8080 + +output:: + + +----------+--------------+ + |property |value | + +----------+--------------+ + |name |test | + +----------+--------------+ + |version |v1 | + +----------+--------------+ + |url |/test | + +----------+--------------+ + |status |1 | + +----------+--------------+ + +microservice-list +----------------- + +input:: + + --long + +output:: + + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |name |version |url |status |nodes |enable-ssl |path | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-actions |v11 |/aai/v11/actions |1 |10.0.1.1:8443 |true | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-actions-deprecated |v11 |/aai/v11/actions |1 |10.0.1.1:8443 |true |/aai/v11/actions | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-business |v11 |/aai/v11/business |1 |10.0.1.1:8443 |true | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-business-deprecated |v11 |/aai/v11/business |1 |10.0.1.1:8443 |true |/aai/v11/business | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-cloudInfrastructure |v11 |/aai/v11/cloud-infrastructure |1 |10.0.1.1:8443 |true | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-cloudInfrastructure-deprecated |v11 |/aai/v11/cloud-infrastructure |1 |10.0.1.1:8443 |true |/aai/v11/cloud-infrastructure | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-esr-gui |v1 |/esr-gui |1 |10.0.14.1:9519 |false |/iui/aai-esr-gui | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-esr-server |v1 |/api/aai-esr-server/v1 |1 |172.17.0.5:9518 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-externalSystem |v11 |/aai/v11/external-system |1 |10.0.14.1:9518 |true | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-externalSystem-deprecated |v11 |/aai/v11/external-system |1 |10.0.1.1:8443 |true |/aai/v11/external-system | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-network |v11 |/aai/v11/network |1 |10.0.1.1:8443 |true | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-network-deprecated |v11 |/aai/v11/network |1 |10.0.1.1:8443 |true |/aai/v11/network | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-search |v11 |/aai/v11/search |1 |10.0.1.1:8443 |true | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-search-deprecated |v11 |/aai/v11/search |1 |10.0.1.1:8443 |true |/aai/v11/search | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-service-design-and-creation |v11 |/aai/v11/service-design-and-creation |1 |10.0.1.1:8443 |true | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |aai-service-design-and-creation-deprecated |v11 |/aai/v11/service-design-and-creation |1 |10.0.1.1:8443 |true |/aai/v11/service-design-and-creation | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |activiti |v1 |/api/activiti/v1 |1 |10.0.1.1:8443 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |activiti-rest |v1 |/activiti-rest |1 |10.0.14.1:8804 |false |/activiti-rest | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |catalog |v1 |/api/catalog/v1 |1 |10.0.14.1:8804 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |emsdriver |v1 |/api/emsdriver/v1 |1 |172.17.0.15:8806 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |gvnfmdriver |v1 |/api/gvnfmdriver/v1 |1 |10.0.14.1:8806 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |huaweivnfmdriver |v1 |/api/huaweivnfmdriver/v1 |1 |10.0.14.1:8206 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |jujuvnfmdriver |v1 |/api/jujuvnfmdriver/v1 |1 |172.17.0.17:8484 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |multicloud |v0 |/api/multicloud/v0 |1 |10.0.14.1:8484 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |multicloud-ocata |v0 |/api/multicloud-ocata/v0 |1 |10.0.14.1:8482 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |multicloud-titanium_cloud |v0 |/api/multicloud-titanium_cloud/v0 |1 |10.0.14.1:8483 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |multicloud-vio |v0 |/api/multicloud-vio/v0 |1 |10.0.14.1:9001 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |nokia-vnfm-driver |v1 |/api/nokiavnfmdriver/v1 |1 |10.0.14.1:9006 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |nokiavnfmdriver |v1 |/api/nokiavnfmdriver/v1 |1 |10.0.14.1:9005 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |nslcm |v1 |/api/nslcm/v1 |1 |10.0.14.1:9004 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |policy-pdp |v1 |/pdp |1 |172.17.0.27:8486 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |policy-pdp-deprecated |v1 |/pdp |1 |10.0.14.1:8485 |false |/pdp | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |portal |v2 |/ |1 |172.17.0.20:8403 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |resmgr |v1 |/api/resmgr/v1 |1 |10.0.14.1:8403 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |sdc |v1 |/sdc/v1 |1 |10.0.6.1:8081 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |sdc-deprecated |v1 |/sdc/v1 |1 |10.0.6.1:8081 |false |/sdc/v1 | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |sdnc |v1 |/restconf |1 |10.0.9.1:8989 |false |/restconf | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |so |v1 |/ecomp/mso/infra |1 |10.0.14.1:8480 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |so-deprecated |v1 |/ecomp/mso/infra |1 |10.0.3.1:8080 |false |/ecomp/mso/infra | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |usecase-ui |v1 |/usecase-ui |1 |10.0.3.1:8080 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |usecaseui |v1 |/api/usecaseui/server/v1 |1 |10.0.7.1:8282 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |usecaseui-gui |v1 |/iui/usecaseui |1 |10.0.5.1:8080 |false |/iui/usecaseui | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |vnflcm |v1 |/api/vnflcm/v1 |1 |10.0.5.1:8080 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |vnfmgr |v1 |/api/vnfmgr/v1 |1 |172.17.0.11:8080 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |vnfres |v1 |/api/vnfres/v1 |1 |10.0.14.1:8901 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |workflow |v1 |/api/workflow/v1 |1 |10.0.14.1:8900 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |ztesdncdriver |v1 |/api/ztesdncdriver/v1 |1 |10.0.14.1:8801 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + |ztevmanagerdriver |v1 |/api/ztevmanagerdriver/v1 |1 |172.17.0.22:8801 |false | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + | | | | |172.17.0.23:8803 | | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + | | | | |10.0.14.1:8803 | | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + | | | | |172.17.0.24:8802 | | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + | | | | |10.0.14.1:8802 | | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + | | | | |10.0.14.1:8805 | | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + | | | | |172.17.0.25:8411 | | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + | | | | |10.0.14.1:8411 | | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + | | | | |10.0.14.1:8410 | | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + | | | | |172.17.0.26:8410 | | | + +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ + +microservice-show +----------------- + +input:: + + --service-name test --service-version v1 --long + +output:: + + +------------+----------------+ + |property |value | + +------------+----------------+ + |name |test | + +------------+----------------+ + |version |v1 | + +------------+----------------+ + |url |/test | + +------------+----------------+ + |status |1 | + +------------+----------------+ + |nodes |10.0.0.1:8080 | + +------------+----------------+ + |enable-ssl |false | + +------------+----------------+ + |path |/test | + +------------+----------------+ + +microservice-delete +------------------- + +input:: + + --service-name test --service-version v1 --host-url http://192.168.17.23:80 --node-ip 23.14.15.156 --node-port 80 + + +vlm-feature-group-list +---------------------- + +input:: + + --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0 + +output:: + + +----------------------------------+--------------+ + |ID |name | + +----------------------------------+--------------+ + |3a2fb75b52a54e9c8093e7c154210f9e |kanag-cli-fg | + +----------------------------------+--------------+ + +vlm-submit +---------- + +input:: + + --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 1.1 + + +vlm-revert +---------- + +input:: + + --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 0.1 + + +vlm-entitlement-pool-list +------------------------- + +input:: + + --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0 + +output:: + + +----------------------------------+--------------------------+ + |ID |name | + +----------------------------------+--------------------------+ + |dae0a02f2173444e82bfa765601abcc9 |797153a1-d8f6-4eb0-abfc | + +----------------------------------+--------------------------+ + |aa61080fd965455ba5edbf60f4e375ef |kanag-cli-ep | + +----------------------------------+--------------------------+ + +vlm-checkout +------------ + +input:: + + --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 0.1 + + +vlm-aggreement-create +--------------------- + +input:: + + --name kanag-cli-la --description kanag cli la --vlm-feature-group-id 3a2fb75b52a54e9c8093e7c154210f9e --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 1.1 + +output:: + + +----------+----------------------------------+ + |property |value | + +----------+----------------------------------+ + |ID |77e151d0503b45ecb7e40f5f5f1a887e | + +----------+----------------------------------+ + +vlm-key-group-create +-------------------- + +input:: + + --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --name kanag-cli-kg --description Kanag CLI key group -d --vlm-version 0.1 + +output:: + + |property |value | + +----------+----------------------------------+ + |ID |c37a1f205f444161a573f55dfec5f170 | + +----------+----------------------------------+ + +vlm-feature-group-create +------------------------ + +input:: + + --name kanag-cli-fg --description Kanag cli feature group --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 0.1 --vlm-key-group-id c37a1f205f444161a573f55dfec5f170 --vlm-entitle-pool-id aa61080fd965455ba5edbf60f4e375ef --part-number 123455 --manufacture-reference-number mkr123456 + +output:: + + +----------+----------------------------------+ + |property |value | + +----------+----------------------------------+ + |ID |3a2fb75b52a54e9c8093e7c154210f9e | + +----------+----------------------------------+ + +vlm-create +---------- + +input:: + + --vendor-name kanag-cli --description First License created from CLI + +output:: + + +----------+----------------------------------+ + |property |value | + +----------+----------------------------------+ + |ID |cf2d907d998e44698ce3b4cded5f66a7 | + +----------+----------------------------------+ + +vlm-entitlement-pool-create +--------------------------- + +input:: + + --name kanag-cli-ep --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --description kanag vlm ep --manufacture-reference-number mkr123456 -d --vlm-version 0.1 + +output:: + + +----------+----------------------------------+ + |property |value | + +----------+----------------------------------+ + |ID |aa61080fd965455ba5edbf60f4e375ef | + +----------+----------------------------------+ + +vlm-checkin +----------- + +input:: + + --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 1.1 + + +vlm-key-group-list +------------------ + +input:: + + --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0 + +output:: + + +----------------------------------+----------------------+ + |ID |name | + +----------------------------------+----------------------+ + |c37a1f205f444161a573f55dfec5f170 |kanag-cli-kg | + +----------------------------------+----------------------+ + |f0a684fa680b44979edee03fcc12ca85 |kanag-cli-key-group | + +----------------------------------+----------------------+ + +vlm-aggreement-list +------------------- + +input:: + + --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0 + +output:: + + +----------------------------------+--------------+ + |ID |name | + +----------------------------------+--------------+ + |1e2edfccaca847f896070d0fac26667a |sf | + +----------------------------------+--------------+ + |77e151d0503b45ecb7e40f5f5f1a887e |kanag-cli-la | + +----------------------------------+--------------+ + +vlm-list +-------- + +input:: + + --long + +output:: + + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |id |vendor-name |vlm-version |status |description | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |b5ea95a60e3b483da03d0911968cd778 |ciLicensef008e06a |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |84352b5d014c4d5382ce856d7597aebf |ciLicense5c11752c |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |8e13a8b2e1f34374ad578edc9c912f11 |ciLicenseaf880546 |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |9f7053ae1aa04b8c9fa3d991f944a49b |ciLicensecce293bb |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |3f47950121bf4e31a058b4870020bc2f |ciLicense7d28e221 |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |6fc132eca87d4e49b56357b9d83843a5 |ciLicense02ddba7e |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |0094601590ec4e709e560e928c44232a |ciLicense9acc959f |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |8f82813eb6304957911955e077d9be6f |ciLicensee5394ee2 |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |b620898b5e5e4231a30a2ccecd39927e |ciLicense3eed3665 |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |12cce4998b874d5e8096070f9c5d7395 |ciLicense372060ea |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |78fd596a39534d51953e867adaef78f6 |ciLicense36e962a4 |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |651180d666c54887880b673884e03481 |ciLicensef9a1b52b |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |dd10e18e3af54234a20897ad65bfa311 |ciLicense76f62092 |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |cf2d907d998e44698ce3b4cded5f66a7 |kanag-cli |2.0 |Final |First License created from CLI | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |144497a1b7924e0fa73004573730e1b8 |Test |0.1 |Locked |test | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |9af398f516da4e63b4ec8d344866533b |4718de22-00d3-4607-b666 |1.0 |Final |vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |1173c7be5fea4db799b1a5ef9512e57e |Kanag |4.0 |Final |Kanagaraj M @ HTIPL | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |fc0fdcc825a54ca3b08e40f473b72d05 |test-vendor |1.0 |Final |test | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |b66c5e1b4af3432ca2f6cd05adf72340 |0138a2e2-52bf-4f0b-81cd |1.0 |Final |vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |34c2c72e992742e3b7ceb78bfcd21ebb |48fa02ef-e79b-4707-895e |1.0 |Final |vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |4bbd11c581ce4bb187a0a37131e5bb60 |1e5d1422-1f5f-42fe-a98e |1.0 |Final |vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |1329476d73014587839fd3ede08c3103 |3029be5e-9135-4083-bd2e |1.0 |Final |vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |2ca684a9805b40f9993239e77b82fb52 |c6ba2ef6-fe82-4f32-ad50 |1.0 |Final |vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |1a49df7b78654777a71f64f2c6c2468f |01eb54a1-f1ff-41a2-aafc |1.0 |Final |vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |5e571e8a25c8404da04f2a0ec179f576 |a920b10d-c516-4380-835a |1.0 |Final |vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |4b1e1efd8bb944bdbc0c3e74a9402967 |ciLicense7d8bbcab |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |816c04fd4ee849f2b80435e0944189fa |ciLicense09c55d35 |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |9408208f5b6d4eb997dff1b901f1fb95 |ciLicense6bfd9421 |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |eda4e9d1cae14cad95befc1728629574 |ciLicense81acf730 |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |022140c2dc4e40bbae096aa1fb5cfbe9 |ciLicensef3f5a4fa |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |19f92b345cae423ab4ea6c5527d55ef6 |ciLicense9fddd8db |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |492d9259fc3e493d8fa6afd488054508 |ciLicense9a46fd22 |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |a5da3e50ed72483fbfb134bac84b31f6 |ciLicensed955b6d7 |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + |9ff65b0b943141a7b99481bbcaedc294 |ciLicensef21d8db3 |1.0 |Final |new vendor license model | + +----------------------------------+--------------------------+--------------+--------+--------------------------------+ + +vsp-show +-------- + +input:: + + --vsp-id a8cd007fa101470e98516cd4549c568f --vsp-version 1.0 --long + +output:: + + +--------------+----------------------------------+ + |property |value | + +--------------+----------------------------------+ + |name |847cb26a-59a6-475a-94dd | + +--------------+----------------------------------+ + |ID |a8cd007fa101470e98516cd4549c568f | + +--------------+----------------------------------+ + |description |vendor software product | + +--------------+----------------------------------+ + |vendor-name |01eb54a1-f1ff-41a2-aafc | + +--------------+----------------------------------+ + |vendor-id |1a49df7b78654777a71f64f2c6c2468f | + +--------------+----------------------------------+ + |version |1.0 | + +--------------+----------------------------------+ + |status |Final | + +--------------+----------------------------------+ + |license-id |99e3783033de443db69d05996341e28d | + +--------------+----------------------------------+ + +vsp-checkin +----------- + +input:: + + --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1 + + +vsp-submit +---------- + +input:: + + --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1 + + +vsp-create +---------- + +input:: + + --vsp-name kanag-cli-VLB --vsp-description VLB created from CLI --vlm-agreement-id 77e151d0503b45ecb7e40f5f5f1a887e --vlm-version 2.0 --vlm-feature-group-id 3a2fb75b52a54e9c8093e7c154210f9e --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-vendor Kanag-cli + +output:: + + +----------+----------------------------------+ + |property |value | + +----------+----------------------------------+ + |ID |f19cad8343794e93acb9cda2e4126281 | + +----------+----------------------------------+ + +vsp-list +-------- + +output:: + + +----------------------------------+----------------------------------------------------+----------+------------+ + |ID |name |version |status | + +----------------------------------+----------------------------------------------------+----------+------------+ + |f19cad8343794e93acb9cda2e4126281 |kanag-cli-VLB |2.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |ff5bba2672a44654b186d70cf6bc9d95 |kanagVLB |0.1 |Locked | + +----------------------------------+----------------------------------------------------+----------+------------+ + |aa1f969cf1ae4897aed5fe08d4d19a5a |ciVFOnboarded-vCSCF_aligned-08dc1256 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |f22e285e6b354033bd9a2c1cf9268a6e |ciVFOnboarded-Huawei_vMME-2b29f653 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |3430c70e504c45d59cd7ccb4a388f26d |ciVFOnboarded-Huawei_vPCRF_aligned_fixed-51f1da14 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |c1ec9ea4fbd240cd9e69070a7ac17ee8 |ciVFOnboarded-vSBC_aligned-7260da5f |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |4668d80cbca64beb98423c924b35d3ac |ciVFOnboarded-Huawei_vHSS-79402346 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |10e8667c8b3d4e86a406e806430b989e |ciVFOnboarded-vLB-6265cbc3 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |9de86126015f4349a41e5a5f5e3eacf4 |ciVFOnboarded-base_vfw-199667fb |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |9641f81b61504fa8af6885818b1ee34b |ciVFOnboarded-vgmux-a195f793 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |dea92da0ad90419c8f437222680a2333 |ciVFOnboarded-vgw-abaa9d6d |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |9e4654364fe04d9ebe2a2485d67d6676 |ciVFOnboarded-infra-fceb5908 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |93b5df6c2f3d4a7dae362b111b0ed047 |ciVFOnboarded-vbrgemu-bcfb002c |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |9c9a9000fc714e9d8a6baf495418ab96 |ciVFOnboarded-base_vvg-07839bb9 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |63898b542cdd46b6b15ac771abda86cb |ciVFOnboarded-vbng-008f4205 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |5ca119e2326045d1857ae3f04a816434 |kanag-cli-vfw |0.2 |Available | + +----------------------------------+----------------------------------------------------+----------+------------+ + |e65baf44883e4868ba96f9faed9ba97a |600a2ebf-1f94-4a4c-b18d |0.3 |Available | + +----------------------------------+----------------------------------------------------+----------+------------+ + |61bad2139ee742cf891ca6ecc5f39972 |test-vsp-123 |0.2 |Locked | + +----------------------------------+----------------------------------------------------+----------+------------+ + |77527347f94947589431cb7c1938da2e |05a0dd09-c3d0-4534-93ab |0.3 |Locked | + +----------------------------------+----------------------------------------------------+----------+------------+ + |8f08a17b9a4c4538b51a3064468baec0 |test-vsp |0.3 |Locked | + +----------------------------------+----------------------------------------------------+----------+------------+ + |b1caa2ec31ba4b738cbe5aab362b35aa |Kanag-VSP |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |03774c7cfcac4054bdab346142214533 |ef35d3c9-a8c6-457c-a115 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |54bc478b7a9847db82156edad5d1f79f |5d11dda4-fb32-4df6-86eb |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |5f5121f701df4fe588c966002a342fdf |136ab241-88ff-443a-88e8 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |0cefd6ef5ad84d2995d66d0a24d2e92e |8fd2e5c8-981d-4a14-ba77 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |c212437049004e74b4ef0afb25ba41b8 |74361ede-ef8c-43f1-9d82 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |a8cd007fa101470e98516cd4549c568f |847cb26a-59a6-475a-94dd |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |59c07e069c7642e9afbc6117965a6c2f |ciVFOnboarded-vLB-3fbbe6d0 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |65b7b4b564f34b5689b3786386600e5a |ciVFOnboarded-vCSCF_aligned-a5e83f2c |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |a75d123c802e465db80ae7c8e5a0b4d0 |ciVFOnboarded-base_vfw-548fb561 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |1f33fcc682cb484a952b96326f549aff |ciVFOnboarded-vgmux-5e7cab8c |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |bafdf7192a73436588044296aa225ed4 |ciVFOnboarded-vgw-8b2ea35e |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |c34167a92e5c4c3392badd5a2da2a267 |ciVFOnboarded-infra-0766a3d1 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |b160564a4b754a9e8a19d2fa924f3f96 |ciVFOnboarded-vbrgemu-806fb59e |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |c5ccbc48510240318b698a4f1e1cb620 |ciVFOnboarded-vbng-c9fa1c07 |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + |34ac9b3e990f4ce093d2dd1b8e0f73d6 |ciVFOnboarded-base_vvg-e8b8c6ca |1.0 |Final | + +----------------------------------+----------------------------------------------------+----------+------------+ + +vsp-upload +---------- + +input:: + + --vsp-id E563CB23A6BE49AF9A84CF579DAFB929 --vsp-file /home/user/vFW.zip + + +vsp-package +----------- + +input:: + + --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.2 + + +vsp-checkout +------------ + +input:: + + --onap-username cs0008 --onap-password demo123456! --host-url http://localhost:8080 --vsp-id E563CB23A6BE49AF9A84CF579DAFB929 + + +vsp-validate +------------ + +input:: + + --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1 + +output:: + + +----------+----------------------------------------------------+ + |property |value | + +----------+----------------------------------------------------+ + |status |Success | + +----------+----------------------------------------------------+ + |errors |{dnsscaling.yaml=[{"level":"WARNING","message":"WA | + | |RNING: Port 'Fixed_IPS' Parameter Name not | + | |aligned with Guidelines, Parameter Name | + | |[vlb_private_net_id], Resource ID | + | |[vdns_2_private_0_port]. As a result, VF\/VFC | + | |Profile may miss this information"},{"level":"WARN | + | |ING","message":"WARNING: Port 'Fixed_IPS' | + | |Parameter Name not aligned with Guidelines, | + | |Parameter Name [onap_private_subnet_id], Resource | + | |ID [vdns_2_private_1_port]. As a result, VF\/VFC | + | |Profile may miss this information"},{"level":"WARN | + | |ING","message":"WARNING: Nova Server naming | + | |convention in image, flavor and name properties | + | |is not consistent, Resource ID [vdns_2]"}], base_v | + | |lb.yaml=[{"level":"WARNING","message":"WARNING: | + | |Port 'Fixed_IPS' Parameter Name not aligned with | + | |Guidelines, Parameter Name | + | |[onap_private_subnet_id], Resource ID | + | |[vlb_private_1_port]. As a result, VF\/VFC | + | |Profile may miss this information"},{"level":"WARN | + | |ING","message":"WARNING: Port 'Fixed_IPS' | + | |Parameter Name not aligned with Guidelines, | + | |Parameter Name [onap_private_subnet_id], Resource | + | |ID [vdns_private_1_port]. As a result, VF\/VFC | + | |Profile may miss this information"},{"level":"WARN | + | |ING","message":"WARNING: Port 'Fixed_IPS' | + | |Parameter Name not aligned with Guidelines, | + | |Parameter Name [onap_private_subnet_id], Resource | + | |ID [vpg_private_1_port]. As a result, VF\/VFC | + | |Profile may miss this information"},{"level":"WARN | + | |ING","message":"WARNING: A resource is connected | + | |twice to the same network role, Network Role | + | |[vdns_0], Resource ID [onap_private]"},{"level":"W | + | |ARNING","message":"WARNING: Nova Server naming | + | |convention in image, flavor and name properties | + | |is not consistent, Resource ID | + | |[vdns_0]"},{"level":"WARNING","message":"WARNING: | + | |Missing Nova Server Metadata property, Resource | + | |ID | + | |[vpg_0]"},{"level":"WARNING","message":"WARNING: | + | |A resource is connected twice to the same network | + | |role, Network Role [vpg_0], Resource ID [onap_priv | + | |ate]"},{"level":"WARNING","message":"WARNING: | + | |Nova Server naming convention in image, flavor | + | |and name properties is not consistent, Resource | + | |ID [vpg_0]"}]} | + +----------+----------------------------------------------------+ + +vsp-revert +---------- + +input:: + + --vsp-id e65baf44883e4868ba96f9faed9ba97a --vsp-version 0.2 + + +vsp-checkout +------------ + +input:: + + --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1 + + +service-model-checkin +--------------------- + +input:: + + --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 + + +service-model-certify-request +----------------------------- + +input:: + + --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 + + +service2vf-model-list +--------------------- + +input:: + + --service-model-id 0f4203a8-a314-47bb-9a7d-28157652cec4 + +output:: + + +--------------------------------------+--------------------------+--------------------------------------+------------+ + |vf-uuid |vf-name |vf-customization-uuid |vf-version | + +--------------------------------------+--------------------------+--------------------------------------+------------+ + |047b9ff8-2414-45b7-b753-26342369f160 |847cb26a-59a6-475a-94dd |cf893f5a-1bb1-4e32-a92b-2456e12178f8 |1.0 | + +--------------------------------------+--------------------------+--------------------------------------+------------+ + +service-model-certify-start +--------------------------- + +input:: + + --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 + + +service-model-add-vf +-------------------- + +input:: + + --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 --vf-id 828be6cf-c11b-4759-ac37-b1b79f86a4b4 --vf-name kanag-cli-VLB --vf-version 1.0 -d + +output:: + + +----------+----------------------------------------------------+ + |property |value | + +----------+----------------------------------------------------+ + |ID |7b427dbf-685b-4ba9-8838-a9b3b3c8e584.828be6cf-c11b | + | |-4759-ac37-b1b79f86a4b4.kanagclivlb0 | + +----------+----------------------------------------------------+ + +service-model-certify-complete +------------------------------ + +input:: + + --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 + + +service-model-list +------------------ + +output:: + + +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ + |uuid |invariant-uuid |name |version |status |distribution-status | + +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ + |0f4203a8-a314-47bb-9a7d-28157652cec4 |1de901ed-17af-4b03-bc1f-41659cfa27cb |demoVLB |1.0 |CERTIFIED |DISTRIBUTED | + +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ + |5ca7c6cb-78dc-4cf5-ab02-52c9ffb8c884 |9288833a-5dd6-4f9d-84ff-b34de06011c6 |kanagVLB |0.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED | + +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ + |75caf010-9f14-424d-93c4-9f8fe8be7970 |b51013b7-e2bb-4abb-8f45-8e32113264b3 |demoVFW |1.0 |CERTIFIED |DISTRIBUTION_APPROVED | + +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ + |fa9d6078-2d59-4c03-b97e-b57436680513 |5790901b-c109-4fc3-947a-ab71aa064251 |vLB-kanag |0.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED | + +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ + |ba5a19b1-3219-4f30-bfd3-3b2f700c0157 |c4425f23-fc9a-4cbf-a3b7-12e69054806b |kanag-cli-VLB |1.0 |CERTIFIED |DISTRIBUTION_APPROVED | + +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ + |5b054e09-9cc3-49bd-8962-e014465e295b |3a6a08c8-9bbe-4650-a1c5-687fb1012b98 |Kanag-vFW-Service |1.0 |CERTIFIED |DISTRIBUTED | + +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ + |c9aa6a9c-dddd-4019-8f7b-70c09de68e96 |dd04c1c2-beb2-4b6c-997d-c94fae54fb57 |demoVCPE |1.0 |CERTIFIED |DISTRIBUTED | + +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ + |f2a9f7e3-ead9-4585-8f5f-665acc6cff1c |b51013b7-e2bb-4abb-8f45-8e32113264b3 |demoVFW |1.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED | + +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ + |d2df45ed-89c1-4d23-a605-bae03ee1f14f |566c6ab2-f32e-4022-acd3-cf2bf17ae6fc |a6484bba-671f-49c2-92fc |0.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED | + +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ + +service-model-create +-------------------- + +input:: + + --name kanag-cli-VLB --description VLB created from CLI --project-code kanag-123456 + +output:: + + +----------+--------------------------------------+ + |property |value | + +----------+--------------------------------------+ + |ID |7b427dbf-685b-4ba9-8838-a9b3b3c8e584 | + +----------+--------------------------------------+ + +service-model-distribute +------------------------ + +input:: + + --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 + + +vf2vfmodule-model-list +---------------------- + +input:: + + --vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff + +output:: + + +----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+ + |vsp-uuid |vsp-version |module-uuid |module-invariant-uuid |module-name |module-version | + +----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+ + |f19cad8343794e93acb9cda2e4126281 |2.0 |f2fbc712-7adc-4a62-aa24-485ae076bdc7 |a610a6b9-adfb-4f9f-ada2-c054194092ad |KanagCliVlb..base_vlb..module-0 |1 | + +----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+ + | | |c420e361-900a-4705-9329-868e7fa6d9a5 |cde91552-bdb8-4cae-b4c2-c63069d77fe1 |KanagCliVlb..dnsscaling..module-1 |1 | + +----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+ + +vf-model-certify-request +------------------------ + +input:: + + --vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff + + +vf-model-create +--------------- + +input:: + + --name kanag-cli-VLB --description VF created from CLI --vendor-name Kanag-cli --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 2.0 + +output:: + + +----------+--------------------------------------+ + |property |value | + +----------+--------------------------------------+ + |ID |66269482-0b27-40e3-9c4d-6a26fb67d9ff | + +----------+--------------------------------------+ + +vf-model-certify-start +---------------------- + +input:: + + --vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff + + +vf-model-list +------------- + +output:: + + +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ + |uuid |uniqueid |invariant-uuid |name |version |status | + +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ + |9859e26c-2af2-427b-a837-04a47996d52a |dac5b070-e53b-44b3-8034-46c9cf797de3 |d3d50449-a81a-497f-97b3-4eb770ea67e7 |Kanag-VSP |1.0 |CERTIFIED | + +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ + |8b1f63f3-e0cc-4c27-8903-fafe2f25bfbe |047b9ff8-2414-45b7-b753-26342369f160 |cc34cd54-dd7c-44cd-8847-f9577c6f1a49 |847cb26a-59a6-475a-94dd |1.0 |CERTIFIED | + +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ + |46c89121-b37f-4192-8841-25c93165b843 |828be6cf-c11b-4759-ac37-b1b79f86a4b4 |2d455337-57eb-4edf-a8b9-9f87fd85bc0e |kanag-cli-VLB |1.0 |CERTIFIED | + +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ + |c763b7f8-6bc3-42a2-afa7-04157f79b629 |6e29f979-6f36-4c0d-8605-e59da8d62cb7 |1bd7f899-01dc-4d7f-97d8-f38ba6b40dd9 |74361ede-ef8c-43f1-9d82 |1.0 |CERTIFIED | + +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ + |94d78d38-d5ae-4a92-9d9e-fb79fc55195a |3a3fb778-1c0e-41a1-9a04-f7ddaaf93d73 |414da4ea-e482-4ed2-9941-bd90108376fa |136ab241-88ff-443a-88e8 |1.0 |CERTIFIED | + +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ + |3575fbff-614c-4418-93c7-133dc4fc59b6 |f4be1629-c9a1-4f32-8f34-11eddabffc13 |7fd3788f-a065-4270-bb95-852eae3a94b3 |ef35d3c9-a8c6-457c-a115 |1.0 |CERTIFIED | + +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ + |87c5f870-809f-4488-aae5-80ef0fd9e085 |372e2c66-ee59-4488-a6a6-546c28b3a151 |244b380b-acf1-4545-8d35-d6d01bc32fd6 |5d11dda4-fb32-4df6-86eb |1.0 |CERTIFIED | + +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ + |d49dd5ee-bc53-44d7-a067-e4cba9a3be1a |23018f7f-fbce-479e-a77b-6b98ebf03266 |6bc22345-395d-4358-8954-45963761f968 |8fd2e5c8-981d-4a14-ba77 |1.0 |CERTIFIED | + +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ + +vf-model-certify-complete +------------------------- + +input:: + + --vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff + + +vf-model-checkin +---------------- + +input:: + + --vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff + + +service-create +-------------- + +input:: + + --cloud-region RegionOne --tenant-id onap --model-invariant-id 1de901ed-17af-4b03-bc1f-41659cfa27cb --model-uuid ace39141-09ec-4068-b06d-ac6b23bdc6e0 --model-name demoVLB --model-version 1.0 -c Demonstration --instance-name sample-service-onap-cli-13 --service-type vLB + +output:: + + +--------------+--------------------------------------+ + |property |value | + +--------------+--------------------------------------+ + |service-id |957949b4-f857-497c-81b0-832ce7bb9434 | + +--------------+--------------------------------------+ + +vf-create +--------- + +input:: + + --cloud-region RegionOne --tenant-id onap --product-family vLB --instance-name vlb-cli-sample-11 --service-instance-id 2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee --vf-model-invariant-id cc34cd54-dd7c-44cd-8847-f9577c6f1a49 --vf-model-uuid 8b1f63f3-e0cc-4c27-8903-fafe2f25bfbe --vf-model-name 847cb26a-59a6-475a-94dd --vf-model-version 1.0 --vf-model-customization-id cf893f5a-1bb1-4e32-a92b-2456e12178f8 --service-model-invariant-id 1de901ed-17af-4b03-bc1f-41659cfa27cb --service-model-uuid ace39141-09ec-4068-b06d-ac6b23bdc6e0 --service-model-name demoVLB --service-model-version 1.0 -m http://192.168.17.121:8080 -u InfraPortalClient -p password1$ + +output:: + + +--------------+--------------------------------------+ + |property |value | + +--------------+--------------------------------------+ + |vf-id |048c2c4a-ee30-41a1-bb55-c4e7fe1a9a0d | + +--------------+--------------------------------------+ + + + diff --git a/docs/cookbook.rst b/docs/cookbook.rst index 9e68b2f7..a21e2015 100644 --- a/docs/cookbook.rst +++ b/docs/cookbook.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 2018 Huawei Technologies Co., Ltd. .. _cli_cookbook: diff --git a/docs/step_to_import_PNF.rst b/docs/pnf_on_boarding.rst index e8a4f351..bcf90833 100644 --- a/docs/step_to_import_PNF.rst +++ b/docs/pnf_on_boarding.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 2018 Huawei Technologies Co., Ltd. .. Step to import VNF/PNF: diff --git a/docs/user_guide.rst b/docs/user_guide.rst index e4da3d4d..e8b3515a 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -136,6 +136,8 @@ Following document provides the help message for commands supported in this rele :maxdepth: 1 cmd_help.rst + cmd_help_onap_amsterdam.rst + cmd_help_onap_beijing.rst Command Samples --------------- @@ -145,6 +147,7 @@ Following document provides the samples for commands supported in this release. :maxdepth: 1 cmd_sample.rst + cmd_sample_onap_amsterdam.rst End to end service creation tutorial ------------------------------------ @@ -155,11 +158,11 @@ Following document provides the tutorial for service creation using CLI. end_to_end_onap_cli_commands.rst -PNF/VNF creation tutorial +PNF/VNF on-boarding tutorial ------------------------------------ -Following document provides the tutorial for PNF/VNF creation tutorial using CLI. +Following document provides the tutorial for PNF/VNF on-boarding tutorial using CLI. .. toctree:: :maxdepth: 1 - step_to_import_PNF.rst
\ No newline at end of file + pnf_on_boarding.rst
\ No newline at end of file |