import 15.2.0 Octopus source

[ceph.git] / ceph / src / test / cli / ceph-conf / help.t

  $ ceph-conf --help
  Ceph configuration query tool
  
  USAGE
  ceph-conf <flags> <action>
  
  ACTIONS
    -L|--list-all-sections          List all sections
    -l|--list-sections <prefix>     List sections with the given prefix
    --filter-key <key>              Filter section list to only include sections
                                    with given key defined.
    --filter-key-value <key>=<val>  Filter section list to only include sections
                                    with given key/value pair.
    --lookup <key>                  Print a configuration setting to stdout.
                                    Returns 0 (success) if the configuration setting is
                                    found; 1 otherwise.
    -r|--resolve-search             search for the first file that exists and
                                    can be opened in the resulted comma
                                    delimited search list.
    -D|--dump-all                   dump all variables.
    --show-config-value <key>       Print the corresponding ceph.conf value
                                    that matches the specified key. Also searches
                                    global defaults.
  
  FLAGS
    --name name                     Set type.id
    [-s <section>]                  Add to list of sections to search
    [--format plain|json|json-pretty]
                                    dump variables in plain text, json or pretty
                                    json
  
  If there is no action given, the action will default to --lookup.
  
  EXAMPLES
  [$] ceph-conf --name mon.0 -c /etc/ceph/ceph.conf 'mon addr' (re)
  Find out what the value of 'mon addr' is for monitor 0.
  
  [$] ceph-conf -l mon (re)
  List sections beginning with 'mon'.
  
  RETURN CODE
  Return code will be 0 on success; error code otherwise.