1DRBDADM(8) System Administration DRBDADM(8)
2
6 drbdadm - Utility for DRBD administration
7
9 drbdadm [options...] [-- [backend-options...]] {command} {context...}
10
12 The drbdadm utility is used for managing DRBD based on its
13 configuration files, see drbd.conf(5). It translates high-level
14 commands into one or more lower-level commands for the drbdsetup and
15 drbdmeta utilities, which control the kernel module and manipulate the
16 on-disk metadata.
17 Depending on the command, the drbdadm utility operates on one or more
19 resources, devices, connections, or peer devices. The following command
20 contexts are defined:
21 resource
23 A resource specified by name, or the keyword all for all defined
24 resources.
25 device
27 A device, specified by minor number (minor-minornumber, e.g.
28 minor-0) or by resource and volume number (resource/volume). If
29 only a resource is specified, the command iterates over all devices
30 of that resource.
31 connection
33 A connection, specified by resource and connection name
34 (resource:connection-name). If only a resource is specified, the
35 command iterates over all connections of that resource.
36 peer_device
38 A peer device, specified by resource, connection name, and volume
39 number (resource:connection-name/volume). If only a resource,
40 device, or connection is specified, the command iterates over all
41 peer devices of that resource, device, or connection.
42 All options following a double-dash are passed through to the
44 lower-level utilities as specified. In addition, drbdadm understands
45 most of the options of drbdsetup, and will pass them through even
46 without the double-dash.
47
49 -d, --dry-run
50 Show which commands drbdadm would execute instead of actually
51 executing them (for example, drbdadm -d up resource). This can be a
52 useful way to learn how drbdsetup and drbdmeta are used.
53 -c, --config-file file
55 Use an alternative configuration file. By default, drbdadm will use
56 the the first of the following files that exists:
57 /etc/drbd-90.conf, /etc/drbd-84.conf, /etc/drbd-83.conf,
58 /etc/drbd-82.conf, /etc/drbd-08.conf, /etc/drbd.conf.
59 -t, --config-to-test file
61 Check an additional configuration file. This option is only allowed
62 with the dump and the sh-nop commands.
63 -s, --drbdsetup file
65 Specifies the full path to the drbdsetup program. If this option is
66 omitted, drbdadm will look for it beneath itself first, and then in
67 the PATH.
68 -m, --drbdmeta file
70 Specifies the full path to the drbdmeta program. If this option is
71 omitted, drbdadm will look for it beneath itself first, and then in
72 the PATH.
73 -S, --stacked
75 Perform the command on a stacked resource.
76
78 adjust {resource}
79 Adjust the configuration of the kernel module so that it matches
81 the configuration files. The result should be the same as when
82 stopping and restarting all resources (drbdadm down all followed by
83 drbdadm up all), but without the interruptions.
84 Note that the adjust command can misinterpret the configuration
86 change in some cases. To be safe, check what the command would do
87 (with the --dry-run option) before running the actual command.
88 adjust-with-progress {resource}
90 The same as adjust, but with some more information about the
92 command's progress.
93 apply-al {device}
95 Apply the activity log of the specified device. See drbdmeta(8) for
97 details.
98 repair-md {device}
100 Check and repair metadata of the specified device. See drbdmeta(8)
102 for details.
103 attach {device}
105 Attach a lower-level device to an existing replicated device. See
106 drbdsetup(8) for details.
107 check-resize {device}
109 Call drbdmeta to eventually move internal meta data. If the backing
111 device was resized, while DRBD was not running, meta data has to be
112 moved to the end of the device, so that the next attach command can
113 succeed.
114 connect {connection}
116 Activate an exisiting connection to a peer. The connection needs to
118 be created first with the new-peer command, and have at least one
119 path created with the new-path command. See drbdsetup(8) for
120 details.
121 create-md {device}
123 Initialize the metadata of a device. This is necessary before a
125 device can be attached; see drbdmeta(8) for details.
126 cstate {connection}
128 Show the current state of a connection. See drbdsetup(8) for
130 details.
131 detach {device}
133 Detach the lower-level device of a replicated device. See
135 drbdsetup(8) for details.
136 disconnect {connection}
138 Remove a connection to a peer host. See drbdsetup(8) for details.
140 disk-options {device}
142 Change the disk options of an attached lower-level device. See
144 drbdsetup(8) for details.
145 down {resource}
147 Take a resource down by removing all volumes, connections, and the
149 resource itself. See drbdsetup(8) for details.
150 dstate {device}
152 Show the current disk state of a lower-level device. See
154 drbdsetup(8) for details.
155 dump {resource}
157 Parse the configuration file and dump it to stdout. This will fail
159 if the configuration file is syntactically incorrect.
160 dump-md {device}
162 Dump the metadata of a device in text form, including the bitmap
164 and activity log. See drbdmeta(8) for details.
165 get-gi {peer_device}
167 Show the data generation identifiers for a device on a particular
169 connection. Uses drbdsetup for attached devices and drbdmeta for
170 unattached devices. See drbdsetup(8) for details.
171 hidden-commands
173 Shows all commands which are not explicitly documented.
174 invalidate {peer_device}
176 Replace the local data of a device with that of a peer. See
178 drbdsetup(8) for details.
179 invalidate-remote {peer_device}
181 Replace a peer device's data of a resource with the local data. See
183 drbdsetup(8) for details.
184 net-options {connection}
186 Change the network options of an existing connection. See
188 drbdsetup(8) for details.
189 new-current-uuid {device}
191 Generate a new currend UUID. See drbdsetup(8) for details.
193 outdate {device}
195 Mark the data on a lower-level device as outdated. See drbdsetup(8)
197 for details.
198 pause-sync {peer_device}
200 Stop resynchronizing between a local and a peer device by setting
202 the local pause flag. See drbdsetup(8) for details.
203 primary {resource}
205 Change the role of a node in a resource to primary. See
207 drbdsetup(8) for details.
208 resize {device}
210 Resize the lower-level devices of a replicated device on all nodes.
212 This combines the check-resize and resize lower-level commands; see
213 drbdsetup(8) for details.
214 resource-options {resource}
216 Change the resource options of an existing resource. See
218 drbdsetup(8) for details.
219 resume-sync {peer_device}
221 Allow resynchronization to resume by clearing the local sync pause
223 flag. See drbdsetup(8) for details.
224 role {[resource] | [connection]}
226 Show the current role of a resource or the role of a resource on a
228 peer.
229 secondary {resource}
231 Change the role of a node in a resource to secondary. This command
233 fails if the replicated device is in use.
234 show-gi {peer_device}
236 Show the data generation identifiers for a device on a particular
238 connection. In addition, explain the output. See drbdsetup(8) for
239 details.
240 state {resource}
242 This is an alias for drbdsetup role. Deprecated.
244 up {resource}
246 Bring up a resource by applying the activity log of all volumes,
248 creating the resource, creating the replicated devices, attaching
249 the lower-level devices, and connecting to all peers. See the
250 apply-al drbdmeta command and the new-resource, new-device,
251 new-minor, attach, and connect drbdsetup commands.
252 verify {peer_device}
254 Start online verification, change which part of the device will be
256 verified, or stop online verification. See drbdsetup(8) for
257 details.
258 wait-connect {[device] | [connection] | [resource]}
260 Wait until a device on a peer, all devices over a connection, or
262 all devices on all peers are visible. See drbdsetup(8) for details.
263 wait-sync {[device] | [connection] | [resource]}
265 Wait until a device is connected and has finished eventual resync
267 operation. Also available on connection and resource level. See
268 drbdsetup(8) for details.
269 wipe-md {device}
271 Wipe out the DRBD metadata of a device. See drbdmeta(8) for
273 details.
274 forget-peer {connection}
276 Completely remove any reference to a unconnected peer from
278 meta-data. See drbdmeta(8) for details.
279
281 This document was revised for version 9.0.0 of the DRBD distribution.
282
284 Written by Philipp Reisner <philipp.reisner@linbit.com> and Lars
285 Ellenberg <lars.ellenberg@linbit.com>
286
288 Report bugs to <drbd-user@lists.linbit.com>.
289
291 Copyright 2001-2018 LINBIT Information Technologies, Philipp Reisner,
292 Lars Ellenberg. This is free software; see the source for copying
293 conditions. There is NO warranty; not even for MERCHANTABILITY or
294 FITNESS FOR A PARTICULAR PURPOSE.
295
297 drbd.conf(5), drbd(8), drbdsetup(8), drbdmeta(8) and the DRBD project
298 web site[1]
299
301 1. DRBD project web site
302 http://www.drbd.org/
303DRBD 9.0.x 17 January 2018 DRBDADM(8)