3 ==================================
4 ceph-conf -- ceph conf file tool
5 ==================================
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*
23 **ceph-conf** is a utility for getting information from a ceph
24 configuration file. As with most Ceph programs, you can specify which
25 Ceph configuration file to use with the ``-c`` flag.
27 Note that unlike other ceph tools, **ceph-conf** will *only* read from
28 config files (or return compiled-in default values)--it will *not*
29 fetch config values from the monitor cluster. For this reason it is
30 recommended that **ceph-conf** only be used in legacy environments
31 that are strictly config-file based. New deployments and tools should
32 instead rely on either querying the monitor explicitly for
33 configuration (e.g., ``ceph config get <daemon> <option>``) or use
34 daemons themselves to fetch effective config options (e.g.,
35 ``ceph-osd -i 123 --show-config-value osd_data``). The latter option
36 has the advantages of drawing from compiled-in defaults (which
37 occasionally vary between daemons), config files, and the monitor's
38 config database, providing the exact value that that daemon would be
39 using if it were started.
44 **ceph-conf** performs one of the following actions:
46 .. option:: -L, --list-all-sections
48 list all sections in the configuration file.
50 .. option:: -l, --list-sections *prefix*
52 list the sections with the given *prefix*. For example, ``--list-sections mon``
53 would list all sections beginning with ``mon``.
55 .. option:: --lookup *key*
57 search and print the specified configuration setting. Note: ``--lookup`` is
58 the default action. If no other actions are given on the command line, we will
59 default to doing a lookup.
61 .. option:: -h, --help
63 print a summary of usage.
69 .. option:: -c *conffile*
71 the Ceph configuration file.
73 .. option:: --filter-key *key*
75 filter section list to only include sections with given *key* defined.
77 .. option:: --filter-key-value *key* ``=`` *value*
79 filter section list to only include sections with given *key*/*value* pair.
81 .. option:: --name *type.id*
83 the Ceph name in which the sections are searched (default 'client.admin').
84 For example, if we specify ``--name osd.0``, the following sections will be
85 searched: [osd.0], [osd], [global]
87 .. option:: -r, --resolve-search
89 search for the first file that exists and can be opened in the resulted
90 comma delimited search list.
92 .. option:: -s, --section
94 additional sections to search. These additional sections will be searched
95 before the sections that would normally be searched. As always, the first
96 matching entry we find will be returned.
102 To find out what value osd 0 will use for the "osd data" option::
104 ceph-conf -c foo.conf --name osd.0 --lookup "osd data"
106 To find out what value will mds a use for the "log file" option::
108 ceph-conf -c foo.conf --name mds.a "log file"
110 To list all sections that begin with "osd"::
112 ceph-conf -c foo.conf -l osd
114 To list all sections::
116 ceph-conf -c foo.conf -L
118 To print the path of the "keyring" used by "client.0"::
120 ceph-conf --name client.0 -r -l keyring
126 ``/etc/ceph/$cluster.conf``, ``~/.ceph/$cluster.conf``, ``$cluster.conf``
128 the Ceph configuration files to use if not specified.
134 **ceph-conf** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer
135 to the Ceph documentation at http://ceph.com/docs for more
142 :doc:`ceph <ceph>`\(8),