ceph/man/ceph-conf.8

160 lines
4.0 KiB
Groff

.\" Man page generated from reStructuredText.
.
.TH "CEPH-CONF" "8" "January 12, 2014" "dev" "Ceph"
.SH NAME
ceph-conf \- ceph conf file tool
.
.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
..
.
.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
..
.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 ] \-\-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 about a ceph
configuration file. As with most Ceph programs, you can specify which
Ceph configuration file to use with the \fB\-c\fP flag.
.SH ACTIONS
.sp
\fBceph\-conf\fP will perform one of the following actions:
.sp
\-\-list\-all\-sections or \-L prints out a list of all the section names in the configuration
file.
.sp
\-\-list\-sections or \-l prints out a list of all the sections that begin
with a given prefix. For example, \-\-list\-sections mon would list all
sections beginning with mon.
.sp
\-\-lookup will search the configuration for a given value. By default, the sections that
are searched are determined by the Ceph name that we are using. The Ceph name defaults to
client.admin. It can be specified with \-\-name.
.sp
For example, if we specify \-\-name osd.0, the following sections will be searched:
[osd.0], [osd], [global]
.sp
You can specify additional sections to search with \-\-section or \-s. 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.
.sp
Note: \-\-lookup is the default action. If no other actions are given on the command line,
we will default to doing a lookup.
.SH EXAMPLES
.sp
To find out what value osd 0 will use for the "osd data" option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ceph\-conf \-c foo.conf \-\-name osd.0 \-\-lookup "osd data"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To find out what value will mds a use for the "log file" option:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ceph\-conf \-c foo.conf \-\-name mds.a "log file"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To list all sections that begin with osd:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ceph\-conf \-c foo.conf \-l osd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To list all sections:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ceph\-conf \-c foo.conf \-L
.ft P
.fi
.UNINDENT
.UNINDENT
.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\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.sp
\fBceph\fP(8),
.SH COPYRIGHT
2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.