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

VERSION

218       This document was revised for version 8.3.2 of the DRBD distribution.
219

AUTHOR

221       Written by Philipp Reisner philipp.reisner@linbit.com and Lars
222       Ellenberg lars.ellenberg@linbit.com
223

REPORTING BUGS

225       Report bugs to drbd-user@lists.linbit.com.
226
228       Copyright 2001-2008 LINBIT Information Technologies, Philipp Reisner,
229       Lars Ellenberg. This is free software; see the source for copying
230       conditions. There is NO warranty; not even for MERCHANTABILITY or
231       FITNESS FOR A PARTICULAR PURPOSE.
232

SEE ALSO

234       drbd.conf(5), drbd(8), drbddisk(8), drbdsetup(8), drbdmeta(8) and the
235       DRBD project web site[1]
236

NOTES

238        1. DRBD project web site
239           http://www.drbd.org/
240
241
242
243DRBD 8.3.2                        5 Dec 2008                        DRBDADM(8)
Impressum