1DRBDADM(8)                   System Administration                  DRBDADM(8)
2
3
4

NAME

6       drbdadm - Administration tool for DRBD
7

SYNOPSIS

9       drbdadm [-d] [-c {file}] [-t {file}] [-s {cmd}] [-m {cmd}] [-S]
10               [-h {host}] [-- {backend-options}] {command} [all |
11               resource...]
12

DESCRIPTION

14       Drbdadm is the high level tool of the DRBD program suite.  Drbdadm is
15       to drbdsetup and drbdmeta what ifup/ifdown is to ifconfig.  Drbdadm
16       reads its configuration file and performs the specified commands by
17       calling the drbdsetup and/or the drbdmeta program.
18

OPTIONS

20       -d, --dry-run
21           Just prints the calls of drbdsetup to stdout, but does not run the
22           commands.
23
24       -c, --config-file file
25           Specifies the configuration file drbdadm will use. If this
26           parameter is not specified, drbdadm will look for
27           /etc/drbd-83.conf, /etc/drbd-08.conf and /etc/drbd.conf.
28
29       -t, --config-to-test file
30           Specifies an additional configuration file drbdadm to check. This
31           option is only allowed with the dump and the sh-nop commands.
32
33       -s, --drbdsetup file
34           Specifies the full path to the drbdsetup program. If this option is
35           omitted, drbdadm will look for /sbin/drbdsetup and ./drbdsetup.
36
37       -m, --drbdmeta file
38           Specifies the full path to the drbdmeta program. If this option is
39           omitted, drbdadm will look for /sbin/drbdmeta and ./drbdmeta.
40
41       -S, --stacked
42           Specifies that this command should be performed on a stacked
43           resource.
44
45       -P, --peer
46           Specifies to which peer node to connect. Only necessary if there
47           are more than two host sections in the resource you are working on.
48
49       -- backend-options
50           All options following the doubly hyphen are considered
51           backend-options. These are passed through to the backend command.
52           I.e. to drbdsetup, drbdmeta or drbd-proxy-ctl.
53

COMMANDS

55       attach
56           Attaches a local backing block device to the DRBD resource's
57           device.
58
59       detach
60
61           Removes the backing storage device from a DRBD resource's device.
62
63       connect
64
65           Sets up the network configuration of the resource's device. If the
66           peer device is already configured, the two DRBD devices will
67           connect. If there are more than two host sections in the resource
68           you need to use the --peer option to select the peer you want to
69           connect to.
70
71       disconnect
72
73           Removes the network configuration from the resource. The device
74           will then go into StandAlone state.
75
76       syncer
77
78           Loads the resynchronization parameters into the device.
79
80       up
81
82           Is a shortcut for attach and connect.
83
84       down
85
86           Is a shortcut for disconnect and detach.
87
88       primary
89
90           Promote the resource's device into primary role. You need to do
91           this before any access to the device, such as creating or mounting
92           a file system.
93
94       secondary
95
96           Brings the device back into secondary role. This is needed since in
97           a connected DRBD device pair, only one of the two peers may have
98           primary role (except if allow-two-primaries is explicitly set in
99           the configuration file).
100
101       invalidate
102
103           Forces DRBD to consider the data on the local backing storage
104           device as out-of-sync. Therefore DRBD will copy each and every
105           block from its peer, to bring the local storage device back in
106           sync. To avoid races, you need an established replication link, or
107           be disconnected Secondary.
108
109       invalidate-remote
110
111           This command is similar to the invalidate command, however, the
112           peer's backing storage is invalidated and hence rewritten with the
113           data of the local node. To avoid races, you need an established
114           replication link, or be disconnected Primary.
115
116       resize
117
118           Causes DRBD to re-examine all sizing constraints, and resize the
119           resource's device accordingly. For example, if you increased the
120           size of your backing storage devices (on both nodes, of course),
121           then DRBD will adopt the new size after you called this command on
122           one of your nodes. Since new storage space must be synchronised
123           this command only works if there is at least one primary node
124           present.
125
126           The --assume-peer-has-space allows you to resize a device which is
127           currently not connected to the peer. Use with care, since if you do
128           not resize the peer's disk as well, further connect attempts of the
129           two will fail.
130
131           The --assume-clean allows you to resize an existing device and
132           avoid syncing the new space. This is useful when adding addtional
133           blank storage to your device. Example:
134
135               # drbdadm -- --assume-clean resize r0
136
137
138       check-resize
139
140           Calls drbdmeta to eventually move internal meta data. If the
141           backing device was resized, while DRBD was not running, meta data
142           has to be moved to the end of the device, so that the next attach
143           command can succeed.
144
145       create-md
146
147           Initializes the meta data storage. This needs to be done before a
148           DRBD resource can be taken online for the first time. In case of
149           issues with that command have a look at drbdmeta(8)
150
151       get-gi
152
153           Shows a short textual representation of the data generation
154           identifiers.
155
156       show-gi
157
158           Prints a textual representation of the data generation identifiers
159           including explanatory information.
160
161       dump-md
162
163           Dumps the whole contents of the meta data storage, including the
164           stored bit-map and activity-log, in a textual representation.
165
166       outdate
167
168           Sets the outdated flag in the meta data.
169
170       adjust
171
172           Synchronizes the configuration of the device with your
173           configuration file. You should always examine the output of the
174           dry-run mode before actually executing this command.
175
176       wait-connect
177
178           Waits until the device is connected to its peer device.
179
180       role
181
182           Shows the current roles of the devices (local/peer). E.g.
183           Primary/Secondary
184
185       state
186
187           Deprecated alias for "role", see above.
188
189       cstate
190
191           Shows the current connection state of the devices.
192
193       status
194
195           Shows the current status of all devices defined in the current
196           config file, in XML-like format. Example output:
197
198               <drbd-status version="8.3.2" api="88">
199               <resources config_file="/etc/drbd.conf">
200               <resource minor="0" name="s0" cs="SyncTarget" st1="Secondary" st2="Secondary"
201                         ds1="Inconsistent" ds2="UpToDate" resynced_precent="5.9" />
202               <resource minor="1" name="s1" cs="WFConnection" st1="Secondary"
203                         st2="Unknown" ds1="Inconsistent" ds2="Outdated" />
204               <resource minor="3" name="dummy" cs="Unconfigured" />
205               <!-- resource minor="4" name="scratch" not available or not yet created -->
206               </resources>
207               </drbd-status>
208
209
210       dump
211
212           Just parse the configuration file and dump it to stdout. May be
213           used to check the configuration file for syntactic correctness.
214
215       outdate
216
217           Used to mark the node's data as outdated. Usually used by the
218           peer's fence-peer handler.
219
220       verify
221
222           Starts online verify. During online verify, data on both nodes is
223           compared for equality. See /proc/drbd for online verify progress.
224           If out-of-sync blocks are found, they are not resynchronized
225           automatically. To do that, disconnect and connect the resource when
226           verification has completed.
227
228           See also the notes on data integrity on the drbd.conf manpage.
229
230       pause-sync
231
232           Temporarily suspend an ongoing resynchronization by setting the
233           local pause flag. Resync only progresses if neither the local nor
234           the remote pause flag is set. It might be desirable to postpone
235           DRBD's resynchronization until after any resynchronization of the
236           backing storage's RAID setup.
237
238       resume-sync
239
240           Unset the local sync pause flag.
241
242       new-current-uuid
243
244           Generates a new currend UUID and rotates all other UUID values.
245
246           This can be used to shorten the initial resync of a cluster. See
247           the drbdsetup manpage for a more details.
248
249       dstate
250
251           Show the current state of the backing storage devices. (local/peer)
252
253       hidden-commands
254           Shows all commands undocumented on purpose.
255

VERSION

257       This document was revised for version 8.3.2 of the DRBD distribution.
258

AUTHOR

260       Written by Philipp Reisner <philipp.reisner@linbit.com> and Lars
261       Ellenberg <lars.ellenberg@linbit.com>
262

REPORTING BUGS

264       Report bugs to <drbd-user@lists.linbit.com>.
265
267       Copyright 2001-2008 LINBIT Information Technologies, Philipp Reisner,
268       Lars Ellenberg. This is free software; see the source for copying
269       conditions. There is NO warranty; not even for MERCHANTABILITY or
270       FITNESS FOR A PARTICULAR PURPOSE.
271

SEE ALSO

273       drbd.conf(5), drbd(8), drbddisk(8), drbdsetup(8), drbdmeta(8) and the
274       DRBD project web site[1]
275

NOTES

277        1. DRBD project web site
278           http://www.drbd.org/
279
280
281
282DRBD 8.3.2                        5 Dec 2008                        DRBDADM(8)
Impressum