src/ceph/doc/man/8/ceph-conf.rst

   1 :orphan:
   2
   3 ==================================
   4  ceph-conf -- ceph conf file tool
   5 ==================================
   6
   7 .. program:: ceph-conf
   8
   9 Synopsis
  10 ========
  11
  12 | **ceph-conf** -c *conffile* --list-all-sections
  13 | **ceph-conf** -c *conffile* -L
  14 | **ceph-conf** -c *conffile* -l *prefix*
  15 | **ceph-conf** *key* -s *section1* ...
  16 | **ceph-conf** [-s *section* ] [-r] --lookup *key*
  17 | **ceph-conf** [-s *section* ] *key*
  18
  19
  20 Description
  21 ===========
  22
  23 **ceph-conf** is a utility for getting information about a ceph
  24 configuration file. As with most Ceph programs, you can specify which
  25 Ceph configuration file to use with the ``-c`` flag.
  26
  27
  28 Actions
  29 =======
  30
  31 **ceph-conf** performs one of the following actions:
  32
  33 .. option:: -L, --list-all-sections
  34
  35    list all sections in the configuration file.
  36
  37 .. option:: -l, --list-sections *prefix*
  38
  39    list the sections with the given *prefix*. For example, ``--list-sections mon``
  40    would list all sections beginning with ``mon``.
  41
  42 .. option:: --lookup *key*
  43
  44    search and print the specified configuration setting. Note:  ``--lookup`` is
  45    the default action. If no other actions are given on the command line, we will
  46    default to doing a lookup.
  47
  48 .. option:: -h, --help
  49
  50    print a summary of usage.
  51
  52
  53 Options
  54 =======
  55
  56 .. option:: -c *conffile*
  57
  58    the Ceph configuration file.
  59
  60 .. option:: --filter-key *key*
  61
  62    filter section list to only include sections with given *key* defined.
  63
  64 .. option:: --filter-key-value *key* ``=`` *value*
  65
  66    filter section list to only include sections with given *key*/*value* pair.
  67
  68 .. option:: --name *type.id*
  69
  70    the Ceph name in which the sections are searched (default 'client.admin').
  71    For example, if we specify ``--name osd.0``, the following sections will be
  72    searched: [osd.0], [osd], [global]
  73
  74 .. option:: -r, --resolve-search
  75
  76    search for the first file that exists and can be opened in the resulted
  77    comma delimited search list.
  78
  79 .. option:: -s, --section
  80
  81    additional sections to search.  These additional sections will be searched
  82    before the sections that would normally be searched. As always, the first
  83    matching entry we find will be returned.
  84
  85
  86 Examples
  87 ========
  88
  89 To find out what value osd 0 will use for the "osd data" option::
  90
  91         ceph-conf -c foo.conf  --name osd.0 --lookup "osd data"
  92
  93 To find out what value will mds a use for the "log file" option::
  94
  95         ceph-conf -c foo.conf  --name mds.a "log file"
  96
  97 To list all sections that begin with "osd"::
  98
  99         ceph-conf -c foo.conf -l osd
 100
 101 To list all sections::
 102
 103         ceph-conf -c foo.conf -L
 104
 105 To print the path of the "keyring" used by "client.0"::
 106
 107        ceph-conf --name client.0 -r -l keyring
 108
 109
 110 Files
 111 =====
 112
 113 ``/etc/ceph/$cluster.conf``, ``~/.ceph/$cluster.conf``, ``$cluster.conf``
 114
 115 the Ceph configuration files to use if not specified.
 116
 117
 118 Availability
 119 ============
 120
 121 **ceph-conf** is part of Ceph, a massively scalable, open-source, distributed storage system.  Please refer
 122 to the Ceph documentation at http://ceph.com/docs for more
 123 information.
 124
 125
 126 See also
 127 ========
 128
 129 :doc:`ceph <ceph>`\(8),