CLI HELP: vnf-create 43/45843/1
authorKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Fri, 27 Apr 2018 10:49:29 +0000 (16:19 +0530)
committerKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Thu, 3 May 2018 12:08:16 +0000 (17:38 +0530)
Change-Id: Ib5181a2ee7474843137b96e42eb597e96017efcc
Issue-ID: CLI-100
Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
docs/cmd_help_onap_beijing.rst

index c145a63..16c5c59 100644 (file)
@@ -4513,3 +4513,75 @@ Error::
 
  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
 
+
+vnf-create
+----------------------------------------------------
+
+usage: oclip vnf-create
+
+Create a vnf directly into AAI.
+
+Product: onap-beijing
+Service: aai
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-m | --host-url] [-n | --name] [-C | --no-catalog]
+ [-h | --help] [-f | --format] [-t | --no-title]
+ [-V | --verify] [-v | --version] [-d | --debug]
+ [-w | --in-maint] [-i | --vnf-id] [-s | --long]
+ [-D | --context] [-z | --vnf-type] [-u | --host-username]
+ [-r | --relationship] [-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.
+ -n | --name            vnf-name. It is of type STRING. By default, it is
+                        .
+ -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.
+ -w | --in-maint        Used to indicate whether or not this object is in
+                        maintenance mode (maintenance mode = true). It is
+                        of type BOOL. It is optional.
+ -i | --vnf-id          vnf-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.
+ -z | --vnf-type        vnf-type. 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.
+ -r | --relationship    relationship. It is of type JSON. It's
+                        recommended to input the complete path of the
+                        file, which is having the value for it. It is
+                        optional.
+ -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.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+