From e80a3dd1c3ea518756e848cc875bd8f2603a1574 Mon Sep 17 00:00:00 2001 From: Kanagaraj Manickam k00365106 Date: Fri, 27 Apr 2018 16:17:44 +0530 Subject: CLI HELP: vsp-list Change-Id: I7a96be17521135e398de0ca489b3578787e86de2 Issue-ID: CLI-100 Signed-off-by: Kanagaraj Manickam k00365106 --- docs/cmd_help_onap_beijing.rst | 70 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) diff --git a/docs/cmd_help_onap_beijing.rst b/docs/cmd_help_onap_beijing.rst index 6367f537..3ab84de7 100644 --- a/docs/cmd_help_onap_beijing.rst +++ b/docs/cmd_help_onap_beijing.rst @@ -3354,3 +3354,73 @@ Error:: On error, it prints :::: + +vsp-list +---------------------------------------------------- + +usage: oclip vsp-list + +List of the Vendor Software Products + +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] [-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. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. + -D | --context command context. It is of type MAP. It is + optional. + -u | --host-username Host user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_HOST_USERNAME. + -a | --no-auth Whether to authenticate user or not. It is of + type BOOL. + -p | --host-password Host user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_HOST_PASSWORD. Secured. + + +Results:: + + ID VSP ID and is of type STRING. + name VSP Name and is of type STRING. + vendor-name Vendor name and is of type STRING. + version Version and is of type STRING. + status status and is of type STRING. + license-id license aggreement and is of type STRING. + license-version license version and is of type STRING. + + +Error:: + + On error, it prints :::: + -- cgit 1.2.3-korg