multipathd.service: drop Before=lvm2-lvmetad.service
[multipath-tools/.git] / multipath / multipath.8
1 .\" ----------------------------------------------------------------------------
2 .\" Update the date below if you make any significant change.
3 .\" Make sure there are no errors with:
4 .\" groff -z -wall -b -e -t multipath/multipath.8
5 .\"
6 .\" ----------------------------------------------------------------------------
7 .
8 .TH MULTIPATH 8 2016-10-26 "Linux"
9 .
10 .
11 .\" ----------------------------------------------------------------------------
12 .SH NAME
13 .\" ----------------------------------------------------------------------------
14 .
15 multipath \- Device mapper target autoconfig.
16 .
17 .
18 .\" ----------------------------------------------------------------------------
19 .SH SYNOPSIS
20 .\" ----------------------------------------------------------------------------
21 .
22 .B multipath
23 .RB [\| \-v\ \c
24 .IR verbosity \|]
25 .RB [\| \-b\ \c
26 .IR bindings_file \|]
27 .RB [\| \-d \|]
28 .RB [\| \-h | \-l | \-ll | \-f | \-t | \-F | \-B | \-c | \-C | \-q | \-r | \-i | \-a | \-u | \-U | \-w | \-W \|]
29 .RB [\| \-p\ \c
30 .IR failover | multibus | group_by_serial | group_by_prio | group_by_node_name \|]
31 .RB [\| \-R\ \c
32 .IR retries \|]
33 .RB [\| device \|]
34 .
35 .
36 .\" ----------------------------------------------------------------------------
37 .SH DESCRIPTION
38 .\" ----------------------------------------------------------------------------
39 .
40 .B multipath
41 is used to detect and coalesce multiple paths to devices, for fail-over or performance reasons.
42 .
43 .
44 .\" ----------------------------------------------------------------------------
45 .SH OPTIONS
46 .\" ----------------------------------------------------------------------------
47 .
48 .TP
49 .BI \-v " level"
50 Verbosity, print all paths and multipaths:
51 .RS 1.2i
52 .TP 1.2i
53 .I 0
54 No output.
55 .TP
56 .I 1
57 Print the created or updated multipath names only, for use to feed other tools like kpartx.
58 .TP
59 .I 2 +
60 Print all info: detected paths, coalesced paths (ie multipaths) and device maps.
61 .RE
62 .
63 .TP
64 .B \-h
65 Print usage text.
66 .
67 .TP
68 .B \-d
69 Dry run, do not create or update devmaps.
70 .
71 .TP
72 .B \-l
73 Show the current multipath topology from information fetched in sysfs and the device mapper.
74 .
75 .TP
76 .B \-ll
77 Show the current multipath topology from all available information (sysfs, the device mapper, path checkers ...).
78 .
79 .TP
80 .B \-f
81 Flush a multipath device map specified as parameter, if unused.
82 .
83 .TP
84 .B \-F
85 Flush all unused multipath device maps.
86 .
87 .TP
88 .B \-t
89 Display the currently used multipathd configuration.
90 .
91 .TP
92 .B \-r
93 Force devmap reload.
94 .
95 .TP
96 .B \-i
97 Ignore WWIDs file when processing devices.
98 .
99 .TP
100 .B \-B
101 Treat the bindings file as read only.
102 .
103 .TP
104 .BI \-b " bindings_file"
105 Set user_friendly_names bindings file location.  The default is
106 \fI/etc/multipath/bindings\fR.
107 .
108 .TP
109 .B \-c
110 Check if a block device should be a path in a multipath device.
111 .
112 .TP
113 .B \-C
114 Check if a multipath device has usable paths. This can be used to
115 test whether or not I/O on this device is likely to succeed. The command
116 itself doesn't attempt to do I/O on the device.
117 .
118 .TP
119 .B \-q
120 Allow device tables with \fIqueue_if_no_path\fR when multipathd is not running.
121 .
122 .TP
123 .B \-a
124 Add the WWID for the specified device to the WWIDs file.
125 .
126 .TP
127 .B \-u
128 Check if the device specified in the program environment should be
129 a path in a multipath device.
130 .
131 .TP
132 .B \-U
133 Check if the device specified in the program environment is a multipath device
134 with usable paths. See \fB-C\fB.
135 .
136 .TP
137 .B \-w
138 Remove the WWID for the specified device from the WWIDs file.
139 .
140 .TP
141 .B \-W
142 Reset the WWIDs file to only include the current multipath devices.
143 .
144 .TP
145 .BI \-p " policy"
146 Force new maps to use the specified policy:
147 .RS 1.2i
148 .TP 1.2i
149 .I failover
150 One path per priority group.
151 .TP
152 .I multibus
153 All paths in one priority group.
154 .TP
155 .I group_by_serial
156 One priority group per serial number.
157 .TP
158 .I group_by_prio
159 One priority group per priority value. Priorities are determined by
160 callout programs specified as a global, per-controller or
161 per-multipath option in the configuration file.
162 .TP
163 .I group_by_node_name
164 One priority group per target node name. Target node names are fetched
165 in \fI/sys/class/fc_transport/target*/node_name\fR.
166 .TP
167 .RE
168 Existing maps are not modified.
169 .
170 .TP
171 .BI \-R " retries"
172 Number of times to retry flushing multipath devices that are in-use. The default
173 is \fI0\fR.
174 .
175 .TP
176 .BI device
177 Update only the devmap specified by
178 .IR device ,
179 which is either:
180 .RS 1.2i
181 .IP \[bu]
182 A devmap name.
183 .IP \[bu]
184 A path associated with the desired devmap; the path may be in one of the following formats:
185 .RS 1.2i
186 .IP \[bu]
187 .B /dev/sdX
188 .IP \[bu]
189 .B major:minor
190 .
191 .
192 .\" ----------------------------------------------------------------------------
193 .SH "SEE ALSO"
194 .\" ----------------------------------------------------------------------------
195 .
196 .BR multipathd (8),
197 .BR multipath.conf (5),
198 .BR kpartx (8),
199 .BR udev (8),
200 .BR dmsetup (8),
201 .BR hotplug (8).
202 .
203 .
204 .\" ----------------------------------------------------------------------------
205 .SH AUTHORS
206 .\" ----------------------------------------------------------------------------
207 .
208 \fImultipath-tools\fR was developed by Christophe Varoqui <christophe.varoqui@opensvc.com>
209 and others.
210 .\" EOF