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 attach {device}
100 Attach a lower-level device to an existing replicated device. See
101 drbdsetup(8) for details.
102 check-resize {device}
104 Call drbdmeta to eventually move internal meta data. If the backing
106 device was resized, while DRBD was not running, meta data has to be
107 moved to the end of the device, so that the next attach command can
108 succeed.
109 connect {connection}
111 Activate an exisiting connection to a peer. The connection needs to
113 be created first with the new-peer command, and have at least one
114 path created with the new-path command. See drbdsetup(8) for
115 details.
116 create-md {device}
118 Initialize the metadata of a device. This is necessary before a
120 device can be attached; see drbdmeta(8) for details.
121 cstate {connection}
123 Show the current state of a connection. See drbdsetup(8) for
125 details.
126 detach {device}
128 Detach the lower-level device of a replicated device. See
130 drbdsetup(8) for details.
131 disconnect {connection}
133 Remove a connection to a peer host. See drbdsetup(8) for details.
135 disk-options {device}
137 Change the disk options of an attached lower-level device. See
139 drbdsetup(8) for details.
140 down {resource}
142 Take a resource down by removing all volumes, connections, and the
144 resource itself. See drbdsetup(8) for details.
145 dstate {device}
147 Show the current disk state of a lower-level device. See
149 drbdsetup(8) for details.
150 dump {resource}
152 Parse the configuration file and dump it to stdout. This will fail
154 if the configuration file is syntactically incorrect.
155 dump-md {device}
157 Dump the metadata of a device in text form, including the bitmap
159 and activity log. See drbdmeta(8) for details.
160 get-gi {peer_device}
162 Show the data generation identifiers for a device on a particular
164 connection. Uses drbdsetup for attached devices and drbdmeta for
165 unattached devices. See drbdsetup(8) for details.
166 hidden-commands
168 Shows all commands which are not explicitly documented.
169 invalidate {peer_device}
171 Replace the local data of a device with that of a peer. See
173 drbdsetup(8) for details.
174 invalidate-remote {peer_device}
176 Replace a peer device's data of a resource with the local data. See
178 drbdsetup(8) for details.
179 net-options {connection}
181 Change the network options of an existing connection. See
183 drbdsetup(8) for details.
184 new-current-uuid {device}
186 Generate a new currend UUID. See drbdsetup(8) for details.
188 outdate {device}
190 Mark the data on a lower-level device as outdated. See drbdsetup(8)
192 for details.
193 pause-sync {peer_device}
195 Stop resynchronizing between a local and a peer device by setting
197 the local pause flag. See drbdsetup(8) for details.
198 primary {resource}
200 Change the role of a node in a resource to primary. See
202 drbdsetup(8) for details.
203 resize {device}
205 Resize the lower-level devices of a replicated device on all nodes.
207 This combines the check-resize and resize lower-level commands; see
208 drbdsetup(8) for details.
209 resource-options {resource}
211 Change the resource options of an existing resource. See
213 drbdsetup(8) for details.
214 resume-sync {peer_device}
216 Allow resynchronization to resume by clearing the local sync pause
218 flag. See drbdsetup(8) for details.
219 role {resource}
221 Show the current role of a resource.
223 secondary {resource}
225 Change the role of a node in a resource to secondary. This command
227 fails if the replicated device is in use.
228 show-gi {peer_device}
230 Show the data generation identifiers for a device on a particular
232 connection. In addition, explain the output. See drbdsetup(8) for
233 details.
234 state {resource}
236 This is an alias for drbdsetup role. Deprecated.
238 up {resource}
240 Bring up a resource by applying the activity log of all volumes,
242 creating the resource, creating the replicated devices, attaching
243 the lower-level devices, and connecting to all peers. See the
244 apply-al drbdmeta command and the new-resource, new-device,
245 new-minor, attach, and connect drbdsetup commands.
246 verify {peer_device}
248 Start online verification, change which part of the device will be
250 verified, or stop online verification. See drbdsetup(8) for
251 details.
252 wait-connect {[device] | [connection] | [resource]}
254 Wait until a device on a peer, all devices over a connection, or
256 all devices on all peers are visible. See drbdsetup(8) for details.
257 wait-sync {[device] | [connection] | [resource]}
259 Wait until a device is connected and has finished eventual resync
261 operation. Also available on connection and resource level. See
262 drbdsetup(8) for details.
263 wipe-md {device}
265 Wipe out the DRBD metadata of a device. See drbdmeta(8) for
267 details.
268 forget-peer {connection}
270 Completely remove any reference to a unconnected peer from
272 meta-data. See drbdmeta(8) for details.
273
275 This document was revised for version 9.0.0 of the DRBD distribution.
276
278 Written by Philipp Reisner <philipp.reisner@linbit.com> and Lars
279 Ellenberg <lars.ellenberg@linbit.com>
280
282 Report bugs to <drbd-user@lists.linbit.com>.
283
285 Copyright 2001-2018 LINBIT Information Technologies, Philipp Reisner,
286 Lars Ellenberg. This is free software; see the source for copying
287 conditions. There is NO warranty; not even for MERCHANTABILITY or
288 FITNESS FOR A PARTICULAR PURPOSE.
289
291 drbd.conf(5), drbd(8), drbdsetup(8), drbdmeta(8) and the DRBD project
292 web site[1]
293
295 1. DRBD project web site
296 http://www.drbd.org/
297DRBD 9.0.x 17 January 2018 DRBDADM(8)