ceph/doc/man/8/monmaptool.rst
Tommi Virtanen 60aea05423 doc: Convert manpages to doc/man/.
Includes various content cleanups: layout of synopsis, layout
of comments in examples, typos.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-09 16:26:40 -07:00

87 lines
2.0 KiB
ReStructuredText

==========================================================
monmaptool -- ceph monitor cluster map manipulation tool
==========================================================
.. program:: monmaptool
Synopsis
========
| **monmaptool** *mapfilename* [ --clobber ] [ --print ] [ --create ]
[ --add *ip*:*port* *...* ] [ --rm *ip*:*port* *...* ]
Description
===========
**monmaptool** is a utility to create, view, and modify a monitor
cluster map for the Ceph distributed file system. The monitor map
specifies the only fixed addresses in the Ceph distributed system.
All other daemons bind to arbitrary addresses and register themselves
with the monitors.
When creating a map with --create, a new monitor map with a new,
random UUID will be created. It should be followed by one or more
monitor addresses.
The default Ceph monitor port is 6789.
Options
=======
.. option:: --print
will print a plaintext dump of the map, after any modifications are
made.
.. option:: --clobber
will allow monmaptool to overwrite mapfilename if changes are made.
.. option:: --create
will create a new monitor map with a new UUID (and with it, a new,
empty Ceph file system).
.. option:: --add name ip:port
will add a monitor with the specified ip:port to the map.
.. option:: --rm name
will remove the monitor with the specified ip:port from the map.
Example
=======
To create a new map with three monitors (for a fresh Ceph file system)::
monmaptool --create --add mon.a 192.168.0.10:6789 --add mon.b 192.168.0.11:6789 \
--add mon.c 192.168.0.12:6789 --clobber monmap
To display the contents of the map::
monmaptool --print onmap
To replace one monitor::
monmaptool --rm mon.a --add mon.a 192.168.0.9:6789 --clobber monmap
Availability
============
**monmaptool** 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:`crushtool <crushtool>`\(8),
:doc:`mkcephfs <mkcephfs>`\(8)