1CEPH-CONF(8) Ceph CEPH-CONF(8)
2
6 ceph-conf - ceph conf file tool
7
9 ceph-conf -c conffile --list-all-sections
10 ceph-conf -c conffile -L
11 ceph-conf -c conffile -l prefix
12 ceph-conf key -s section1 ...
13 ceph-conf [-s section ] [-r] --lookup key
14 ceph-conf [-s section ] key
15
18 ceph-conf is a utility for getting information from a ceph configura‐
19 tion file. As with most Ceph programs, you can specify which Ceph con‐
20 figuration file to use with the -c flag.
21 Note that unlike other ceph tools, ceph-conf will only read from config
23 files (or return compiled-in default values)--it will not fetch config
24 values from the monitor cluster. For this reason it is recommended
25 that ceph-conf only be used in legacy environments that are strictly
26 config-file based. New deployments and tools should instead rely on
27 either querying the monitor explicitly for configuration (e.g., ceph
28 config get <daemon> <option>) or use daemons themselves to fetch effec‐
29 tive config options (e.g., ceph-osd -i 123 --show-config-value
30 osd_data). The latter option has the advantages of drawing from com‐
31 piled-in defaults (which occasionally vary between daemons), config
32 files, and the monitor's config database, providing the exact value
33 that that daemon would be using if it were started.
34
36 ceph-conf performs one of the following actions:
37 -L, --list-all-sections
39 list all sections in the configuration file.
40 -l, --list-sections *prefix*
42 list the sections with the given prefix. For example,
43 --list-sections mon would list all sections beginning with mon.
44 --lookup *key*
46 search and print the specified configuration setting. Note:
47 --lookup is the default action. If no other actions are given on
48 the command line, we will default to doing a lookup.
49 -h, --help
51 print a summary of usage.
52
54 -c *conffile*
55 the Ceph configuration file.
56 --filter-key *key*
58 filter section list to only include sections with given key de‐
59 fined.
60 --filter-key-value *key* ``=`` *value*
62 filter section list to only include sections with given
63 key/value pair.
64 --name *type.id*
66 the Ceph name in which the sections are searched (default
67 'client.admin'). For example, if we specify --name osd.0, the
68 following sections will be searched: [osd.0], [osd], [global]
69 --pid *pid*
71 override the $pid when expanding options. For example, if an op‐
72 tion is configured like /var/log/$name.$pid.log, the $pid por‐
73 tion in its value will be substituted using the PID of ceph-conf
74 instead of the PID of the process specified using the --name op‐
75 tion.
76 -r, --resolve-search
78 search for the first file that exists and can be opened in the
79 resulted comma delimited search list.
80 -s, --section
82 additional sections to search. These additional sections will
83 be searched before the sections that would normally be searched.
84 As always, the first matching entry we find will be returned.
85
87 To find out what value osd 0 will use for the "osd data" option:
88 ceph-conf -c foo.conf --name osd.0 --lookup "osd data"
90 To find out what value will mds a use for the "log file" option:
92 ceph-conf -c foo.conf --name mds.a "log file"
94 To list all sections that begin with "osd":
96 ceph-conf -c foo.conf -l osd
98 To list all sections:
100 ceph-conf -c foo.conf -L
102 To print the path of the "keyring" used by "client.0":
104 ceph-conf --name client.0 -r -l keyring
106
108 /etc/ceph/$cluster.conf, ~/.ceph/$cluster.conf, $cluster.conf
109 the Ceph configuration files to use if not specified.
111
113 ceph-conf is part of Ceph, a massively scalable, open-source, distrib‐
114 uted storage system. Please refer to the Ceph documentation at
115 https://docs.ceph.com for more information.
116
118 ceph(8),
119
121 2010-2023, Inktank Storage, Inc. and contributors. Licensed under Cre‐
122 ative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
123dev Nov 15, 2023 CEPH-CONF(8)