1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017 Huawei Technologies Co., Ltd.
10 **One Command to command whole Onap !!**
12 Provides unified commands to operate any products from Linux console and web command console.
13 Configure the following environment variables, before using it:
15 1. **OPEN_CLI_HOST_URL** - Catalog or service URL
16 2. **OPEN_CLI_HOST_USERNAME** - Service user name
17 3. **OPEN_CLI_HOST_PASSWORD** - Service user password
21 Type **oclip <command>** from linux console.
23 To Run in Interactive mode
24 --------------------------
25 Type **oclip** from linux/web console.
27 And use the directive set to set the values for following parameters:
29 1. **host-url** - Catalog or service URL
30 2. **host-username** - Service user name
31 3. **host-password** - Service user password
33 Set the product version
34 ------------------------
35 CLI framework is enhanced to handle multiple product versions at same
36 time. so to choose the product version, set environment variable
37 **OPEN_CLI_PROUDCT_IN_USE**.
39 NOTE: In interactive mode, product version can be selected using
40 typing **use <product-version>**
42 Run *oclip [-v|--version]* to see the CLI and available product version details
46 In interactive mode, user can use profiles for for “set arguments value once and use it ever”.
48 Please follow the steps given below for setting profiles:
50 1. Open the CLI interactive console
52 2. Create the profile, say ‘onap-deployment-1’ by running ‘profile onap-deployment-1’
53 There is no limit in number of profiles. OCLIP will create a profile if not exist already,
54 otherwise on typing 'profile' on the console, corresponding profiles will be effective.
55 So you can switch across profiles by using this directive 'profile'.
57 3. For example, to add the credentials, Run following steps:
59 a. set host-url=<aai-url>
61 b. set host-username=AAI
63 c. set host-pasword=AAI
65 d. Type 'set' to print all these arguments stored so far.
67 NOTE: Profiles are not limited to set only credentials, you can set any frequently using
68 common arguments, which are listed in command help.
70 NOTE: For setting service specific parameters, use in the form of <service-name>:<param-name>=<param-value>.
71 For example, following setting will be used only for aai service:
73 a. set aai:host-url=<aai-url>
75 b. set aai:host-username=AAI
77 c. set aai:host-pasword=AAI
80 4. You can override these stored arguments by providing them as arguments directly while
83 5. Profile information is persisted, so when you disconnect and connect again the CLI console,
84 you can start use the same profile again.
86 NOTE: Use the directive 'set' for setting the values for parameters and 'unset' for reseting the values.
88 In Beijing release, new default profile named as 'onap-beijing' is delivered with all default ONAP service
89 credentials. so user could use this profile to avoid setting the credentials every time.
91 Batching support & Parameter file
92 ---------------------------------
93 For a given scenario where, user wants to run a command with different set of inputs, this feature could be used.
95 For example, in ONAP, user wants to register multiple clouds at a given time, so user can create a parameter file
96 as given below and capture inputs for one or more clouds:
98 parameter file name: /usr/mrkanag/cloud-list.yaml
101 - name: cloud-region-1
102 - description: Provides the test cloud environment
104 - name: cloud-region-2
105 - description: Provides the production cloud environment
107 To register all these clouds in ONAP execute the cloud-register command with parameter file in inputs as below:
109 onap -p /usr/mrkanag/cloud-list.yaml cloud-register
111 Now OCLIP will iterate the command cloud-register for every cloud mentioned in the parameter file /usr/mrkanag/cloud-list.yaml.
112 When user use this approach to execute the command with multiple entries in parameter file is called as *batching*.
117 *oclip <command> [-h|--help]*
121 To run in debug mode, set following environment variables:
123 1. OPEN_CLI_CLI_DEBUG - By default its false, otherwise Set to true
125 2. OPEN_CLI_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number
129 https://wiki.onap.org
133 Following document provides the help message for commands supported in this release.
142 Following document provides the samples for commands supported in this release.
149 End to end service creation tutorial
150 ------------------------------------
151 Following document provides the tutorial for service creation using CLI.
156 end_to_end_onap_cli_commands.rst