blob: f8680f0820a3c67bb01b1c7cafb4762f856bc854 (
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
|
<!DOCTYPE html><html><head><link rel="icon" href="./open-cli.png">
<meta charset="utf-8"><title>ONAP CLI</title><style></style></head><body id="preview">
<h1><a id="OPEN_Commandline_interface_CLI_0"></a>ONAP Command-line interface (CLI)</h1>
<p style="color:blue"><strong>One Command to command whole Onap !!</strong></p>
<p>Provides unified commands to operate ONAP from Linux console and Web console.</p>
<h2><a id="Download_42"></a>To download</h2>
<p style="color:red">Please download ONAP CLI <a href="./onap-cli.zip">here</a></p>
<h3><a id="Download_42"></a>To install</h3>
<p>Please follow the instructions given below for installing ONAP CLI.</p>
<ol>
<li>Un-zip the above download file into <b>/opt/onap/cli folder</b></li>
<li>Run the following commands:
<br>export ONAP_CLI_HOME=$CLI_INSTALL_DIR
<br>export CLI_PRODUCT_VERSION=onap-1.1
<br>
<br>cd $CLI_INSTALL_DIR
<br>
<br>if [ ! -d ./data ]; then mkdir ./data; fi
<br>if [ ! -d ./onap-cli-schema ]; then mkdir ./onap-cli-schema; fi
<br>
<br>chmod +x ./bin/onap.sh
<br>
<br>#Make onap available in path
<br>ln ./bin/onap.sh $CLI_BIN
<br>
<br>#Print the version
<br>onap -v</li>
</ol>
<h2><a id="Console_42"></a>Web Command console</h2>
<p style="color:blue">To open Console, Click <img src="./onap-cli.png" alt="Web Command console" style="width:30px;height:22px;" onclick="redirectToConsole();"> </p>
<h2><a id="To_Run_a_command_12"></a>To Run a command</h2>
<p>Configure the following environment variables, before using it in Linux console:</p>
<ol>
<li><strong>HOST_URL</strong> - Onap Micro service bus(MSB) URL or a service URL</li>
<li><strong>HOST_USERNAME</strong> - Onap user name</li>
<li><strong>HOST_PASSWORD</strong> - Onap user password</li>
</ol>
<p>Type <strong>onap <command></strong> from Linux console.</p>
<h2><a id="To_Run_in_Interactive_mode_16"></a>To Run in Interactive mode</h2>
<p>Type <strong>onap</strong> from linux console</p>
<h2><a id="Set_the_product_version_20"></a>Set the product version</h2>
<p>CLI framework is enhanced to handle multiple product versions at same<br>
time. so to choose the product version, set evironment variable<br>
<strong>CLI_PROUDCT_VERSION</strong>.</p>
<p>NOTE: In interactive mode, product version can be selected using<br>
typing <strong>use <product-version></strong></p>
<p>Run <em>onap [-v|–version]</em> to see the CLI and available product version details</p>
<h2><a id="Help_31"></a>Help</h2>
<p><em>onap [-h|–help]</em><br>
<em>onap <command> [-h|–help]</em></p>
<h2><a id="Debug_Mode_36"></a>Debug Mode</h2>
<p>To run in debug mode, set following environment variables:</p>
<ol>
<li>OPEN_CLI_DEBUG - By default its false, otherwise Set to true</li>
<li>OPEN_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number</li>
</ol>
<h2><a id="More_details_42"></a>More details</h2>
<p><a href="https://wiki.onap.org">https://wiki.onap.org</a></p>
<h2><a id="Download_42"></a>To download</h2>
<p style="color:red">Please download ONAP CLI <a href="./open-cli.zip">here</a></p>
</body></html>
|
