.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CEPH-CONF" "8" "Oct 24, 2023" "dev" "Ceph"
.SH NAME
ceph-conf \- ceph conf file tool
.SH SYNOPSIS
.nf
\fBceph\-conf\fP \-c \fIconffile\fP \-\-list\-all\-sections
\fBceph\-conf\fP \-c \fIconffile\fP \-L
\fBceph\-conf\fP \-c \fIconffile\fP \-l \fIprefix\fP
\fBceph\-conf\fP \fIkey\fP \-s \fIsection1\fP ...
\fBceph\-conf\fP [\-s \fIsection\fP ] [\-r] \-\-lookup \fIkey\fP
\fBceph\-conf\fP [\-s \fIsection\fP ] \fIkey\fP
.fi
.sp
.SH DESCRIPTION
.sp
\fBceph\-conf\fP is a utility for getting information from a ceph
configuration file. As with most Ceph programs, you can specify which
Ceph configuration file to use with the \fB\-c\fP flag.
.sp
Note that unlike other ceph tools, \fBceph\-conf\fP will \fIonly\fP read from
config files (or return compiled\-in default values)\-\-it will \fInot\fP
fetch config values from the monitor cluster.  For this reason it is
recommended that \fBceph\-conf\fP only be used in legacy environments
that are strictly config\-file based.  New deployments and tools should
instead rely on either querying the monitor explicitly for
configuration (e.g., \fBceph config get <daemon> <option>\fP) or use
daemons themselves to fetch effective config options (e.g.,
\fBceph\-osd \-i 123 \-\-show\-config\-value osd_data\fP).  The latter option
has the advantages of drawing from compiled\-in defaults (which
occasionally vary between daemons), config files, and the monitor\(aqs
config database, providing the exact value that that daemon would be
using if it were started.
.SH ACTIONS
.sp
\fBceph\-conf\fP performs one of the following actions:
.INDENT 0.0
.TP
.B \-L, \-\-list\-all\-sections
list all sections in the configuration file.
.UNINDENT
.INDENT 0.0
.TP
.B \-l, \-\-list\-sections *prefix*
list the sections with the given \fIprefix\fP\&. For example, \fB\-\-list\-sections mon\fP
would list all sections beginning with \fBmon\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-lookup *key*
search and print the specified configuration setting. Note:  \fB\-\-lookup\fP is
the default action. If no other actions are given on the command line, we will
default to doing a lookup.
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
print a summary of usage.
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
.B \-c *conffile*
the Ceph configuration file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-filter\-key *key*
filter section list to only include sections with given \fIkey\fP defined.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-filter\-key\-value *key* \(ga\(ga=\(ga\(ga *value*
filter section list to only include sections with given \fIkey\fP/\fIvalue\fP pair.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-name *type.id*
the Ceph name in which the sections are searched (default \(aqclient.admin\(aq).
For example, if we specify \fB\-\-name osd.0\fP, the following sections will be
searched: [osd.0], [osd], [global]
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pid *pid*
override the \fB$pid\fP when expanding options. For example, if an option is
configured like \fB/var/log/$name.$pid.log\fP, the \fB$pid\fP portion in its
value will be substituted using the PID of \fBceph\-conf\fP instead of the
PID of the process specified using the \fB\-\-name\fP option.
.UNINDENT
.INDENT 0.0
.TP
.B \-r, \-\-resolve\-search
search for the first file that exists and can be opened in the resulted
comma delimited search list.
.UNINDENT
.INDENT 0.0
.TP
.B \-s, \-\-section
additional sections to search.  These additional sections will be searched
before the sections that would normally be searched. As always, the first
matching entry we find will be returned.
.UNINDENT
.SH EXAMPLES
.sp
To find out what value osd 0 will use for the \(dqosd data\(dq option:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
ceph\-conf \-c foo.conf  \-\-name osd.0 \-\-lookup \(dqosd data\(dq
.EE
.UNINDENT
.UNINDENT
.sp
To find out what value will mds a use for the \(dqlog file\(dq option:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
ceph\-conf \-c foo.conf  \-\-name mds.a \(dqlog file\(dq
.EE
.UNINDENT
.UNINDENT
.sp
To list all sections that begin with \(dqosd\(dq:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
ceph\-conf \-c foo.conf \-l osd
.EE
.UNINDENT
.UNINDENT
.sp
To list all sections:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
ceph\-conf \-c foo.conf \-L
.EE
.UNINDENT
.UNINDENT
.sp
To print the path of the \(dqkeyring\(dq used by \(dqclient.0\(dq:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
ceph\-conf \-\-name client.0 \-r \-l keyring
.EE
.UNINDENT
.UNINDENT
.SH FILES
.sp
\fB/etc/ceph/$cluster.conf\fP, \fB~/.ceph/$cluster.conf\fP, \fB$cluster.conf\fP
.sp
the Ceph configuration files to use if not specified.
.SH AVAILABILITY
.sp
\fBceph\-conf\fP is part of Ceph, a massively scalable, open\-source, distributed storage system.  Please refer
to the Ceph documentation at \fI\%https://docs.ceph.com\fP for more
information.
.SH SEE ALSO
.sp
\fI\%ceph\fP(8),
.SH COPYRIGHT
2010-2023, Inktank Storage, Inc. and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
.\" Generated by docutils manpage writer.
.