mirror of
https://github.com/ceph/ceph
synced 2025-02-27 13:02:26 +00:00
60aea05423
Includes various content cleanups: layout of synopsis, layout of comments in examples, typos. Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
88 lines
2.2 KiB
ReStructuredText
88 lines
2.2 KiB
ReStructuredText
==============================
|
|
cconf -- ceph conf file tool
|
|
==============================
|
|
|
|
.. program:: cconf
|
|
|
|
Synopsis
|
|
========
|
|
|
|
| **cconf** -c *conffile* --list-all-sections
|
|
| **cconf** -c *conffile* -L
|
|
| **cconf** -c *conffile* -l *prefix*
|
|
| **cconf** *key* -s *section1* ...
|
|
| **cconf** [-s *section* ] --lookup *key*
|
|
| **cconf** [-s *section* ] *key*
|
|
|
|
|
|
Description
|
|
===========
|
|
|
|
**cconf** 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 ``-c`` flag.
|
|
|
|
|
|
Actions
|
|
=======
|
|
|
|
.. TODO format this like a proper man page
|
|
|
|
**cconf** will perform one of the following actions:
|
|
|
|
--list-all-sections or -L prints out a list of all the section names in the configuration
|
|
file.
|
|
|
|
--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.
|
|
|
|
--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.
|
|
|
|
For example, if we specify --name osd.0, the following sections will be searched:
|
|
[osd.0], [osd], [global]
|
|
|
|
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.
|
|
|
|
Note: --lookup is the default action. If no other actions are given on the command line,
|
|
we will default to doing a lookup.
|
|
|
|
|
|
Examples
|
|
========
|
|
|
|
To find out what value osd 0 will use for the "osd data" option::
|
|
|
|
cconf -c foo.conf --name osd.0 --lookup "osd data"
|
|
|
|
To find out what value will mds a use for the "log file" option::
|
|
|
|
cconf -c foo.conf --name mds.a "log file"
|
|
|
|
To list all sections that begin with osd::
|
|
|
|
cconf -c foo.conf -l osd
|
|
|
|
To list all sections::
|
|
|
|
cconf -c foo.conf -L
|
|
|
|
|
|
Availability
|
|
============
|
|
|
|
**cconf** is part of the Ceph distributed file system. Please refer
|
|
to the Ceph wiki at http://ceph.newdream.net/wiki for more
|
|
information.
|
|
|
|
|
|
See also
|
|
========
|
|
|
|
:doc:`ceph <ceph>`\(8),
|
|
:doc:`mkcephfs <mkcephfs>`\(8)
|