diff options
author | Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com> | 2018-04-27 16:18:05 +0530 |
---|---|---|
committer | Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com> | 2018-05-03 17:38:16 +0530 |
commit | c5147760ae2ae7978d46d474d11390c4a1b1e167 (patch) | |
tree | a03592211ed9feb8ff92aefae0807b62d52351c4 /docs/cmd_help_onap_beijing.rst | |
parent | c72bb335038edc38a7635c3ef9930f1f9aba95ff (diff) |
CLI HELP: tenant-list
Change-Id: I0aac38c8c6ee39b29dd98c6e7506e10a04e5f459
Issue-ID: CLI-100
Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Diffstat (limited to 'docs/cmd_help_onap_beijing.rst')
-rw-r--r-- | docs/cmd_help_onap_beijing.rst | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/cmd_help_onap_beijing.rst b/docs/cmd_help_onap_beijing.rst index 6174ddd8..fb61927d 100644 --- a/docs/cmd_help_onap_beijing.rst +++ b/docs/cmd_help_onap_beijing.rst @@ -3493,3 +3493,74 @@ Error:: On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + +tenant-list +---------------------------------------------------- + +usage: oclip tenant-list + +Lists the tenants under given cloud region in Onap + +Product: onap-beijing +Service: aai +Author: ONAP CLI Team onap-discuss@lists.onap.org + +Options:: + + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --cloud] + [-y | --region] [-s | --long] [-D | --context] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] + +where:: + + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog Whether to use given host-url directly or + discover it from catalog, it will override the + service->mode. It is of type BOOL. It is + optional. + -h | --help print help message. It is of type BOOL. + -f | --format Output formats, supported formats such as table, + 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. + -v | --version print service version. It is of type BOOL. + -d | --debug Enable debug output. It is of type BOOL. + -x | --cloud Onap cloud. It is of type STRING. By default, it + is . + -y | --region Onap cloud region. It is of type STRING. By + default, it is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth Whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + + +Results:: + + tenant-id Onap tenant-id and is of type STRING. + tenant-name Onap tenant name and is of type STRING. + resource-version Onap tenant resource version and is of type + STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + |