[multipath]
[platform/upstream/multipath-tools.git] / multipath / multipath.8
1 .TH MULTIPATH 8 "February 2004" "" "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 [\| \-l | \-ll \|]
10 .RB [\| \-i\ \c
11 .IR int \|]
12 .RB [\| \-p\ \c
13 .BR failover | multibus | group_by_serial | group_by_prio | group_by_node_name \|]
14 .RB [\| device \|]
15 .SH DESCRIPTION
16 .B multipath
17 is used to detect multiple paths to devices for fail-over or performance reasons and coalesces them
18 .SH OPTIONS
19 .TP
20 .B \-v " level"
21 verbosity, print all paths and multipaths
22 .RS 1.2i
23 .TP 1.2i
24 .B 0
25 no output
26 .TP
27 .B 1
28 print the created or updated multipath names only, for use to feed other tools like kpartx
29 .TP
30 .B 2 +
31 print all info : detected paths, coalesced paths (ie multipaths) and device maps
32 .RE
33 .TP
34 .B \-d
35 dry run, do not create or update devmaps
36 .TP
37 .B \-l
38 show the current multipath topology from information fetched in sysfs and the device mapper
39 .TP
40 .B \-ll
41 show the current multipath topology from all available information (sysfs, the device mapper, path checkers ...)
42 .TP
43 .TP
44 .BI \-i " interval"
45 multipath target param: polling interval
46 .TP
47 .BI \-D " major:minor"
48 update only the devmap the path pointed by
49 .I major:minor
50 is in
51 .TP
52 .B \-F
53 flush all unused multipath device maps
54 .TP
55 .BI \-p " policy"
56 force maps to specified policy:
57 .RS 1.2i
58 .TP 1.2i
59 .B failover
60 1 path per priority group
61 .TP
62 .B multibus
63 all paths in 1 priority group
64 .TP
65 .B group_by_serial
66 1 priority group per serial
67 .TP
68 .B group_by_prio
69 1 priority group per priority value. Priorities are determined by callout programs specified as a global, per-controler or per-multipath option in the configuration file
70 .TP
71 .B group_by_node_name
72 1 priority group per target node name. Target node names are fetched in /sys/class/fc_transport/target*/node_name.
73 .RE
74 .TP
75 .BI device
76 update only the devmap the path pointed by
77 .I device
78 is in. 
79 .I device
80 is in the /dev/sdb (as shown by udev in the $DEVNAME variable) or major:minor format.
81 .I device
82 may alternatively be a multipath mapname
83 .SH "SEE ALSO"
84 .BR udev (8),
85 .BR dmsetup (8)
86 .BR hotplug (8)
87 .SH AUTHORS
88 .B multipath
89 was developed by Christophe Varoqui, <christophe.varoqui@free.fr> and others.