CLI HELP: tenant-create

[cli.git] / docs / cmd_help_onap_beijing.rst

diff --git a/docs/cmd_help_onap_beijing.rst b/docs/cmd_help_onap_beijing.rst
index 73d8b34..997d8ac 100644 (file)
--- a/docs/cmd_help_onap_beijing.rst
+++ b/docs/cmd_help_onap_beijing.rst
@@ -11,8 +11,7 @@
 
 
 onap-beijing
-==========================
-
+==============
 
 [1] basic-login
 -----------------------------------------------
@@ -39,7 +38,7 @@ where::
                         default, it is read from environment variable
                         OPEN_CLI_HOST_URL.
  -C | --no-catalog      whether to use given host-url directly without
-                        looking into catalog, it will overrid the
+                        looking into 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.
@@ -103,7 +102,7 @@ where::
                     default, it is read from environment variable
                     OPEN_CLI_HOST_URL.
  -C | --no-catalog  whether to use given host-url directly without
-                    looking into catalog, it will overrid the
+                    looking into 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.
@@ -154,7 +153,7 @@ where::
                                   default, it is read from environment variable
                                   OPEN_CLI_HOST_URL.
  -C | --no-catalog                whether to use given host-url directly without
-                                  looking into catalog, it will overrid the
+                                  looking into catalog, it will override the
                                   service->mode. It is of type BOOL. It is
                                   optional.
  -l | --catalog-service-name      service name registered in catalog service. It is
@@ -217,7 +216,7 @@ where::
                         default, it is read from environment variable
                         OPEN_CLI_HOST_URL.
  -C | --no-catalog      whether to use given host-url directly without
-                        looking into catalog, it will overrid the
+                        looking into 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.
@@ -282,7 +281,7 @@ where::
                           default, it is read from environment variable
                           OPEN_CLI_HOST_URL.
  -C | --no-catalog        whether to use given host-url directly without
-                          looking into catalog, it will overrid the
+                          looking into 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.
@@ -348,7 +347,7 @@ where::
                         default, it is read from environment variable
                         OPEN_CLI_HOST_URL.
  -C | --no-catalog      whether to use given host-url directly without
-                        looking into catalog, it will overrid the
+                        looking into 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.
@@ -421,7 +420,7 @@ where::
  -y | --subscriber-name   Onap subscriber name. It is of type STRING. By
                           default, it is .
  -C | --no-catalog        whether to use given host-url directly without
-                          looking into catalog, it will overrid the
+                          looking into 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.
@@ -483,7 +482,7 @@ where::
                           default, it is read from environment variable
                           OPEN_CLI_HOST_URL.
  -C | --no-catalog        whether to use given host-url directly without
-                          looking into catalog, it will overrid the
+                          looking into 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.
@@ -547,7 +546,7 @@ where::
                         default, it is read from environment variable
                         OPEN_CLI_HOST_URL.
  -C | --no-catalog      whether to use given host-url directly without
-                        looking into catalog, it will overrid the
+                        looking into 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.
@@ -614,7 +613,7 @@ where::
                         default, it is read from environment variable
                         OPEN_CLI_HOST_URL.
  -C | --no-catalog      whether to use given host-url directly without
-                        looking into catalog, it will overrid the
+                        looking into 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.
@@ -685,7 +684,7 @@ where::
                         default, it is read from environment variable
                         OPEN_CLI_HOST_URL.
  -C | --no-catalog      whether to use given host-url directly without
-                        looking into catalog, it will overrid the
+                        looking into 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.
@@ -754,7 +753,7 @@ where::
                         default, it is read from environment variable
                         OPEN_CLI_HOST_URL.
  -C | --no-catalog      whether to use given host-url directly without
-                        looking into catalog, it will overrid the
+                        looking into 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.
@@ -831,7 +830,7 @@ where::
                         default, it is read from environment variable
                         OPEN_CLI_HOST_URL.
  -C | --no-catalog      whether to use given host-url directly without
-                        looking into catalog, it will overrid the
+                        looking into 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.
@@ -902,7 +901,7 @@ where::
                           default, it is read from environment variable
                           OPEN_CLI_HOST_URL.
  -C | --no-catalog        whether to use given host-url directly without
-                          looking into catalog, it will overrid the
+                          looking into 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.
@@ -968,7 +967,7 @@ where::
                               default, it is read from environment variable
                               OPEN_CLI_HOST_URL.
  -C | --no-catalog            whether to use given host-url directly without
-                              looking into catalog, it will overrid the
+                              looking into catalog, it will override the
                               service->mode. It is of type BOOL. It is
                               optional.
  -b | --threshold-unit        threshold. It is of type STRING. By default, it
@@ -1051,7 +1050,7 @@ where::
                           default, it is read from environment variable
                           OPEN_CLI_HOST_URL.
  -C | --no-catalog        whether to use given host-url directly without
-                          looking into catalog, it will overrid the
+                          looking into 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.
@@ -1126,7 +1125,7 @@ where::
  -r | --start-node-type   start-node-type. It is of type STRING. By
                           default, it is .
  -C | --no-catalog        whether to use given host-url directly without
-                          looking into catalog, it will overrid the
+                          looking into 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.
@@ -1197,7 +1196,7 @@ where::
                                     default, it is read from environment variable
                                     OPEN_CLI_HOST_URL.
  -C | --no-catalog                  whether to use given host-url directly without
-                                    looking into catalog, it will overrid the
+                                    looking into 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.
@@ -1268,7 +1267,7 @@ where::
                           default, it is read from environment variable
                           OPEN_CLI_HOST_URL.
  -C | --no-catalog        whether to use given host-url directly without
-                          looking into catalog, it will overrid the
+                          looking into 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.
@@ -1340,7 +1339,7 @@ where::
                                     default, it is read from environment variable
                                     OPEN_CLI_HOST_URL.
  -C | --no-catalog                  whether to use given host-url directly without
-                                    looking into catalog, it will overrid the
+                                    looking into 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.
@@ -1409,7 +1408,7 @@ where::
                           default, it is read from environment variable
                           OPEN_CLI_HOST_URL.
  -C | --no-catalog        whether to use given host-url directly without
-                          looking into catalog, it will overrid the
+                          looking into 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.
@@ -1487,7 +1486,7 @@ where::
                         is of type STRING. It is optional. By default, it
                         is .
  -C | --no-catalog      whether to use given host-url directly without
-                        looking into catalog, it will overrid the
+                        looking into 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.
@@ -1566,7 +1565,7 @@ where::
                           default, it is read from environment variable
                           OPEN_CLI_HOST_URL.
  -C | --no-catalog        whether to use given host-url directly without
-                          looking into catalog, it will overrid the
+                          looking into 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.
@@ -1630,7 +1629,7 @@ where::
                         default, it is read from environment variable
                         OPEN_CLI_HOST_URL.
  -C | --no-catalog      whether to use given host-url directly without
-                        looking into catalog, it will overrid the
+                        looking into 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.
@@ -1704,7 +1703,7 @@ where::
                         default, it is read from environment variable
                         OPEN_CLI_HOST_URL.
  -C | --no-catalog      whether to use given host-url directly without
-                        looking into catalog, it will overrid the
+                        looking into 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.
@@ -1749,3 +1748,71 @@ Results::
 Error::
 
  On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+tenant-create
+----------------------------------------------------
+
+usage: oclip tenant-create
+
+Create a tenant under given cloud region in Onap
+
+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] [-x | --cloud]
+ [-z | --tenant-id] [-y | --region] [-s | --long]
+ [-D | --context] [-r | --tenant-name] [-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 | --cloud           Onap cloud. It is of type STRING. By default, it
+                        is .
+ -z | --tenant-id       Onap cloud tenant id. It is of type STRING. By
+                        default, it is .
+ -y | --region          Onap cloud region. 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.
+ -r | --tenant-name     Onap cloud tenant name. 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.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+