Update manpages
[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 \-B
54 treat the bindings file as read only
55 .TP
56 .BI \-p " policy"
57 force new maps to use the specified policy:
58 .RS 1.2i
59 .TP 1.2i
60 .B failover
61 1 path per priority group
62 .TP
63 .B multibus
64 all paths in 1 priority group
65 .TP
66 .B group_by_serial
67 1 priority group per serial
68 .TP
69 .B group_by_prio
70 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
71 .TP
72 .B group_by_node_name
73 1 priority group per target node name. Target node names are fetched
74 in /sys/class/fc_transport/target*/node_name.
75 .TP
76 .RE
77 Existing maps are not modified.
78 .TP
79 .BI device
80 update only the devmap the path pointed by
81 .I device
82 is in. 
83 .I device
84 is in the /dev/sdb (as shown by udev in the $DEVNAME variable) or major:minor format.
85 .I device
86 may alternatively be a multipath mapname
87 .SH "SEE ALSO"
88 .BR multipathd (8),
89 .BR multipath.conf (5),
90 .BR kpartx (8),
91 .BR udev (8),
92 .BR dmsetup (8)
93 .BR hotplug (8)
94 .SH AUTHORS
95 .B multipath
96 was developed by Christophe Varoqui, <christophe.varoqui@opensvc.com> and others.