diff options
| -rw-r--r-- | docs/cmd_help_onap_beijing.rst | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/docs/cmd_help_onap_beijing.rst b/docs/cmd_help_onap_beijing.rst index f145fcec..c437f297 100644 --- a/docs/cmd_help_onap_beijing.rst +++ b/docs/cmd_help_onap_beijing.rst @@ -4937,3 +4937,93 @@ Error:: On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + +vim-register +---------------------------------------------------- + +usage: oclip vim-register + +Register a VIM under a given cloud region in Onap + +Product: onap-beijing +Service: aai +Author: ONAP CLI Team onap-discuss@lists.onap.org + +Options:: + + [-h | --help] [-f | --format] [-t | --no-title] + [-V | --verify] [-e | --vendor] [-v | --version] + [-x | --cloud-name] [-s | --long] [-k | --ssl-cacert] + [-y | --region-name] [-b | --name] [-j | --password] + [-a | --no-auth] [-n | --cloud-domain] [-z | --vim-id] + [-p | --host-password] [-m | --host-url] [-C | --no-catalog] + [-d | --debug] [-q | --vim-version] [-l | --ssl-insecure] + [-c | --type] [-o | --default-tenant] [-D | --context] + [-i | --username] [-u | --host-username] [-g | --url] + +where:: + + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. + -t | --no-title whether to print title or not. It is of type BOOL. + -V | --verify 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. + -e | --vendor Onap VIM vendor. It is of type STRING. By + default, it is . + -v | --version print service version. It is of type BOOL. + -x | --cloud-name Onap cloud name. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -k | --ssl-cacert Onap VIM SSL certificate. It is of type TEXT. It + is optional. By default, it is . + -y | --region-name Onap region name. It is of type STRING. By + default, it is . + -b | --name Onap VIM name. It is of type STRING. By default, + it is . + -j | --password Onap VIM password. It is of type STRING. By + default, it is . + -a | --no-auth Whether to authenticate user or not. It is of + type BOOL. + -n | --cloud-domain Onap VIM cloud domain. It is of type STRING. By + default, it is . + -z | --vim-id Onap VIM unique id. It is of type UUID. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog Whether to use given host-url directly or + discover it from catalog, it will override the + service->mode. It is of type BOOL. It is + optional. + -d | --debug Enable debug output. It is of type BOOL. + -q | --vim-version Onap VIM version. It is of type STRING. By + default, it is . + -l | --ssl-insecure Onap VIM insecure. It is of type BOOL. It is + optional. + -c | --type Onap VIM type. It is of type STRING. By default, + it is . + -o | --default-tenant Onap VIM default tenant. It is of type STRING. By + default, it is . + -D | --context command context. It is of type MAP. It is + optional. + -i | --username Onap VIM username. It is of type STRING. By + default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -g | --url Onap VIM URL. It is of type STRING. By default, + it is . + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + |