7ba7126186e999a5e9519ab94dcc4e5cd8cee744
[platform/upstream/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 | \-F \|]
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 .BI \-p " policy"
51 force maps to specified policy:
52 .RS 1.2i
53 .TP 1.2i
54 .B failover
55 1 path per priority group
56 .TP
57 .B multibus
58 all paths in 1 priority group
59 .TP
60 .B group_by_serial
61 1 priority group per serial
62 .TP
63 .B group_by_prio
64 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
65 .TP
66 .B group_by_node_name
67 1 priority group per target node name. Target node names are fetched in /sys/class/fc_transport/target*/node_name.
68 .RE
69 .TP
70 .BI device
71 update only the devmap the path pointed by
72 .I device
73 is in. 
74 .I device
75 is in the /dev/sdb (as shown by udev in the $DEVNAME variable) or major:minor format.
76 .I device
77 may alternatively be a multipath mapname
78 .SH "SEE ALSO"
79 .BR udev (8),
80 .BR dmsetup (8)
81 .BR hotplug (8)
82 .SH AUTHORS
83 .B multipath
84 was developed by Christophe Varoqui, <christophe.varoqui@opensvc.com> and others.