libmultipath: _install_keyword cleanup
[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 | \-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 \-T
93 Display the currently used multipathd configuration, limiting the output to
94 those devices actually present in the system. This can be used a template for
95 creating \fImultipath.conf\fR.
96 .
97 .TP
98 .B \-r
99 Force devmap reload.
100 .
101 .TP
102 .B \-i
103 Ignore WWIDs file when processing devices. If
104 \fIfind_multipaths strict\fR or \fIfind_multipaths no\fR is set in
105 \fImultipath.conf\fR, multipath only considers devices that are
106 listed in the WWIDs file. This option overrides that behavior. For other values
107 of \fIfind_multipaths\fR, this option has no effect. See the description of
108 \fIfind_multipaths\fR in
109 .BR multipath.conf (5).
110 This option should only be used in rare circumstances.
111 .
112 .TP
113 .B \-B
114 Treat the bindings file as read only.
115 .
116 .TP
117 .BI \-b " bindings_file"
118 Set user_friendly_names bindings file location.  The default is
119 \fI/etc/multipath/bindings\fR.
120 .
121 .TP
122 .B \-c
123 Check if a block device should be a path in a multipath device.
124 .
125 .TP
126 .B \-C
127 Check if a multipath device has usable paths. This can be used to
128 test whether or not I/O on this device is likely to succeed. The command
129 itself doesn't attempt to do I/O on the device.
130 .
131 .TP
132 .B \-q
133 Allow device tables with \fIqueue_if_no_path\fR when multipathd is not running.
134 .
135 .TP
136 .B \-a
137 Add the WWID for the specified device to the WWIDs file.
138 .
139 .TP
140 .B \-u
141 Check if the device specified in the program environment should be
142 a path in a multipath device.
143 .
144 .TP
145 .B \-U
146 Check if the device specified in the program environment is a multipath device
147 with usable paths. See \fB-C\fB.
148 .
149 .TP
150 .B \-w
151 Remove the WWID for the specified device from the WWIDs file.
152 .
153 .TP
154 .B \-W
155 Reset the WWIDs file to only include the current multipath devices.
156 .
157 .TP
158 .BI \-p " policy"
159 Force new maps to use the specified policy:
160 .RS 1.2i
161 .TP 1.2i
162 .I failover
163 One path per priority group.
164 .TP
165 .I multibus
166 All paths in one priority group.
167 .TP
168 .I group_by_serial
169 One priority group per serial number.
170 .TP
171 .I group_by_prio
172 One priority group per priority value. Priorities are determined by
173 callout programs specified as a global, per-controller or
174 per-multipath option in the configuration file.
175 .TP
176 .I group_by_node_name
177 One priority group per target node name. Target node names are fetched
178 in \fI/sys/class/fc_transport/target*/node_name\fR.
179 .TP
180 .RE
181 Existing maps are not modified.
182 .
183 .TP
184 .BI \-R " retries"
185 Number of times to retry flushing multipath devices that are in-use. The default
186 is \fI0\fR.
187 .
188 .TP
189 .BI device
190 Update only the devmap specified by
191 .IR device ,
192 which is either:
193 .RS 1.2i
194 .IP \[bu]
195 A devmap name.
196 .IP \[bu]
197 A path associated with the desired devmap; the path may be in one of the following formats:
198 .RS 1.2i
199 .IP \[bu]
200 .B /dev/sdX
201 .IP \[bu]
202 .B major:minor
203 .
204 .
205 .\" ----------------------------------------------------------------------------
206 .SH "SEE ALSO"
207 .\" ----------------------------------------------------------------------------
208 .
209 .BR multipathd (8),
210 .BR multipath.conf (5),
211 .BR kpartx (8),
212 .BR udev (8),
213 .BR dmsetup (8),
214 .BR hotplug (8).
215 .
216 .
217 .\" ----------------------------------------------------------------------------
218 .SH AUTHORS
219 .\" ----------------------------------------------------------------------------
220 .
221 \fImultipath-tools\fR was developed by Christophe Varoqui <christophe.varoqui@opensvc.com>
222 and others.
223 .\" EOF