docs/user_guide.rst

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