summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2018-04-27 16:20:06 +0530
committerKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2018-05-04 10:34:34 +0530
commit529cf0252b1097d0719f75ac7ed36a007b360b66 (patch)
treeefbd056f9114299d50c0c981975fb8df45442930
parent32495d34a77a095aec97235f9653aa8a044ac18a (diff)
CLI HELP: vf-show
Change-Id: I3592e5019631d176671f943a57f175389509cbe9 Issue-ID: CLI-100 Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
-rw-r--r--docs/cmd_help_onap_beijing.rst73
1 files changed, 73 insertions, 0 deletions
diff --git a/docs/cmd_help_onap_beijing.rst b/docs/cmd_help_onap_beijing.rst
index 57e14fb4..f145fcec 100644
--- a/docs/cmd_help_onap_beijing.rst
+++ b/docs/cmd_help_onap_beijing.rst
@@ -4864,3 +4864,76 @@ Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+vf-show
+----------------------------------------------------
+
+usage: oclip vf-show
+
+Show details for VF
+
+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] [-s | --long]
+ [-D | --context] [-u | --host-username] [-a | --no-auth]
+ [-p | --host-password] [-x | --vf-id]
+
+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.
+ -x | --vf-id VF identifier. It is of type STRING. By default,
+ it is .
+
+
+Results::
+
+ vf-id VF ID for the given service and is of type STRING.
+ vf-name VF name and is of type STRING.
+ vf-type VF name and is of type STRING.
+ model-invariant-id VF name and is of type STRING.
+ model-uuid model uuid and is of type STRING.
+ model-customization-id Model customization id and is of type STRING.
+ service-id Service ID of parent service and is of type
+ STRING.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+