docs/user_guide.rst

   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.
   4
   5 .. _cli_user_guide:
   6
   7 CLI user guide
   8 ==============
   9
  10 **One Command to command whole Onap !!**
  11
  12 Provides unified commands to operate ONAP from Linux console.
  13 Configure the following environment variables, before using it:
  14
  15 1. **ONAP_HOST_URL** - Onap Micro service bus(MSB) URL or a service URL
  16 2. **ONAP_USERNAME** - Onap user name
  17 3. **ONAP_PASSWORD** - Onap user password
  18
  19 To Run a command
  20 -----------------
  21 Type **onap <command>** from linux console.
  22
  23 To Run in Interactive mode
  24 --------------------------
  25 Type **onap** from linux/web console.
  26
  27 And use the directive set to set the values for following parameters:
  28
  29 1. **host-url** - Onap Micro service bus(MSB) URL or a service URL
  30 2. **onap-username** - Onap user name
  31 3. **onap-password** - Onap user password
  32
  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 evironment variable
  37 **CLI_PROUDCT_VERSION**.
  38
  39 NOTE: In interactive mode, product version can be selected using
  40 typing **use <product-version>**
  41
  42 Run *onap [-v|--version]* to see the CLI and available product version details
  43
  44 Set the parameter values
  45 ------------------------
  46 Use the directive 'set' for setting the values for parameters and 'unset' for un-seting the values.
  47
  48 Help
  49 ----
  50 *onap [-h|--help]*
  51 *onap <command> [-h|--help]*
  52
  53 Debug Mode
  54 ----------
  55 To run in debug mode, set following environment variables:
  56 1. ONAP_CLI_DEBUG - By default its false, otherwise Set to true
  57 2. ONAP_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number
  58
  59 More details
  60 -------------
  61 https://wiki.onap.org
  62
  63 Command usage guide
  64 -------------------
  65 Following document provides the help message for list of command's supported in this release.
  66
  67 .. toctree::
  68    :maxdepth: 1
  69
  70    cmd_help.rst