aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2018-04-27 16:17:20 +0530
committerKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2018-05-02 14:25:21 +0530
commitb0010a5fed04a63b8babfb3b494b9af307cc0bc3 (patch)
tree8f5a1a66616b1e139fbbed7ab298ad41f45b78ec
parent4e9fcf131f8cadf52f98ecede12cbdb72f67c2b7 (diff)
CLI HELP: vlm-aggreement-list
Change-Id: Iac967418a35a7955219b15c21e54a2b321bc4889 Issue-ID: CLI-100 Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
-rw-r--r--docs/cmd_help_onap_beijing.rst69
1 files changed, 69 insertions, 0 deletions
diff --git a/docs/cmd_help_onap_beijing.rst b/docs/cmd_help_onap_beijing.rst
index 6681dc8f..e17834d7 100644
--- a/docs/cmd_help_onap_beijing.rst
+++ b/docs/cmd_help_onap_beijing.rst
@@ -3024,3 +3024,72 @@ Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+vlm-aggreement-list
+----------------------------------------------------
+
+usage: oclip vlm-aggreement-list
+
+List license aggreement
+
+Product: onap-beijing
+Service: sdc
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-m | --host-url] [-C | --no-catalog] [-y | --vlm-version]
+ [-h | --help] [-f | --format] [-t | --no-title]
+ [-V | --verify] [-v | --version] [-d | --debug]
+ [-x | --vlm-id] [-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.
+ -y | --vlm-version License Model version. It is of type STRING. By
+ default, it is .
+ -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 | --vlm-id License Model 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.
+ -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 aggreement ID and is of type STRING.
+ name aggreement name and is of type STRING.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+