Update man page for multipath -r
[multipath-tools/.git] / multipath / multipath.8
1 .TH MULTIPATH 8 "July 2006" "" "Linux Administrator's Manual"
2 .SH NAME
3 multipath \- Device mapper target autoconfig
4 .SH SYNOPSIS
5 .B multipath
6 .RB [\| \-v\ \c
7 .IR verbosity \|]
8 .RB [\| \-d \|]
9 .RB [\| \-h | \-l | \-ll | \-f | \-t | \-F \| \-B \|]
10 .RB [\| \-p\ \c
11 .BR failover | multibus | group_by_serial | group_by_prio | group_by_node_name \|]
12 .RB [\| device \|]
13 .SH DESCRIPTION
14 .B multipath
15 is used to detect multiple paths to devices for fail-over or performance reasons and coalesces them
16 .SH OPTIONS
17 .TP
18 .B \-v " level"
19 verbosity, print all paths and multipaths
20 .RS 1.2i
21 .TP 1.2i
22 .B 0
23 no output
24 .TP
25 .B 1
26 print the created or updated multipath names only, for use to feed other tools like kpartx
27 .TP
28 .B 2 +
29 print all info : detected paths, coalesced paths (ie multipaths) and device maps
30 .RE
31 .TP
32 .B \-h
33 print usage text
34 .TP
35 .B \-d
36 dry run, do not create or update devmaps
37 .TP
38 .B \-l
39 show the current multipath topology from information fetched in sysfs and the device mapper
40 .TP
41 .B \-ll
42 show the current multipath topology from all available information (sysfs, the device mapper, path checkers ...)
43 .TP
44 .B \-f
45 flush a multipath device map specified as parameter, if unused
46 .TP
47 .B \-F
48 flush all unused multipath device maps
49 .TP
50 .B \-t
51 print internal hardware table to stdout
52 .TP
53 .B \-r
54 force devmap reload
55 .TP
56 .B \-B
57 treat the bindings file as read only
58 .TP
59 .BI \-p " policy"
60 force new maps to use the specified policy:
61 .RS 1.2i
62 .TP 1.2i
63 .B failover
64 1 path per priority group
65 .TP
66 .B multibus
67 all paths in 1 priority group
68 .TP
69 .B group_by_serial
70 1 priority group per serial
71 .TP
72 .B group_by_prio
73 1 priority group per priority value. Priorities are determined by callout programs specified as a global, per-controller or per-multipath option in the configuration file
74 .TP
75 .B group_by_node_name
76 1 priority group per target node name. Target node names are fetched
77 in /sys/class/fc_transport/target*/node_name.
78 .TP
79 .RE
80 Existing maps are not modified.
81 .TP
82 .BI device
83 update only the devmap the path pointed by
84 .I device
85 is in. 
86 .I device
87 is in the /dev/sdb (as shown by udev in the $DEVNAME variable) or major:minor format.
88 .I device
89 may alternatively be a multipath mapname
90 .SH "SEE ALSO"
91 .BR multipathd (8),
92 .BR multipath.conf (5),
93 .BR kpartx (8),
94 .BR udev (8),
95 .BR dmsetup (8)
96 .BR hotplug (8)
97 .SH AUTHORS
98 .B multipath
99 was developed by Christophe Varoqui, <christophe.varoqui@opensvc.com> and others.