1MONMAPTOOL(8) Ceph MONMAPTOOL(8)
2
6 monmaptool - ceph monitor cluster map manipulation tool
7
9 monmaptool <action> [options] mapfilename
10
13 monmaptool is a utility to create, view, and modify a monitor cluster
14 map for the Ceph distributed storage system. The monitor map specifies
15 the only fixed addresses in the Ceph distributed system. All other
16 daemons bind to arbitrary addresses and register themselves with the
17 monitors.
18 When creating a map with --create, a new monitor map with a new, random
20 UUID will be created. It should be followed by one or more monitor ad‐
21 dresses.
22 The default Ceph monitor port for messenger protocol v1 is 6789, and
24 3300 for protocol v2.
25 Multiple actions can be performed per invocation.
27
29 --print
30 print a plaintext dump of the map, after any modifications are
31 made.
32 --feature-list [plain|parseable]
34 list the enabled features as well as the available ones.
35 By default, a human readable output is produced.
37 --create
39 create a new monitor map with a new UUID (and with it, a new,
40 empty Ceph cluster).
41 --clobber
43 allow monmaptool to create a new mapfilename in place of an ex‐
44 isting map.
45 Only useful when --create is used.
47 --generate
49 generate a new monmap based on the values on the command line or
50 specified in the ceph configuration. This is, in order of pref‐
51 erence,
52 1. --monmap filename to specify a monmap to load
54 2. --mon-host 'host1,ip2' to specify a list of hosts or ip
56 addresses
57 3. [mon.foo] sections containing mon addr settings in the
59 config. Note that this method is not recommended and sup‐
60 port will be removed in a future release.
61 --filter-initial-members
63 filter the initial monmap by applying the mon initial members
64 setting. Monitors not present in that list will be removed, and
65 initial members not present in the map will be added with dummy
66 addresses.
67 --add name ip[:port]
69 add a monitor with the specified ip:port to the map.
70 If the nautilus feature is set, and the port is not, the monitor
72 will be added for both messenger protocols.
73 --addv name [protocol:ip:port[,...]]
75 add a monitor with the specified version:ip:port to the map.
76 --rm name
78 remove the monitor with the specified name from the map.
79 --fsid uuid
81 set the fsid to the given uuid. If not specified with --create,
82 a random fsid will be generated.
83 --feature-set value [--optional|--persistent]
85 enable a feature.
86 --feature-unset value [--optional|--persistent]
88 disable a feature.
89 --enable-all-features
91 enable all supported features.
92 --set-min-mon-release release
94 set the min_mon_release.
95
97 To create a new map with three monitors (for a fresh Ceph cluster):
98 monmaptool --create --add nodeA 192.168.0.10 --add nodeB 192.168.0.11 \
100 --add nodeC 192.168.0.12 --enable-all-features --clobber monmap
101 To display the contents of the map:
103 monmaptool --print monmap
105 To replace one monitor:
107 monmaptool --rm nodeA monmap
109 monmaptool --add nodeA 192.168.0.9 monmap
110
112 monmaptool is part of Ceph, a massively scalable, open-source, distrib‐
113 uted storage system. Please refer to the Ceph documentation at
114 https://docs.ceph.com for more information.
115
117 ceph(8), crushtool(8),
118
120 2010-2022, Inktank Storage, Inc. and contributors. Licensed under Cre‐
121 ative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
122dev Oct 18, 2022 MONMAPTOOL(8)