afaa6c4df5ffca0392cdf2cf36f70770d1c68979
[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 [\| \-b\ \c
9 .IR bindings_file \|]
10 .RB [\| \-d \|]
11 .RB [\| \-h | \-l | \-ll | \-f | \-t | \-F | \-B | \-c | \-q | \|-r \|]
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 and coalesce multiple paths to devices, for fail-over or performance reasons.
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 \-h
35 print usage text
36 .TP
37 .B \-d
38 dry run, do not create or update devmaps
39 .TP
40 .B \-l
41 show the current multipath topology from information fetched in sysfs and the device mapper
42 .TP
43 .B \-ll
44 show the current multipath topology from all available information (sysfs, the device mapper, path checkers ...)
45 .TP
46 .B \-f
47 flush a multipath device map specified as parameter, if unused
48 .TP
49 .B \-F
50 flush all unused multipath device maps
51 .TP
52 .B \-t
53 print internal hardware table to stdout
54 .TP
55 .B \-r
56 force devmap reload
57 .TP
58 .B \-B
59 treat the bindings file as read only
60 .TP
61 .B \-b " bindings_file"
62 set user_friendly_names bindings file location.  The default is
63 /etc/multipath/bindings
64 .TP
65 .B \-c
66 check if a block device should be a path in a multipath device
67 .TP
68 .B \-q
69 allow device tables with queue_if_no_path when multipathd is not running
70 .TP
71 .BI \-p " policy"
72 force new maps to use the specified policy:
73 .RS 1.2i
74 .TP 1.2i
75 .B failover
76 1 path per priority group
77 .TP
78 .B multibus
79 all paths in 1 priority group
80 .TP
81 .B group_by_serial
82 1 priority group per serial
83 .TP
84 .B group_by_prio
85 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
86 .TP
87 .B group_by_node_name
88 1 priority group per target node name. Target node names are fetched
89 in /sys/class/fc_transport/target*/node_name.
90 .TP
91 .RE
92 Existing maps are not modified.
93 .TP
94 .BI device
95 update only the devmap specified by
96 .IR device ,
97 which is either:
98 .RS 1.2i
99 .IP \[bu]
100 a devmap name
101 .IP \[bu]
102 a path associated with the desired devmap; the path may be in one of the following formats:
103 .RS 1.2i
104 .IP \[bu]
105 .B /dev/sdb
106 .IP \[bu]
107 .B major:minor
108 .SH "SEE ALSO"
109 .BR multipathd (8),
110 .BR multipath.conf (5),
111 .BR kpartx (8),
112 .BR udev (8),
113 .BR dmsetup (8)
114 .BR hotplug (8)
115 .SH AUTHORS
116 .B multipath
117 was developed by Christophe Varoqui, <christophe.varoqui@opensvc.com> and others.