blob: cb1d71e7b09cff95a8d8e58920ccef1ada3d78c6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 Huawei Technologies Co., Ltd.
.. _cli_user_guide:
CLI user guide
==============
**One Command to command whole Onap !!**
Provides unified commands to operate ONAP from Linux console.
Configure the following environment variables, before using it:
1. **OPEN_CLI_HOST_URL** - Onap Micro service bus(MSB) URL or a service URL
2. **OPEN_CLI_USERNAME** - Onap user name
3. **OPEN_CLI_PASSWORD** - Onap user password
To Run a command
-----------------
Type **onap <command>** from linux console.
To Run in Interactive mode
--------------------------
Type **onap** from linux/web console.
And use the directive set to set the values for following parameters:
1. **host-url** - Onap Micro service bus(MSB) URL or a service URL
2. **onap-username** - Onap user name
3. **onap-password** - Onap user password
Set the product version
------------------------
CLI framework is enhanced to handle multiple product versions at same
time. so to choose the product version, set environment variable
**CLI_PROUDCT_VERSION**.
NOTE: In interactive mode, product version can be selected using
typing **use <product-version>**
Run *onap [-v|--version]* to see the CLI and available product version details
Set the parameter values
------------------------
Use the directive 'set' for setting the values for parameters and 'unset' for reseting the values.
Help
----
*onap [-h|--help]*
*onap <command> [-h|--help]*
Debug Mode
----------
To run in debug mode, set following environment variables:
1. OPEN_CLI_DEBUG - By default its false, otherwise Set to true
2. OPEN_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number
More details
-------------
https://wiki.onap.org
Command usage guide
-------------------
Following document provides the help message for commands supported in this release.
.. toctree::
:maxdepth: 1
cmd_help.rst
Command Samples
---------------
Following document provides the samples for commands supported in this release.
.. toctree::
:maxdepth: 1
cmd_sample.rst
|
