blob: 64554682cae236c6ded4a7eb57d3f3b45c41d675 (
plain)
@media only all and (prefers-color-scheme: dark) {
.highlight .hll { background-color: #49483e }
.highlight .c { color: #75715e } /* Comment */
.highlight .err { color: #960050; background-color: #1e0010 } /* Error */
.highlight .k { color: #66d9ef } /* Keyword */
.highlight .l { color: #ae81ff } /* Literal */
.highlight .n { color: #f8f8f2 } /* Name */
.highlight .o { color: #f92672 } /* Operator */
.highlight .p { color: #f8f8f2 } /* Punctuation */
.highlight .ch { color: #75715e } /* Comment.Hashbang */
.highlight .cm { color: #75715e } /* Comment.Multiline */
.highlight .cp { color: #75715e } /* Comment.Preproc */
.highlight .cpf { color: #75715e } /* Comment.PreprocFile */
.highlight .c1 { color: #75715e } /* Comment.Single */
.highlight .cs { color: #75715e } /* Comment.Special */
.highlight .gd { color: #f92672 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gi { color: #a6e22e } /* Generic.Inserted */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #75715e } /* Generic.Subheading */
.highlight .kc { color: #66d9ef } /* Keyword.Constant */
.highlight .kd { color: #66d9ef } /* Keyword.Declaration */
.highlight .kn { color: #f92672 } /* Keyword.Namespace */
.highlight .kp { color: #66d9ef } /* Keyword.Pseudo */
.highlight .kr { color: #66d9ef } /* Keyword.Reserved */
.highlight .kt { color: #66d9ef } /* Keyword.Type */
.highlight .ld { color: #e6db74 } /* Literal.Date */
.highlight .m { color: #ae81ff } /* Literal.Number */
.highlight .s { color: #e6db74 } /* Literal.String */
.highlight .na { color: #a6e22e } /* Name.Attribute */
.highlight .nb { color: #f8f8f2 } /* Name.Builtin */
.highlight .nc { color: #a6e22e } /* Name.Class */
.highlight .no { color: #66d9ef } /* Name.Constant */
.highlight .nd { color: #a6e22e } /* Name.Decorator */
.highlight .ni { color: #f8f8f2 } /* Name.Entity */
.highlight .ne { color: #a6e22e } /* Name.Exception */
.highlight .nf { color: #a6e22e } /* Name.Function */
.highlight .nl { color: #f8f8f2 } /* Name.Label */
.highlight .nn { color: #f8f8f2 } /* Name.Namespace */
.highlight .nx { color: #a6e22e } /* Name.Other */
.highlight .py { color: #f8f8f2 } /* Name.Property */
.highlight .nt { color: #f92672 } /* Name.Tag */
.highlight .nv { color: #f8f8f2 } /* Name.Variable */
.highlight .ow { color: #f92672 } /* Operator.Word */
.highlight .w { color: #f8f8f2 } /* Text.Whitespace */
.highlight .mb { color: #ae81ff } /* Literal.Number.Bin */
.highlight .mf { color: #ae81ff } /* Literal.Number.Float */
.highlight .mh { color: #ae81ff } /* Literal.Number.Hex */
.highlight .mi { color: #ae81ff } /* Literal.Number.Integer */
.highlight .mo { color: #ae81ff } /* Literal.Number.Oct */
.highlig.. 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_HOST_URL** - Onap Micro service bus(MSB) URL or a service URL
2. **OPEN_USERNAME** - Onap user name
3. **OPEN_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:
<<<<<<< 08468db7c00dd0594d6846c4c761f0582be9fc06
1. ONAP_CLI_DEBUG - By default its false, otherwise Set to true
2. ONAP_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number
=======
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
>>>>>>> Migrate docs to use OPEN_ instead of ONAP_
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
