diff options
| author |   Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com> | 2018-04-27 16:19:43 +0530 |
|---|---|---|
| committer | Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com> | 2018-05-04 10:34:34 +0530 |
| commit | c8a706defb46c8eb7375f6579b72288df34d15ab (patch) | |
| tree | cb2483a51923dc515b9b6d6e1f9b066c32ab4866 /docs/cmd_help_onap_beijing.rst | |
| parent | f34b97de422bcee9ed40677c59290d7c654f6fd3 (diff) | |
CLI HELP: vsp-show
Change-Id: I3360184e0723a55d7b104e79cdca37c0968cac91
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 | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/docs/cmd_help_onap_beijing.rst b/docs/cmd_help_onap_beijing.rst index 4b023629..aa9f5c9a 100644 --- a/docs/cmd_help_onap_beijing.rst +++ b/docs/cmd_help_onap_beijing.rst @@ -4728,3 +4728,78 @@ Error:: On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + +vsp-show +---------------------------------------------------- + +usage: oclip vsp-show + +Details of the Vendor Software Product + +Product: onap-beijing +Service: sdc +Author: ONAP CLI Team onap-discuss@lists.onap.org + +Options:: + + [-m | --host-url] [-C | --no-catalog] [-h | --help] + [-f | --format] [-t | --no-title] [-V | --verify] + [-v | --version] [-d | --debug] [-x | --vsp-id] + [-s | --long] [-D | --context] [-y | --vsp-version] + [-u | --host-username] [-a | --no-auth] [-p | --host-password] + +where:: + + -m | --host-url host url in http(s). It is of type URL. By + default, it is read from environment variable + OPEN_CLI_HOST_URL. + -C | --no-catalog Whether to use given host-url directly 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 | --vsp-id Onap VSP ID. It is of type STRING. By default, it + is . + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -y | --vsp-version Onap VSP version. It is of type STRING. By + default, it is . + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth Whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + + +Results:: + + name VSP Name and is of type STRING. + ID VSP ID and is of type STRING. + description Description for the VSP and is of type STRING. + vendor-name Vendor name and is of type STRING. + vendor-id Vendor id and is of type STRING. + version Version and is of type STRING. + status status and is of type STRING. + license-id license aggreement and is of type STRING. + + +Error:: + + On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE> + |