.\" 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 "MONMAPTOOL" "8" "Oct 24, 2023" "dev" "Ceph"
.SH NAME
monmaptool \- ceph monitor cluster map manipulation tool
.SH SYNOPSIS
.nf
\fBmonmaptool\fP <action> [options] \fImapfilename\fP
.fi
.sp
.SH DESCRIPTION
.sp
\fBmonmaptool\fP is a utility to create, view, and modify a monitor
cluster map for the Ceph distributed storage 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.
.sp
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.
.sp
The default Ceph monitor port for messenger protocol v1 is 6789, and
3300 for protocol v2.
.sp
Multiple actions can be performed per invocation.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-\-print
print a plaintext dump of the map, after any modifications are
made.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-feature\-list [plain|parseable]
list the enabled features as well as the available ones.
.sp
By default, a human readable output is produced.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-create
create a new monitor map with a new UUID (and with it, a new,
empty Ceph cluster).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-clobber
allow monmaptool to create a new mapfilename in place of an existing map.
.sp
Only useful when \fI\-\-create\fP is used.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-generate
generate a new monmap based on the values on the command line or specified
in the ceph configuration.  This is, in order of preference,
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP 1. 3
\fB\-\-monmap filename\fP to specify a monmap to load
.IP 2. 3
\fB\-\-mon\-host \(aqhost1,ip2\(aq\fP to specify a list of hosts or ip addresses
.IP 3. 3
\fB[mon.foo]\fP sections containing \fBmon addr\fP settings in the config. Note that this method is not recommended and support will be removed in a future release.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-filter\-initial\-members
filter the initial monmap by applying the \fBmon initial members\fP
setting.  Monitors not present in that list will be removed, and
initial members not present in the map will be added with dummy
addresses.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-add name ip[:port]
add a monitor with the specified ip:port to the map.
.sp
If the \fInautilus\fP feature is set, and the port is not, the monitor
will be added for both messenger protocols.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-addv name [protocol:ip:port[,...]]
add a monitor with the specified version:ip:port to the map.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-rm name
remove the monitor with the specified name from the map.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-fsid uuid
set the fsid to the given uuid.  If not specified with \fI\-\-create\fP, a random fsid will be generated.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-feature\-set value [\-\-optional|\-\-persistent]
enable a feature.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-feature\-unset value [\-\-optional|\-\-persistent]
disable a feature.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-enable\-all\-features
enable all supported features.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-set\-min\-mon\-release release
set the min_mon_release.
.UNINDENT
.SH EXAMPLE
.sp
To create a new map with three monitors (for a fresh Ceph cluster):
.INDENT 0.0
.INDENT 3.5
.sp
.EX
monmaptool \-\-create \-\-add nodeA 192.168.0.10 \-\-add nodeB 192.168.0.11 \e
  \-\-add nodeC 192.168.0.12 \-\-enable\-all\-features \-\-clobber monmap
.EE
.UNINDENT
.UNINDENT
.sp
To display the contents of the map:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
monmaptool \-\-print monmap
.EE
.UNINDENT
.UNINDENT
.sp
To replace one monitor:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
monmaptool \-\-rm nodeA monmap
monmaptool \-\-add nodeA 192.168.0.9 monmap
.EE
.UNINDENT
.UNINDENT
.SH AVAILABILITY
.sp
\fBmonmaptool\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),
\fI\%crushtool\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.
.