framework/src/test/resources/sample-cmd-test-help.txt

   1 usage: onap sample-test
   2
   3 Onap sample command to test the command features
   4
   5 Onap service: sample v1
   6
   7 Options:
   8 [-u | --onap-username] [-p | --onap-password] [-m | --host-url]
   9 [-h | --help] [-v | --version] [-d | --debug]
  10 [-f | --format] [-s | --long] [-t | --no-title]
  11 [-a | --no-auth] [-b | --bool] [-x | --secure]
  12 [-c | --string-param] [-y | --yaml-param] [-j | --json-param]
  13 [-l | --long-opt] [-r | --url] [-z | --env]
  14 <positional-args>
  15 where,
  16 -u | --onap-username   Onap user name. It is of type STRING. By
  17                         default, it is read from environment variable
  18                         ONAP_USERNAME.
  19 -p | --onap-password   Onap user password. It is of type STRING. By
  20                         default, it is read from environment variable
  21                         ONAP_PASSWORD. Secured.
  22 -m | --host-url          Onap MSB url. It is of type URL. By default, it
  23                         is read from environment variable ONAP_MSB_URL.
  24 -h | --help             Onap command help message. It is of type STRING.
  25                         By default, it is false.
  26 -v | --version          Onap command service version. It is of type
  27                         STRING. By default, it is false.
  28 -d | --debug            Enable debug output. It is of type BOOL. By
  29                         default, it is false.
  30 -f | --format           Output formats, supported formats such as table,
  31                         csv, json, yaml. It is of type STRING. By default,
  32                         it is table.
  33 -s | --long             whether to print all attributes or only short
  34                         attributes. It is of type BOOL. By default, it is
  35                         false.
  36 -t | --no-title         whether to print title or not. It is of type BOOL.
  37                         By default, it is false.
  38 -a | --no-auth          whether to authenticate user or not. It is of type
  39                         BOOL. By default, it is false.
  40 -b | --bool             Onap boolean param, by default its always false.
  41                         It is of type BOOL. It is optional. By default, it
  42                         is false.
  43 -x | --secure           Onap secure param such as password. It is of
  44                         type STRING. Secured.
  45 -c | --string-param     Onap string param. It is of type STRING.
  46 -y | --yaml-param       Onap yaml file location param. It is of type
  47                         JSON. It's recommended to input the complete path
  48                         of the file, which is having the value for it.
  49 -j | --json-param       Onap json file location param. It is of type
  50                         JSON. It's recommended to input the complete path
  51                         of the file, which is having the value for it.
  52 -l | --long-opt         Onap long param. It is of type LONG. By default,
  53                         it is 10.
  54 -r | --url              Onap url param. It is of type URL. By default,
  55                         it is http://localhost:8082/file.txt.
  56 -z | --env              Onap env param. It is of type STRING. By
  57                         default, it is read from environment variable
  58                         ENV_VAR.
  59 positional-args         Onap positional args, if no short option and no
  60                         long option given for it. It is of type STRING. By
  61                         default, it is http://localhost:8082/file.txt.
  62
  63
  64 Results:
  65 output-1  Onap output attribute marked in short and is of
  66           type STRING. It is secured.
  67 output-2  Onap output attribute marked in long and is of
  68           type STRING.
  69
  70
  71 Error:
  72 On error, it prints <HTTP STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>