.. 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::
.. _cli_cmd_help:
-onap-1.1
+open-cli
==========================
-[1] microservice-show
+[1] basic-login
-----------------------------------------------
-usage: onap microservice-show
-Details the registered microservice in Onap
+usage: oclip basic-login
-Onap service: msb v1
-
-Options::
-
- [-x | --service-name] [-y | --service-version] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
-
-where::
-
- -x | --service-name Onap service name. It is of type STRING.
- -y | --service-version Onap service version. It is of type STRING.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
-
-
-Results::
-
- name Onap service name and is of type STRING.
- version Onap service version and is of type STRING.
- url Onap service base url and is of type URL.
- status Onap service status and is of type DIGIT.
- nodes Onap service running nodes and is of type JSON.
- enable-ssl Onap service is enabled with https or not and is
- of type STRING.
- path Onap service path and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[2] microservice-create
------------------------------------------------
-
-
-usage: onap microservice-create
-
-Register microservice into Onap
-
-Onap service: msb v1
-
-Options::
-
- [-x | --service-name] [-y | --service-version] [-r | --service-url]
- [-b | --enable-ssl] [-c | --path] <node-ip>
- <node-port> <create-or-update> [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
-
-where::
-
- -x | --service-name Onap service name. It is of type STRING.
- -y | --service-version Onap service version. It is of type STRING.
- -r | --service-url Onap service base url. It is of type URL.
- -b | --enable-ssl Onap service is enabled with https or not. It is
- of type STRING. It is optional.
- -c | --path Onap service path. It is of type STRING. It is
- optional.
- node-ip Onap service running node IP. It is of type
- STRING.
- node-port Onap service running node port. It is of type
- STRING.
- create-or-update Onap service create or update. It is of type
- BOOL. By default, it is false.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
-
-
-Results::
-
- 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 <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[3] microservice-delete
------------------------------------------------
-
-
-usage: onap microservice-delete
-
-Deletes the micro service from Onap
-
-Onap service: msb v1
-
-Options::
-
- [-x | --service-name] [-y | --service-version] [-i | --node-ip]
- [-r | --node-port] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title]
-
-where::
-
- -x | --service-name Onap service name. It is of type STRING.
- -y | --service-version Onap service version. It is of type STRING.
- -i | --node-ip Onap service running node IP. It is of type
- STRING.
- -r | --node-port Onap service running node port. It is of type
- STRING.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[4] microservice-list
------------------------------------------------
-
-
-usage: onap microservice-list
-
-Lists the registetred micro services in Onap
-
-Onap service: msb v1
-
-Options::
-
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title]
-
-where::
-
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
-
-
-Results::
-
- name Onap service name and is of type STRING.
- version Onap service version and is of type STRING.
- url Onap service base url and is of type URL.
- status Onap service status and is of type DIGIT.
- nodes Onap service running nodes and is of type JSON.
- enable-ssl Onap service is enabled with https or not and is
- of type STRING.
- path Onap service path and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[5] service-model-add-vnf
------------------------------------------------
-
-
-usage: onap service-model-add-vnf
-
-Helps to add VF into service models in SDC
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --service-model-id] [-y | --vf-id] [-z | --vf-version]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -x | --service-model-id Onap Service Name. It is of type STRING.
- -y | --vf-id VF ID. It is of type STRING. It is optional.
- -z | --vf-version VF version. It is of type STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID Service ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[6] service-model-approve
------------------------------------------------
-
-
-usage: onap service-model-approve
-
-Approves the Service model in SDC
-
-Onap service: sdc v1.0
-
-Options::
-
- [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -b | --service-model-id Service model ID. It is of type STRING. It is
- optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[7] service-model-list
------------------------------------------------
-
-
-usage: onap service-model-list
-
-List the service model in SDC
-
-Onap service: sdc v1.0
-
-Options::
-
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- uuid UUID and is of type STRING.
- invariant-uuid Invariant UUID and is of type STRING.
- name Name and is of type STRING.
- version version and is of type STRING.
- status status and is of type STRING.
- distribution-status status and is of type STRING.
- description description and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[8] service-model-certify-complete
------------------------------------------------
-
-
-usage: onap service-model-certify-complete
-
-Completes the certification of Service model in SDC
-
-Onap service: sdc v1.0
-
-Options::
-
- [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -b | --service-model-id Service model ID. It is of type STRING. It is
- optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[9] vlm-checkout
------------------------------------------------
-
-
-usage: onap vlm-checkout
-
-Checkout Vendor License Model
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vlm-id Onap VLM ID. It is of type STRING.
- -y | --vlm-version VLM version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[10] vlm-create
------------------------------------------------
-
-
-usage: onap vlm-create
-
-Create License Model
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vendor-name] [-y | --description] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vendor-name vendor name. It is of type STRING.
- -y | --description Description for License Model. It is of type
- STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID License Model ID and is of type UUID.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[11] vlm-entitlement-pool-create
------------------------------------------------
-
-
-usage: onap vlm-entitlement-pool-create
-
-Create Entitlement Pool
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --name] [-y | --vlm-id] [-e | --vlm-version]
- [-z | --description] [-g | --operational-scope] [-k | --manufacture-reference-number]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -x | --name Entitlement Pool name. It is of type STRING.
- -y | --vlm-id License Model ID. It is of type STRING.
- -e | --vlm-version License Model version. It is of type STRING.
- -z | --description Description for Entitlement Pool. It is of type
- STRING.
- -g | --operational-scope Operational Scope. It is of type STRING. By
- default, it is Availability_Zone.
- -k | --manufacture-reference-number Manufature Reference Number. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID Entitlement Pool ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[12] vlm-entitlement-pool-list
------------------------------------------------
-
-
-usage: onap vlm-entitlement-pool-list
-
-entitlement pool list in a license model
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vlm-id License Model ID. It is of type STRING.
- -y | --vlm-version License Model version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID Feature group ID and is of type STRING.
- name Feature group name and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[13] vlm-feature-group-create
------------------------------------------------
-
-
-usage: onap vlm-feature-group-create
-
-Create feature group Pool
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --name] [-y | --vlm-id] [-e | --vlm-version]
- [-z | --description] [-g | --vlm-key-group-id] [-b | --vlm-entitle-pool-id]
- [-c | --part-number] [-k | --manufacture-reference-number] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --name Feature group name. It is of type STRING.
- -y | --vlm-id License Model ID. It is of type STRING.
- -e | --vlm-version License Model version. It is of type STRING.
- -z | --description Description for feature group. It is of type
- STRING.
- -g | --vlm-key-group-id VLM keygroup. It is of type STRING.
- -b | --vlm-entitle-pool-id VLM Entitlement pool. It is of type STRING.
- -c | --part-number Part number. It is of type STRING.
- -k | --manufacture-reference-number Manufature Reference Number. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID Feature group ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[14] vlm-feature-group-list
------------------------------------------------
-
-
-usage: onap vlm-feature-group-list
-
-Feature group list in a license model
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vlm-id License Model ID. It is of type STRING.
- -y | --vlm-version License Model version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID Feature group ID and is of type STRING.
- name Feature group name and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[15] vlm-key-group-create
------------------------------------------------
-
-
-usage: onap vlm-key-group-create
-
-Create License Key Group
-
-Onap service: sdc v1.0
-
-Options::
-
- [-c | --vlm-id] [-e | --vlm-version] [-x | --name]
- [-y | --type] [-z | --description] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -c | --vlm-id License Model Id. It is of type STRING.
- -e | --vlm-version License Model version. It is of type STRING.
- -x | --name name. It is of type STRING.
- -y | --type type of group (Universal, unique, one-time). It
- is of type STRING. By default, it is Universal.
- -z | --description Description for License Key Group. It is of type
- STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID License Model ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[16] vlm-key-group-list
------------------------------------------------
-
-
-usage: onap vlm-key-group-list
-
-key group list in a license model
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vlm-id License Model ID. It is of type STRING.
- -y | --vlm-version License Model version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID Feature group ID and is of type STRING.
- name Feature group name and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[17] vlm-list
------------------------------------------------
-
-
-usage: onap vlm-list
-
-List License Model
-
-Onap service: sdc v1.0
-
-Options::
-
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- id License ID and is of type UUID.
- vendor-name Vendor Name and is of type STRING.
- vlm-version VLM version and is of type STRING.
- status status and is of type STRING.
- description License description and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[18] vlm-revert
------------------------------------------------
-
-
-usage: onap vlm-revert
-
-Revert Vendor License Model
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vlm-id Onap VLM ID. It is of type STRING.
- -y | --vlm-version VLM version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[19] vlm-submit
------------------------------------------------
-
-
-usage: onap vlm-submit
-
-Submit Vendor License Model
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vlm-id Onap VLM ID. It is of type STRING.
- -y | --vlm-version VLM version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[20] vsp-add-artifact
------------------------------------------------
-
-
-usage: onap vsp-add-artifact
-
-Upload the CSAR file to VSP
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vsp-id] [-y | --vsp-version] [-z | --vsp-file]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version Onap VSP version. It is of type STRING.
- -z | --vsp-file CSAR File path. It is of type BINARY.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[21] vsp-checkin
------------------------------------------------
-
-
-usage: onap vsp-checkin
-
-Checkin Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[22] vsp-checkout
------------------------------------------------
-
-
-usage: onap vsp-checkout
-
-Checkout Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[23] vsp-checkout
------------------------------------------------
-
-
-usage: onap vsp-checkout
-
-Checkout Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[24] vsp-create
------------------------------------------------
-
-
-usage: onap vsp-create
-
-Create Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vsp-name] [-y | --vsp-description] [-z | --vsp-category]
- [-b | --vsp-subcategory] [-c | --vsp-license-version] [-e | --vsp-vendor-name]
- [-g | --vsp-vendor-id] [-i | --license-agreement-id] [-j | --feature-group-id]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -x | --vsp-name Onap VSP Name. It is of type STRING.
- -y | --vsp-description Description for VSP. It is of type STRING. It is
- optional.
- -z | --vsp-category Category of the VSP. It is of type STRING. It is
- optional. By default, it is
- resourceNewCategory.generic.
- -b | --vsp-subcategory Sub Category of VSP. It is of type STRING. It is
- optional. By default, it is
- resourceNewCategory.generic.abstract.
- -c | --vsp-license-version License version. It is of type STRING. It is
- optional. By default, it is 1.0.
- -e | --vsp-vendor-name License Model Name. It is of type STRING.
- -g | --vsp-vendor-id License Model ID. It is of type STRING.
- -i | --license-agreement-id License Agreement ID. It is of type STRING.
- -j | --feature-group-id Feature Group ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID VSP ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[25] vsp-list
------------------------------------------------
-
-
-usage: onap vsp-list
-
-List of the Vendor Software Products
-
-Onap service: sdc v1.0
-
-Options::
-
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID VSP ID and is of type STRING.
- name VSP Name and is of type STRING.
- vendor-name Vendor name and is of type STRING.
- version Version and is of type STRING.
- status status and is of type STRING.
- license-id license aggreement and is of type STRING.
- license-version license version and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[26] vsp-package
------------------------------------------------
-
-
-usage: onap vsp-package
-
-Package Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[27] vsp-revert
------------------------------------------------
-
-
-usage: onap vsp-revert
-
-Revert Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[28] vsp-show
------------------------------------------------
-
-
-usage: onap vsp-show
-
-Details of the Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version Onap VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- name VSP Name and is of type STRING.
- ID VSP ID and is of type STRING.
- description Description for the VSP and is of type STRING.
- vendor-name Vendor name and is of type STRING.
- vendor-id Vendor id and is of type STRING.
- version Version and is of type STRING.
- status status and is of type STRING.
- license-id license aggreement and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[29] vsp-submit
------------------------------------------------
-
-
-usage: onap vsp-submit
-
-Submit Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[30] vsp-validate
------------------------------------------------
-
-
-usage: onap vsp-validate
-
-Validated the uploaded Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vsp-id] [-y | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-version VSP version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- status Validation status and is of type STRING.
- errors Validation messages and is of type JSON.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[31] service-model-certify-request
------------------------------------------------
-
-
-usage: onap service-model-certify-request
-
-Request the certification of Service model in SDC
-
-Onap service: sdc v1.0
-
-Options::
-
- [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -b | --service-model-id Service model ID. It is of type STRING. It is
- optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[32] service-model-certify-start
------------------------------------------------
-
-
-usage: onap service-model-certify-start
-
-Starts the certification of Service model in SDC
-
-Onap service: sdc v1.0
-
-Options::
-
- [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -b | --service-model-id Service model ID. It is of type STRING. It is
- optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[33] service-model-checkin
------------------------------------------------
-
-
-usage: onap service-model-checkin
-
-Checkin Service model in SDC
-
-Onap service: sdc v1.0
-
-Options::
-
- [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -b | --service-model-id Service model ID. It is of type STRING. It is
- optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[34] service-model-create
------------------------------------------------
-
-
-usage: onap service-model-create
-
-Create Service model in SDC
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --name] [-y | --description] [-z | --project-code]
- [-b | --category] [-c | --category-display-name] [-e | --icon-id]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -x | --name Onap Service Name. It is of type STRING.
- -y | --description Description for Service. It is of type STRING. It
- is optional.
- -z | --project-code Project code. It is of type STRING. It is
- optional.
- -b | --category Service category. It is of type STRING. It is
- optional. By default, it is network l1-3.
- -c | --category-display-name Service category display name. It is of type
- STRING. It is optional. By default, it is Network
- L1-3.
- -e | --icon-id Service Icon id. It is of type STRING. It is
- optional. By default, it is defaulticon.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID Service ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[35] service-model-distribute
------------------------------------------------
-
-
-usage: onap service-model-distribute
-
-Distributes the Service model in SDC
-
-Onap service: sdc v1.0
-
-Options::
-
- [-b | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -b | --service-model-id Service model ID. It is of type STRING. It is
- optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[36] service2vf-model-list
------------------------------------------------
-
-
-usage: onap service2vf-model-list
-
-List the VF in a given service model in SDC
-
-Onap service: sdc v1.0
-
-Options::
-
- [-z | --service-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -z | --service-model-id Service model uuid. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- vf-uuid UUID and is of type STRING.
- vf-name name and is of type STRING.
- vf-customization-uuid customization UUID and is of type STRING.
- vf-version version and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[37] vf-model-certify-complete
------------------------------------------------
-
-
-usage: onap vf-model-certify-complete
-
-Complete certifying Virtual function
-
-Onap service: sdc v1.0
-
-Options::
-
- [-b | --vf-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -b | --vf-id VF ID. It is of type STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[38] vf-model-certify-request
------------------------------------------------
-
-
-usage: onap vf-model-certify-request
-
-Request for certifying Virtual function
-
-Onap service: sdc v1.0
-
-Options::
-
- [-b | --vf-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -b | --vf-id VF ID. It is of type STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[39] vf-model-certify-start
------------------------------------------------
-
-
-usage: onap vf-model-certify-start
-
-Start certifying Virtual function
-
-Onap service: sdc v1.0
-
-Options::
-
- [-b | --vf-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -b | --vf-id VF ID. It is of type STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[40] vf-model-checkin
------------------------------------------------
-
-
-usage: onap vf-model-checkin
-
-Checkin Virtual function
-
-Onap service: sdc v1.0
-
-Options::
-
- [-b | --vf-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -b | --vf-id VF ID. It is of type STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[41] vf-model-create
------------------------------------------------
-
-
-usage: onap vf-model-create
-
-Create Virtual function from Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --name] [-y | --description] [-z | --vendor-name]
- [-b | --vsp-id] [-g | --vsp-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --name Onap VF Name. It is of type STRING.
- -y | --description Description for VF. It is of type STRING. It is
- optional.
- -z | --vendor-name Vendor name. It is of type STRING. It is optional.
- -b | --vsp-id VSP ID. It is of type STRING. It is optional.
- -g | --vsp-version VSP version. It is of type STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID VF ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[42] vf-model-list
------------------------------------------------
-
-
-usage: onap vf-model-list
-
-List the VF resource model in SDC
-
-Onap service: sdc v1.0
-
-Options::
-
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- uuid UUID and is of type STRING.
- invariant-uuid Invariant UUID and is of type STRING.
- name Name and is of type STRING.
- version version and is of type STRING.
- status status and is of type STRING.
- description description and is of type STRING.
- vsp-uuid VSP uuid and is of type STRING.
- vsp-version VSP version and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[43] vf2vfmodule-model-list
------------------------------------------------
-
-
-usage: onap vf2vfmodule-model-list
-
-List the VF modules in a given VF model in SDC
-
-Onap service: sdc v1.0
-
-Options::
-
- [-z | --vf-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -z | --vf-id VF uuid. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- vsp-uuid VSP uuid and is of type STRING.
- vsp-version VSP version and is of type STRING.
- module-uuid UUID and is of type STRING.
- module-invariant-uuid Invariant UUID and is of type STRING.
- module-name name and is of type STRING.
- module-version version and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[44] vlm-aggreement-create
------------------------------------------------
-
-
-usage: onap vlm-aggreement-create
-
-Create license aggreement
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --name] [-y | --vlm-id] [-e | --vlm-version]
- [-z | --description] [-g | --vlm-feature-group-id] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --name aggreement name. It is of type STRING.
- -y | --vlm-id License Model ID. It is of type STRING.
- -e | --vlm-version License Model version. It is of type STRING.
- -z | --description Description for aggreement. It is of type STRING.
- -g | --vlm-feature-group-id VLM feature group. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID aggreement ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[45] vlm-aggreement-list
------------------------------------------------
-
-
-usage: onap vlm-aggreement-list
-
-List license aggreement
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vlm-id License Model ID. It is of type STRING.
- -y | --vlm-version License Model version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID aggreement ID and is of type STRING.
- name aggreement name and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[46] vlm-checkin
------------------------------------------------
-
-
-usage: onap vlm-checkin
-
-Checkin Vendor License Model
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vlm-id] [-y | --vlm-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vlm-id Onap VLM ID. It is of type STRING.
- -y | --vlm-version VLM version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[47] cloud-create
------------------------------------------------
-
-
-usage: onap cloud-create
-
-Create a cloud region in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --cloud-name] [-y | --region-name] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --cloud-name Onap cloud name. It is of type STRING.
- -y | --region-name Onap region name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[48] cloud-delete
------------------------------------------------
-
-
-usage: onap cloud-delete
-
-Delete a cloud region from Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --cloud-name] [-y | --region-name] [-z | --resource-version]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -x | --cloud-name Onap cloud name. It is of type STRING.
- -y | --region-name Onap cloud region name. It is of type STRING.
- -z | --resource-version Onap cloud region version. It is of type UUID. It
- is optional. By default, it is
- 87f6a216-22d6-4cf1-921d-0eec5face723.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[49] cloud-list
------------------------------------------------
-
-
-usage: onap cloud-list
-
-List the configured clouds and Onap service subscriptions
-
-Onap service: aai v11
-
-Options::
-
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- cloud Onap cloud and is of type STRING.
- region Onap cloud region and is of type STRING.
- tenant Onap cloud tenat and is of type STRING.
- tenant-id Onap cloud tenat id and is of type STRING.
- customer Onap cloud customer and is of type STRING.
- service Onap cloud service and is of type STRING.
- resource-version Onap cloud resource version and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[50] customer-create
------------------------------------------------
-
-
-usage: onap customer-create
-
-Create a customer in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --customer-name] [-y | --subscriber-name] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --customer-name Onap customer name. It is of type STRING.
- -y | --subscriber-name Onap subscriber name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[51] customer-delete
------------------------------------------------
-
-
-usage: onap customer-delete
-
-Delete a customer from Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --customer-name] [-y | --resource-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --customer-name Onap customer name. It is of type STRING.
- -y | --resource-version Onap customer resource version. It is of type
- UUID. It is optional. By default, it is
- 8dac4609-db84-4122-a000-1e319cc92487.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[52] customer-list
------------------------------------------------
-
-
-usage: onap customer-list
-
-Lists the registetred customers in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- name Onap customer name and is of type STRING.
- resource-version Onap customer resource version and is of type
- STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[53] customer-show
------------------------------------------------
-
-
-usage: onap customer-show
-
-Lists the registetred customers in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --customer-name] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --customer-name Onap customer name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- name Onap customer name and is of type STRING.
- subscriber-name Onap subscriber name and is of type STRING.
- resource-version Onap subscriber resource version and is of type
- STRING.
- subscriber-type Onap subscriber type and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[54] ems-register
------------------------------------------------
-
-
-usage: onap ems-register
-
-Register a EMS in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-z | --ems-id] [-b | --name] [-c | --type]
- [-e | --vendor] [-q | --ems-version] [-g | --url]
- [-i | --username] [-j | --password] [-x | --remote-path]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -z | --ems-id Onap EMS unique id. It is of type UUID. By
- default, it is
- 601d366b-b449-474d-9019-a3fafa6de93c.
- -b | --name Onap EMS name. It is of type STRING.
- -c | --type Onap EMS type. It is of type STRING.
- -e | --vendor Onap EMS vendor. It is of type STRING.
- -q | --ems-version Onap EMS version. It is of type STRING.
- -g | --url Onap EMS URL. It is of type STRING.
- -i | --username Onap EMS username. It is of type STRING.
- -j | --password Onap EMS password. It is of type STRING.
- -x | --remote-path Onap EMS remote-path. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[55] ems-unregister
------------------------------------------------
-
-
-usage: onap ems-unregister
-
-Un-register a EMS in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --ems-id] [-y | --resource-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --ems-id Onap EMS unique id. It is of type UUID. By
- default, it is
- f52c603d-1ed5-4c49-baff-a119e8a38e5a.
- -y | --resource-version Onap vim resource version. It is of type STRING.
- It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[56] ems-list
------------------------------------------------
-
-
-usage: onap ems-list
-
-List the configured ems
-
-Onap service: aai v11
-
-Options::
-
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ems-id Onap ems id and is of type STRING.
- resource-version Onap ems resource version and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[57] ems-show
------------------------------------------------
-
-
-usage: onap ems-show
-
-Show the details of configured ems
-
-Onap service: aai v11
-
-Options::
-
- [-x | --ems-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --ems-id Onap EMS unique id. It is of type UUID. By
- default, it is
- 900b32e3-f6af-4b54-bacb-bd1a10e1941a.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- name Onap ems name and is of type STRING.
- type Onap ems type and is of type STRING.
- vendor Onap ems vendor and is of type STRING.
- version Onap ems version and is of type STRING.
- url Onap ems url and is of type STRING.
- username Onap ems username and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[58] sdnc-register
------------------------------------------------
-
-
-usage: onap sdnc-register
-
-Register a SDNC in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --location] [-y | --sdnc-id] [-b | --name]
- [-c | --type] [-e | --vendor] [-q | --sdnc-version]
- [-g | --ip-address] [-k | --port] [-r | --protocal]
- [-i | --username] [-j | --password] [-z | --product-name]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -x | --location Onap VIM unique id. It is of type UUID. By
- default, it is
- 9b3dafd4-adb9-4d3d-ad7b-f60ab345a713.
- -y | --sdnc-id Onap SDNC unique id. It is of type UUID. By
- default, it is
- 3c08d1ec-957f-49b1-abdb-1ca8f8ac2682.
- -b | --name Onap SDNC name. It is of type STRING.
- -c | --type Onap SDNC type. It is of type STRING.
- -e | --vendor Onap SDNC vendor. It is of type STRING.
- -q | --sdnc-version Onap SDNC version. It is of type STRING.
- -g | --ip-address Onap SDNC ip address. It is of type STRING.
- -k | --port Onap SDNC port. It is of type STRING.
- -r | --protocal Onap SDNC protocal. It is of type STRING.
- -i | --username Onap SDNC username. It is of type STRING.
- -j | --password Onap SDNC password. It is of type STRING.
- -z | --product-name Onap SDNC product-name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[59] sdnc-unregister
------------------------------------------------
-
-
-usage: onap sdnc-unregister
-
-Un-register a VNFM in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --sdnc-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --sdnc-id Onap VNFM unique id. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[60] sdnc-list
------------------------------------------------
-
-
-usage: onap sdnc-list
-
-List the configured sdnc
-
-Onap service: aai v11
-
-Options::
-
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- sdnc-id Onap sdnc id and is of type STRING.
- resource-version Onap sdnc resource version and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[61] vim-register
------------------------------------------------
-
-
-usage: onap vim-register
-
-Register a VIM under a given cloud region in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --cloud-name] [-y | --region-name] [-z | --vim-id]
- [-b | --name] [-c | --type] [-e | --vendor]
- [-q | --vim-version] [-g | --url] [-i | --username]
- [-j | --password] [-k | --ssl-cacert] [-l | --ssl-insecure]
- [-n | --cloud-domain] [-o | --default-tenant] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --cloud-name Onap cloud name. It is of type STRING.
- -y | --region-name Onap region name. It is of type STRING.
- -z | --vim-id Onap VIM unique id. It is of type UUID. By
- default, it is
- 9a1f740c-1b54-44a8-9c1f-9d2450c63444.
- -b | --name Onap VIM name. It is of type STRING.
- -c | --type Onap VIM type. It is of type STRING.
- -e | --vendor Onap VIM vendor. It is of type STRING.
- -q | --vim-version Onap VIM version. It is of type STRING.
- -g | --url Onap VIM URL. It is of type STRING.
- -i | --username Onap VIM username. It is of type STRING.
- -j | --password Onap VIM password. It is of type STRING.
- -k | --ssl-cacert Onap VIM SSL certificate. It is of type TEXT. It
- is optional.
- -l | --ssl-insecure Onap VIM insecure. It is of type BOOL. It is
- optional. By default, it is false.
- -n | --cloud-domain Onap VIM cloud domain. It is of type STRING.
- -o | --default-tenant Onap VIM default tenant. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[62] vim-unregister
------------------------------------------------
-
-
-usage: onap vim-unregister
-
-Un-register a VIM under from cloud region in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --cloud-name] [-y | --region-name] [-z | --vim-id]
- [-b | --resource-version] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --cloud-name Onap cloud name. It is of type STRING.
- -y | --region-name Onap region name. It is of type STRING.
- -z | --vim-id Onap VIM unique id. It is of type UUID. By
- default, it is
- d8671575-365d-41bc-ab85-dddbf3504dbd.
- -b | --resource-version Onap vim resource version. It is of type STRING.
- It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[63] vim-list
------------------------------------------------
-
-
-usage: onap vim-list
-
-List the configured vims
-
-Onap service: aai v11
-
-Options::
-
- [-x | --cloud-name] [-y | --region-name] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --cloud-name Onap cloud name. It is of type STRING.
- -y | --region-name Onap region name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- vim-id Onap vim id and is of type STRING.
- name Onap vim name and is of type STRING.
- type Onap vim type and is of type STRING.
- vendor Onap vim vendor and is of type STRING.
- version Onap vim version and is of type STRING.
- url Onap vim url and is of type STRING.
- username Onap vim username and is of type STRING.
- cloud-domain Onap vim cloud domain and is of type STRING.
- default-tenant Onap vim tenant and is of type STRING.
- resource-version Onap vim resource version and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[64] vnfm-register
------------------------------------------------
-
-
-usage: onap vnfm-register
-
-Register a VNFM in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --vim-id] [-y | --vnfm-id] [-b | --name]
- [-c | --type] [-e | --vendor] [-q | --vnfm-version]
- [-g | --url] [-i | --username] [-j | --password]
- [-z | --certificate-url] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vim-id Onap VIM unique id. It is of type UUID. By
- default, it is
- 7eb03bc7-ba8c-4018-a387-217acf76875d.
- -y | --vnfm-id Onap VNFM unique id. It is of type UUID. By
- default, it is
- bbc5abbc-8899-4f98-b9a7-5d36b02498eb.
- -b | --name Onap VNFM name. It is of type STRING.
- -c | --type Onap VNFM type. It is of type STRING.
- -e | --vendor Onap VNFM vendor. It is of type STRING.
- -q | --vnfm-version Onap VNFM version. It is of type STRING.
- -g | --url Onap VNFM URL. It is of type STRING.
- -i | --username Onap VNFM username. It is of type STRING.
- -j | --password Onap VNFM password. It is of type STRING.
- -z | --certificate-url Onap VNFM certificate-url. It is of type STRING.
- It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[65] vnfm-unregister
------------------------------------------------
-
-
-usage: onap vnfm-unregister
-
-Un-register a VNFM in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --vnfm-id] [-y | --resource-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vnfm-id Onap VNFM unique id. It is of type UUID. By
- default, it is
- 711af302-5db6-4520-a158-4940806520a6.
- -y | --resource-version Onap vim resource version. It is of type STRING.
- It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[66] vnfm-list
------------------------------------------------
-
-
-usage: onap vnfm-list
-
-List the configured vnfm
-
-Onap service: aai v11
-
-Options::
-
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- vnfm-id Onap vnfm id and is of type STRING.
- vim-id Onap vnfm id and is of type STRING.
- certificate-url Onap vnfm certificate-url and is of type STRING.
- resource-version Onap vnfm resource version and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[67] vnfm-show
------------------------------------------------
-
-
-usage: onap vnfm-show
-
-Show the VNFM in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --vnfm-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vnfm-id Onap VNFM unique id. It is of type UUID. By
- default, it is
- 8d373e37-6818-4894-95ba-7644041c66ba.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- name Onap vnfm name and is of type STRING.
- type Onap vnfm type and is of type STRING.
- vendor Onap vnfm vendor and is of type STRING.
- version Onap vnfm version and is of type STRING.
- url Onap vnfm url and is of type STRING.
- username Onap vnfm username and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[68] service-list
------------------------------------------------
-
-
-usage: onap service-list
-
-List created service instance
-
-Onap service: aai v11
-
-Options::
-
- [-x | --customer-name] [-y | --service-type] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --customer-name customer name. It is of type STRING.
- -y | --service-type service subscription type. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- service-id instance id of service and is of type STRING.
- service-name Service name and is of type STRING.
- model-invariant-id Model invariant id of service model and is of
- type STRING.
- model-uuid Model uuid for service model and is of type
- STRING.
- description service description and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[69] vf-list
------------------------------------------------
-
-
-usage: onap vf-list
-
-List created VF instances for a service instance
-
-Onap service: aai v11
-
-Options::
-
- [-x | --customer-name] [-y | --service-type] [-z | --service-id]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -x | --customer-name customer name. It is of type STRING.
- -y | --service-type service subscription type. It is of type STRING.
- -z | --service-id service ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- vf-id VF ID for the given service and is of type STRING.
- vf-name VF name and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[70] vf-show
------------------------------------------------
-
-
-usage: onap vf-show
-
-Show details for VF
-
-Onap service: aai v11
-
-Options::
-
- [-x | --vf-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vf-id VF identifier. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- vf-id VF ID for the given service and is of type STRING.
- vf-name VF name and is of type STRING.
- vf-type VF name and is of type STRING.
- model-invariant-id VF name and is of type STRING.
- model-uuid model uuid and is of type STRING.
- model-customization-id Model customization id and is of type STRING.
- service-id Service ID of parent service and is of type
- STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[71] service-type-create
------------------------------------------------
-
-
-usage: onap service-type-create
-
-Add a service type in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --service-type] [-y | --service-type-id] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --service-type Onap service type. It is of type STRING.
- -y | --service-type-id Onap service type uuid. It is of type UUID. It is
- optional. By default, it is
- 25bdc1fa-5058-40a5-927a-a1970d91ea27.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[72] service-type-delete
------------------------------------------------
-
-
-usage: onap service-type-delete
-
-Delete a service type from Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --service-type-id] [-y | --resource-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --service-type-id Onap service type uuid. It is of type UUID. It is
- optional. By default, it is
- 62672986-656e-4d8f-89a2-44505a41c75c.
- -y | --resource-version Onap service resource version. It is of type
- UUID. It is optional. By default, it is
- 2eacdccb-8995-48db-ae43-a17c092c68b8.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[73] service-type-list
------------------------------------------------
-
-
-usage: onap service-type-list
-
-List the service types configured in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- service-type-id Onap cloud service and is of type STRING.
- service-type Onap cloud service and is of type STRING.
- resource-version Onap cloud service resource version and is of
- type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[74] subscription-create
------------------------------------------------
-
-
-usage: onap subscription-create
-
-Create a subscription of a customer for given service in specific cloud region in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --customer-name] [-z | --cloud-name] [-r | --cloud-region]
- [-c | --cloud-tenant-id] [-e | --service-type] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --customer-name Onap customer name. It is of type STRING.
- -z | --cloud-name Onap cloud name. It is of type STRING.
- -r | --cloud-region Onap cloud region. It is of type STRING.
- -c | --cloud-tenant-id Onap cloud tenant id. It is of type STRING.
- -e | --service-type Onap service type. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[75] subscription-delete
------------------------------------------------
-
-
-usage: onap subscription-delete
-
-Delete the subscription for a given customer in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --customer-name] [-y | --service-type] [-g | --resource-version]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -x | --customer-name Onap customer name. It is of type STRING.
- -y | --service-type Onap subscribtion id. It is of type STRING.
- -g | --resource-version Onap subscription resource version. It is of type
- STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[76] subscription-list
------------------------------------------------
-
-
-usage: onap subscription-list
-
-Lists the subscription for a given customer in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --customer-name] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --customer-name Onap customer name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- service-type Onap service type and is of type STRING.
- resource-version Onap subscription resource version and is of type
- STRING.
- tenant Onap tenant name and is of type STRING.
- region Onap region name and is of type STRING.
- cloud Onap cloud name and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[77] tenant-create
------------------------------------------------
-
-
-usage: onap tenant-create
-
-Create a tenant under given cloud region in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --cloud] [-y | --region] [-z | --tenant-id]
- [-r | --tenant-name] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --cloud Onap cloud. It is of type STRING.
- -y | --region Onap cloud region. It is of type STRING.
- -z | --tenant-id Onap cloud tenant id. It is of type STRING.
- -r | --tenant-name Onap cloud tenant name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[78] tenant-delete
------------------------------------------------
-
-
-usage: onap tenant-delete
-
-Delete tenant under given cloud region in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --cloud] [-y | --region] [-z | --tenant-id]
- [-r | --resource-version] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --cloud Onap cloud. It is of type STRING.
- -y | --region Onap cloud region. It is of type STRING.
- -z | --tenant-id Onap cloud tenant id. It is of type STRING.
- -r | --resource-version Onap cloud tenant version. It is of type UUID. It
- is optional. By default, it is
- f971b569-5fdd-40ff-91ff-de6d3c589910.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[79] tenant-list
------------------------------------------------
-
-
-usage: onap tenant-list
-
-Lists the tenants under given cloud region in Onap
-
-Onap service: aai v11
-
-Options::
-
- [-x | --cloud] [-y | --region] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --cloud Onap cloud. It is of type STRING.
- -y | --region Onap cloud region. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- tenant-id Onap tenant-id and is of type STRING.
- tenant-name Onap tenant name and is of type STRING.
- resource-version Onap tenant resource version and is of type
- STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[80] vf-create
------------------------------------------------
-
-
-usage: onap vf-create
-
-Create a VF
-
-Onap service: mso v3
-
-Options::
-
- [-l | --cloud-region] [-z | --tenant-id] [-w | --product-family]
- [-i | --instance-name] [-y | --service-instance-id] [-null | --vf-model-invariant-id]
- [-null | --vf-model-uuid] [-null | --vf-model-name] [-null | --vf-model-version]
- [-null | --vf-model-customization-id] [-null | --service-model-invariant-id] [-null | --service-model-uuid]
- [-null | --service-model-name] [-null | --service-model-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -l | --cloud-region cloud region identifier. It is of type STRING.
- -z | --tenant-id openstack tenant id. It is of type STRING.
- -w | --product-family service type for serivce (e.g. vLB). It is of
- type STRING.
- -i | --instance-name service instance name. It is of type STRING.
- -y | --service-instance-id unique id for service instance. It is of type
- STRING.
- -null | --vf-model-invariant-id vf model invariant id. It is of type STRING.
- -null | --vf-model-uuid model uuid for vf. It is of type STRING.
- -null | --vf-model-name vf model name. It is of type STRING.
- -null | --vf-model-version vf model version. It is of type STRING.
- -null | --vf-model-customization-id vf model customization id. It is of type STRING.
- -null | --service-model-invariant-id model invariant id. It is of type STRING.
- -null | --service-model-uuid model name version id. It is of type STRING.
- -null | --service-model-name service model name. It is of type STRING.
- -null | --service-model-version service model version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- vf-id id for the created vnf and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[81] vf-module-delete
------------------------------------------------
-
-
-usage: onap vf-module-delete
-
-delete a VF module
-
-Onap service: mso v2
-
-Options::
-
- [-x | --vnf-instace-id] [-y | --service-instace-id] [-w | --vf-module-id]
- [-l | --lcp-cloudregion-id] [-z | --tenant-id] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vnf-instace-id id for vnf. It is of type STRING.
- -y | --service-instace-id unique id for service instance. It is of type
- STRING.
- -w | --vf-module-id vf module id. It is of type STRING.
- -l | --lcp-cloudregion-id AIC LCP node location identifier. It is of type
- STRING.
- -z | --tenant-id openstack tenant id (uuid). It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[82] vfmodule-create
------------------------------------------------
-
-
-usage: onap vfmodule-create
-
-Create a VF module
-
-Onap service: mso v3
-
-Options::
-
- [-l | --cloud-region] [-z | --tenant-id] [-null | --vfmodule-invariant-id]
- [-null | --vfmodule-uuid] [-null | --vfmodule-name] [-null | --vfmodule-version]
- [-i | --module-name] [-null | --service-id] [-y | --vf-id]
- [-null | --vf-model-invariant-id] [-null | --vf-model-uuid] [-null | --vf-model-name]
- [-null | --vf-model-version] [-null | --vf-model-customization-id] [-null | --service-model-invariant-id]
- [-null | --service-model-uuid] [-null | --service-model-name] [-null | --service-model-version]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -l | --cloud-region cloud region identifier. It is of type STRING.
- -z | --tenant-id openstack tenant id. It is of type STRING.
- -null | --vfmodule-invariant-id vfmodule model invariant id. It is of type STRING.
- -null | --vfmodule-uuid model uuid for vfmodule. It is of type STRING.
- -null | --vfmodule-name vfmodule model name. It is of type STRING.
- -null | --vfmodule-version vf module version. It is of type STRING.
- -i | --module-name vfmodule name. It is of type STRING.
- -null | --service-id unique id for service. It is of type STRING.
- -y | --vf-id unique id for related VF. It is of type STRING.
- -null | --vf-model-invariant-id vf model invariant id. It is of type STRING.
- -null | --vf-model-uuid model uuid for vf. It is of type STRING.
- -null | --vf-model-name vf model name. It is of type STRING.
- -null | --vf-model-version vf model version. It is of type STRING.
- -null | --vf-model-customization-id vf model customization id. It is of type STRING.
- -null | --service-model-invariant-id model invariant id. It is of type STRING.
- -null | --service-model-uuid model name version id. It is of type STRING.
- -null | --service-model-name service model name. It is of type STRING.
- -null | --service-model-version service model version. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- vfmodule-id id for the created vnf and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[83] vf-delete
------------------------------------------------
-
-
-usage: onap vf-delete
-
-delete a VF
-
-Onap service: mso v3
-
-Options::
-
- [-x | --vf-id] [-y | --service-instance-id] [-l | --cloud-region]
- [-z | --tenant-id] [-null | --model-invariant-id] [-null | --model-uuid]
- [-null | --model-name] [-null | --model-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vf-id id for vnf. It is of type STRING.
- -y | --service-instance-id unique id for service instance. It is of type
- STRING.
- -l | --cloud-region Cloud region ID. It is of type STRING.
- -z | --tenant-id openstack tenant id (uuid). It is of type STRING.
- -null | --model-invariant-id model invariant id for service in SDC catalog. It
- is of type STRING.
- -null | --model-uuid model uuid for service in SDC catalog. It is of
- type STRING.
- -null | --model-name model name available in SDC catalog. It is of
- type STRING.
- -null | --model-version model version of service (eg. 1.0). It is of type
- STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[84] service-create
------------------------------------------------
-
-
-usage: onap service-create
-
-Create a service instance using MSO
-
-Onap service: mso v3
-
-Options::
-
- [-null | --cloud-region] [-null | --tenant-id] [-null | --model-invariant-id]
- [-null | --model-uuid] [-null | --model-name] [-null | --model-version]
- [-c | --customer] [-i | --instance-name] [-r | --supress-rollback]
- [-null | --service-type] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -null | --cloud-region cloud region identifier. It is of type STRING.
- -null | --tenant-id tenant id. It is of type STRING.
- -null | --model-invariant-id model invariant id generated by ASDC. It is of
- type STRING.
- -null | --model-uuid model uuid generated by ASDC. It is of type
- STRING.
- -null | --model-name model name as provided in ASDC design time. It is
- of type STRING.
- -null | --model-version model-version. It is of type STRING.
- -c | --customer unique id for customer. It is of type STRING.
- -i | --instance-name service instance name. It is of type STRING.
- -r | --supress-rollback rollback changes if instantiation fails. It is of
- type BOOL. It is optional. By default, it is
- false.
- -null | --service-type subscription service type. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- service-id instance id for the created service. and is of
- type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[85] service-delete
------------------------------------------------
-
-
-usage: onap service-delete
-
-Delete service instance
-
-Onap service: mso v3
-
-Options::
-
- [-x | --service-instace-id] [-null | --model-invariant-id] [-null | --model-uuid]
- [-null | --model-name] [-null | --model-version] [-c | --customer-name]
- [-null | --cloud-region] [-null | --tenant-id] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --service-instace-id unique id for service instance. It is of type
- STRING.
- -null | --model-invariant-id model invariant id for service in SDC catalog. It
- is of type STRING.
- -null | --model-uuid model uuid for service in SDC catalog. It is of
- type STRING.
- -null | --model-name model name available in SDC catalog. It is of
- type STRING.
- -null | --model-version model version of service (eg. 1.0). It is of type
- STRING.
- -c | --customer-name unique id for customer. It is of type STRING.
- -null | --cloud-region cloud region id. It is of type STRING.
- -null | --tenant-id tenant id. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-onap-1.0
-==========================
-
-
-[1] vsp-checkin
------------------------------------------------
-
-
-usage: onap vsp-checkin
-
-Checkin Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[2] vsp-create
------------------------------------------------
-
-
-usage: onap vsp-create
-
-Create Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vsp-name] [-y | --vsp-description] [-null | --vsp-category]
- [-null | --vsp-subcategory] [-null | --vlm-version] [-null | --vlm-vendor]
- [-null | --vlm-id] [-null | --vlm-agreement-id] [-null | --vlm-feature-group-id]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -x | --vsp-name Onap VSP Name. It is of type STRING.
- -y | --vsp-description Description for VSP. It is of type STRING. It is
- optional.
- -null | --vsp-category Category of the VSP. It is of type STRING. It is
- optional. By default, it is
- resourceNewCategory.generic.
- -null | --vsp-subcategory Sub Category of VSP. It is of type STRING. It is
- optional. By default, it is
- resourceNewCategory.generic.abstract.
- -null | --vlm-version License version. It is of type STRING. It is
- optional. By default, it is 1.0.
- -null | --vlm-vendor License Model Name. It is of type STRING.
- -null | --vlm-id License Model ID. It is of type STRING.
- -null | --vlm-agreement-id License Agreement ID. It is of type STRING.
- -null | --vlm-feature-group-id Feature Group ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID VSP ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[3] vsp-list
------------------------------------------------
-
-
-usage: onap vsp-list
-
-List of the Vendor Software Products
-
-Onap service: sdc v1.0
-
-Options::
-
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID VSP ID and is of type STRING.
- name VSP Name and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+Provides HTTP basic authorization support.
-
-[4] vsp-show
------------------------------------------------
-
-
-usage: onap vsp-show
-
-Details of the Vendor Software Product
-
-Onap service: sdc v1.0
+Product: open-cli
+Service: basic-auth
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-m | --host-url] [-C | --no-catalog] [-f | --format]
+ [-h | --help] [-V | --verify] [-t | --no-title]
+ [-d | --debug] [-v | --version] [-s | --long]
+ [-D | --context] [-u | --host-username] [-p | --host-password]
where::
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
+ -m | --host-url host url in http(s). It is of type URL. By
default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog Whether to use given host-url directly or
+ discover it from catalog, it will override the
+ service->mode. It is of type BOOL. It is
+ optional.
-f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ csv, json, yaml. It is of type STRING.
+ -h | --help print help message. It is of type BOOL.
+ -V | --verify Helps to verify the command using samples
+ provides under open-cli-samples directory. By
+ default, it goes with mock.To enable the
+ verification of samples in real time, set
+ DISABLE_MOCKING=true in the context parameter. It
+ is of type BOOL. It is optional.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -v | --version print service version. 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::
- 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.
+ Authorization Authorization and is of type STRING.
Error::
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[5] vsp-submit
+[2] basic-logout
-----------------------------------------------
-usage: onap vsp-submit
-
-Submit Vendor Software Product
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[6] vsp-upload
------------------------------------------------
+usage: oclip basic-logout
-usage: onap vsp-upload
+Provides HTTP basic authorization support. As part of logout, it invalidates authorization key generated while login.
-Upload the CSAR file to VSP
-Onap service: sdc v1.0
+Product: open-cli
+Service: basic-auth
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-x | --vsp-id] [-y | --vsp-file] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-m | --host-url] [-C | --no-catalog] [-f | --format]
+ [-h | --help] [-V | --verify] [-t | --no-title]
+ [-d | --debug] [-v | --version] [-s | --long]
+ [-D | --context]
where::
- -x | --vsp-id Onap VSP ID. It is of type STRING.
- -y | --vsp-file CSAR File path. It is of type BINARY.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog Whether to use given host-url directly or
+ discover it from catalog, it will override the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -h | --help print help message. It is of type BOOL.
+ -V | --verify Helps to verify the command using samples
+ provides under open-cli-samples directory. By
+ default, it goes with mock.To enable the
+ verification of samples in real time, set
+ DISABLE_MOCKING=true in the context parameter. It
+ is of type BOOL. It is optional.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -v | --version print service version. It is of type BOOL.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -D | --context command context. It is of type MAP. It is
+ optional.
Error::
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[7] ep-create
+[3] catalog
-----------------------------------------------
-usage: onap ep-create
-
-Create Entitlement Pool
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --ep-name] [-y | --license-model-id] [-z | --ep-description]
- [-q | --threshold-value] [-b | --threshold-unit] [-c | --entitlement-metric]
- [-e | --aggregation-function] [-g | --operational-scope] [-k | --reference-number]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -x | --ep-name Entitlement Pool name. It is of type STRING.
- -y | --license-model-id License Model ID. It is of type STRING.
- -z | --ep-description Description for Entitlement Pool. It is of type
- STRING.
- -q | --threshold-value threshold. It is of type STRING.
- -b | --threshold-unit threshold. It is of type STRING.
- -c | --entitlement-metric Entitlement Metric. It is of type STRING.
- -e | --aggregation-function Aggregation Function. It is of type STRING.
- -g | --operational-scope Operational Scope. It is of type STRING.
- -k | --reference-number Reference Number. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID Entitlement Pool ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[8] ep-show
------------------------------------------------
+usage: oclip catalog
-usage: onap ep-show
+Provides catalog discovery support to find the base api path for given service from product's catalog service.
+If any product wants to support catalog, it could derive from this command. Currently ONAP uses it and creates
+derived command by using ONAP MSB service.
-Details of the Entitlement Pool
-Onap service: sdc v1.0
+Product: open-cli
+Service: catalog
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-x | --license-model-id] [-y | --pool-id] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-m | --host-url] [-C | --no-catalog] [-l | --catalog-service-name]
+ [-f | --format] [-h | --help] [-V | --verify]
+ [-t | --no-title] [-d | --debug] [-v | --version]
+ [-s | --long] [-D | --context] [-i | --catalog-service-version]
where::
- -x | --license-model-id Onap License Model ID. It is of type STRING.
- -y | --pool-id Onap Entitlement Pool ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog Whether to use given host-url directly or
+ discover it from catalog, it will override 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 .
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -h | --help print help message. It is of type BOOL.
+ -V | --verify Helps to verify the command using samples
+ provides under open-cli-samples directory. By
+ default, it goes with mock.To enable the
+ verification of samples in real time, set
+ DISABLE_MOCKING=true in the context parameter. It
+ is of type BOOL. It is optional.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -v | --version print service version. 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::
- 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.
+ catalog-service-host-url Service connection url and is of type STRING.
+ catalog-service-base-path service base path, to append with host-url for
+ connecting the service. and is of type STRING.
Error::
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[9] license-group-create
+[4] execution-list
-----------------------------------------------
-usage: onap license-group-create
-Create License Group
+usage: oclip execution-list
+
+List the executions of the given command so far
-Onap service: sdc v1.0
+Product: open-cli
+Service: execution
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-x | --group-name] [-y | --license-model-id] [-z | --license-group-description]
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-e | --request-id] [-b | --service] [-f | --format]
+ [-h | --help] [-t | --no-title] [-d | --debug]
+ [-x | --start-time] [-v | --version] [-n | --command]
+ [-l | --product] [-y | --end-time] [-s | --long]
+ [-D | --context] [-c | --profile]
where::
- -x | --group-name group name. It is of type STRING.
- -y | --license-model-id License Model ID. It is of type STRING.
- -z | --license-group-description Description for License Group. It is of type
- STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -e | --request-id Request id. It is of type STRING. It is optional.
+ By default, it is .
+ -b | --service For a given service. It is of type STRING. It is
+ optional. By default, it is .
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -h | --help print help message. It is of type BOOL.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -x | --start-time From start time. It is of type STRING. It is
+ optional. By default, it is .
+ -v | --version print service version. It is of type BOOL.
+ -n | --command For a given command. It is of type STRING. It is
+ optional. By default, it is .
+ -l | --product For a given product version. It is of type
+ STRING. It is optional. By default, it is .
+ -y | --end-time Till end time. 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.
+ -c | --profile For a given profile. It is of type STRING. It is
+ optional. By default, it is .
Results::
- ID License Group ID and is of type STRING.
+ request-id Request id and is of type STRING.
+ execution-id Execution id and is of type STRING.
+ product Product and is of type STRING.
+ service service and is of type STRING.
+ command command and is of type STRING.
+ profile Profile and is of type STRING.
+ status Execution status and is of type STRING.
+ start-time Command execution starting Time and is of type
+ STRING.
+ end-time Command execution finishing Time and is of type
+ STRING.
+ input Input and is of type STRING.
+ output Output and is of type STRING.
Error::
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[10] license-group-show
+[5] execution-show
-----------------------------------------------
-usage: onap license-group-show
-Details of the License Group
+usage: oclip execution-show
-Onap service: sdc v1.0
+Show the complete executions for the given request id
+
+Product: open-cli
+Service: execution
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-x | --license-model-id] [-y | --license-group-id] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-l | --execution-id] [-D | --context] [-s | --long]
+ [-h | --help] [-f | --format] [-t | --no-title]
+ [-d | --debug] [-v | --version]
where::
- -x | --license-model-id Onap License Model ID. It is of type STRING.
- -y | --license-group-id Onap License Group ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -l | --execution-id Execution id. It is of type STRING. By default,
+ it is .
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -v | --version print service version. It is of type BOOL.
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
+ request-id Request id and is of type STRING.
+ product Product and is of type STRING.
+ service service and is of type STRING.
+ command command and is of type STRING.
+ profile Profile and is of type STRING.
+ input Input and is of type STRING.
+ status Execution status and is of type STRING.
+ start-time Command execution starting Time and is of type
+ STRING.
+ end-time Command execution finishing Time and is of type
STRING.
+ output Output and is of type STRING.
Error::
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[11] license-model-create
+[6] product-list
-----------------------------------------------
-usage: onap license-model-create
-
-Create License Model
-
-Onap service: sdc v1.0
-
-Options::
-
- [-x | --vendor-name] [-y | --license-model-description] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --vendor-name vendor name. It is of type STRING.
- -y | --license-model-description Description for License Model. It is of type
- STRING. It is optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- ID License Model ID and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[12] license-model-show
------------------------------------------------
-
-usage: onap license-model-show
+usage: oclip product-list
-Details of the License Model
+List available products registered in OCLIP
-Onap service: sdc v1.0
+Product: open-cli
+Service: product
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-x | --license-model-id] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-D | --context] [-s | --long] [-h | --help]
+ [-f | --format] [-t | --no-title] [-d | --debug]
+ [-v | --version]
where::
- -x | --license-model-id Onap License Model ID. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -v | --version print service version. It is of type BOOL.
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.
+ product Product name and is of type STRING.
+ description Product description and is of type STRING.
Error::
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-[13] cloud-list
+[8] schema-list
-----------------------------------------------
-usage: onap cloud-list
-List the configured clouds and Onap service subscriptions
+usage: oclip schema-list
+
+OCLIP command to list available schema
-Onap service: aai v8
+Product: open-cli
+Service: schema
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-l | --product] [-D | --context] [-s | --long]
+ [-h | --help] [-f | --format] [-t | --no-title]
+ [-d | --debug] [-v | --version] [-n | --service]
where::
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -l | --product For a given product version. It is of type
+ STRING. By default, it is .
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -v | --version print service version. It is of type BOOL.
+ -n | --service For a given service in a product. It is of type
+ STRING. It is optional. By default, it is .
Results::
- cloud Onap cloud and is of type STRING.
- region Onap cloud region and is of type STRING.
- tenant Onap cloud tenat and is of type STRING.
- tenant-id Onap cloud tenat id and is of type STRING.
- customer Onap cloud customer and is of type STRING.
- service Onap cloud service and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[14] customer-create
------------------------------------------------
-
-
-usage: onap customer-create
-
-Create a customer in Onap
-
-Onap service: aai v8
-
-Options::
-
- [-x | --customer-name] [-y | --subscriber-name] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --customer-name Onap customer name. It is of type STRING.
- -y | --subscriber-name Onap subscriber name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ command Command name and is of type STRING.
+ schema Schema name and is of type STRING.
+ service Service name and is of type STRING.
+ ocs-version Schema version and is of type STRING.
+ type Command type and is of type STRING.
+ enabled Command is enabled or not and is of type STRING.
+ rpc Command is executed remotely and is of type
+ STRING.
Error::
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[15] customer-delete
+[9] schema-refresh
-----------------------------------------------
-usage: onap customer-delete
-
-Delete a customer from Onap
-
-Onap service: aai v8
-
-Options::
-
- [-x | --customer-name] [-y | --resource-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --customer-name Onap customer name. It is of type STRING.
- -y | --resource-version Onap customer resource version. It is of type
- UUID. It is optional. By default, it is
- b4afbd15-39ff-47a8-b243-cdd6e747740c.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[16] customer-list
------------------------------------------------
-
-usage: onap customer-list
+usage: oclip schema-refresh
-Lists the registetred customers in Onap
+OCLIP command to refresh schemas stored in open-cli-schema folders.
-Onap service: aai v8
+Product: open-cli
+Service: schema
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
+ [-D | --context] [-s | --long] [-h | --help]
+ [-f | --format] [-t | --no-title] [-d | --debug]
+ [-v | --version]
where::
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -v | --version print service version. It is of type BOOL.
Results::
- name Onap customer name and is of type STRING.
- resource-version Onap customer resource version 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.
+ enabled Command is enabled or not and is of type STRING.
Error::
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[17] customer-show
+[10] schema-show
-----------------------------------------------
-usage: onap customer-show
-Lists the registetred customers in Onap
+usage: oclip schema-show
-Onap service: aai v8
+OCLIP command to show available schema in JSON format
+
+Product: open-cli
+Service: schema
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-x | --customer-name] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-l | --product] [-D | --context] [-s | --long]
+ [-h | --help] [-f | --format] [-t | --no-title]
+ [-d | --debug] [-x | --service] [-v | --version]
+ [-n | --command]
where::
- -x | --customer-name Onap customer name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -l | --product For a given product version. It is of type
+ STRING. By default, it is .
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -x | --service For a given service. It is of type STRING. It is
+ optional. By default, it is .
+ -v | --version print service version. It is of type BOOL.
+ -n | --command Schema details to fetch. It is of type STRING. By
+ default, it is .
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.
+ schema Scheam json and is of type JSON.
Error::
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[18] service-type-create
+[11] schema-switch
-----------------------------------------------
-usage: onap service-type-create
-
-Add a service type in Onap
-
-Onap service: aai v8
-
-Options::
-
- [-x | --service-type] [-y | --service-type-id] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --service-type Onap service type. It is of type STRING.
- -y | --service-type-id Onap service type uuid. It is of type UUID. It is
- optional. By default, it is
- 9c690339-7600-4682-bb64-eedfa173425e.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[19] service-type-delete
------------------------------------------------
-
-usage: onap service-type-delete
+usage: oclip schema-switch
-Delete a service type from Onap
+OCLIP command to switch the given command enable/disable
-Onap service: aai v8
+Product: open-cli
+Service: schema
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-x | --service-type-id] [-y | --resource-version] [-u | --onap-username]
- [-p | --onap-password] [-m | --host-url] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title] [-a | --no-auth]
+ [-l | --name] [-i | --product] [-D | --context]
+ [-s | --long] [-h | --help] [-f | --format]
+ [-t | --no-title] [-d | --debug] [-v | --version]
where::
- -x | --service-type-id Onap service type uuid. It is of type UUID. It is
- optional. By default, it is
- 34009a67-d99d-454a-95d3-dbd1f512f2e3.
- -y | --resource-version Onap service resource version. It is of type
- UUID. It is optional. By default, it is
- 95c1ea1b-02ea-40f8-9bfc-f476cd90dbb6.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
+ -l | --name Command name. It is of type STRING. By default,
+ it is .
+ -i | --product Product name. It is of type STRING. By default,
+ it is .
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -v | --version print service version. It is of type BOOL.
Error::
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[20] service-type-list
+[12] schema-validate
-----------------------------------------------
-usage: onap service-type-list
-
-List the service types configured in Onap
-
-Onap service: aai v8
-
-Options::
-
- [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
- [-a | --no-auth]
-
-where::
-
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- service-type-id Onap cloud service and is of type STRING.
- service-type Onap cloud service and is of type STRING.
- resource-version Onap cloud service resource version and is of
- type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[21] subscription-create
------------------------------------------------
+usage: oclip schema-validate
-usage: onap subscription-create
+OCLIP command to validate schema
-Create a subscription for a customer in Onap
-
-Onap service: aai v8
+Product: open-cli
+Service: schema
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-x | --customer-name] [-y | --subscriber-name] [-z | --cloud-type]
- [-r | --cloud-region] [-c | --cloud-tenant-id] [-e | --service-type]
- [-g | --resource-version] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
+ [-D | --context] [-s | --long] [-h | --help]
+ [-b | --ocs-version] [-f | --format] [-t | --no-title]
+ [-d | --debug] [-v | --version] [-l | --schema-location]
+ [-i | --internal-schema]
where::
- -x | --customer-name Onap customer name. It is of type STRING.
- -y | --subscriber-name Onap subscriber name. It is of type STRING.
- -z | --cloud-type Onap cloud type (openstack, rackspace). It is of
- type STRING.
- -r | --cloud-region Onap cloud region. It is of type STRING.
- -c | --cloud-tenant-id Onap cloud tenant id. It is of type STRING.
- -e | --service-type Onap service type. It is of type STRING.
- -g | --resource-version Onap subscription resource version. It is
- mandatory for existing customer to create a new
- subscription. It is of type STRING. It is
+ -D | --context command context. It is of type MAP. It is
optional.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
-s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[22] subscription-list
------------------------------------------------
-
-
-usage: onap subscription-list
-
-Lists the subscription for a given customer in Onap
-
-Onap service: aai v8
-
-Options::
-
- [-x | --customer-name] [-u | --onap-username] [-p | --onap-password]
- [-m | --host-url] [-h | --help] [-v | --version]
- [-d | --debug] [-f | --format] [-s | --long]
- [-t | --no-title] [-a | --no-auth]
-
-where::
-
- -x | --customer-name Onap customer name. It is of type STRING.
- -u | --onap-username Onap user name. It is of type STRING. By default,
- it is read from environment variable
- ONAP_USERNAME.
- -p | --onap-password Onap user password. It is of type STRING. By
- default, it is read from environment variable
- ONAP_PASSWORD. Secured.
- -m | --host-url Onap host url. It is of type URL. By default, it
- is read from environment variable ONAP_HOST_URL.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL. By default, it is false.
-
-
-Results::
-
- service-type Onap service type and is of type STRING.
-
-
-Error::
-
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-cli-1.0
-==========================
-
-
-[1] schema-validate
------------------------------------------------
-
-
-usage: onap schema-validate
-
-Onap command to validate schema
-
-Onap service: onap-cli 1.0.0
-
-Options::
-
- [-l | --schema-location] [-i | --internal-schema] [-h | --help]
- [-v | --version] [-d | --debug] [-f | --format]
- [-s | --long] [-t | --no-title]
-
-where::
-
- -l | --schema-location Schema file location. It is of type URL.
- -i | --internal-schema Validate existing schema file. It is of type
- BOOL. By default, it is false.
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
+ attributes. It is of type BOOL.
+ -h | --help print help message. It is of type BOOL.
+ -b | --ocs-version OCS version. It is of type STRING. It is optional.
-f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -v | --version print service version. 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 <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-[2] schema-refresh
+[13] service-list
-----------------------------------------------
-usage: onap schema-refresh
-Onap command to refresh schemas stored in onap_cli_schema folders.
+usage: oclip service-list
-Onap service: onap-cli 1.0.0
+List the services in given product registered in OCLIP
+
+Product: open-cli
+Service: product
+Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
Options::
- [-h | --help] [-v | --version] [-d | --debug]
- [-f | --format] [-s | --long] [-t | --no-title]
+ [-l | --product] [-D | --context] [-s | --long]
+ [-h | --help] [-f | --format] [-t | --no-title]
+ [-d | --debug] [-v | --version]
where::
- -h | --help Onap command help message. It is of type STRING.
- By default, it is false.
- -v | --version Onap command service version. It is of type
- STRING. By default, it is false.
- -d | --debug Enable debug output. It is of type BOOL. By
- default, it is false.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING. By
- default, it is table.
+ -l | --product For a given product version. It is of type
+ STRING. By default, it is .
+ -D | --context command context. It is of type MAP. It is
+ optional.
-s | --long whether to print all attributes or only short
- attributes. It is of type BOOL. By default, it is
- false.
- -t | --no-title whether to print title or not. It is of type
- BOOL. By default, it is false.
+ attributes. It is of type BOOL.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -v | --version print service version. It is of type BOOL.
Results::
- sl-no Serial Number and is of type STRING.
- command Command name and is of type STRING.
- product-version Command product version and is of type STRING.
- schema Schema name and is of type STRING.
- version Schema version and is of type STRING.
+ service Service name and is of type STRING.
+ description Product description and is of type STRING.
Error::
- On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
Code Review / cli.git / blobdiff