ccc5f54fe9df151e302aa5f55984624050877403
[multipath-tools/.git] / multipathd / multipathd.8
1 .TH MULTIPATHD 8 "November 2009" "Linux Administrator's Manual"
2 .SH NAME
3 multipathd \- multipath daemon
4
5 .SH SYNOPSIS
6 .B multipathd
7 .RB [\| options \|]
8
9 .SH DESCRIPTION
10 The 
11 .B multipathd 
12 daemon is in charge of checking for failed paths. When this happens,
13 it will reconfigure the multipath map the path belongs to, so that this map 
14 regains its maximum performance and redundancy.
15
16 This daemon executes the external multipath config tool when events occur. 
17 In turn, the multipath tool signals the multipathd daemon when it is done with 
18 devmap reconfiguration, so that it can refresh its failed path list.
19
20 .SH OPTIONS
21 .TP
22 .B \-d
23 Forground Mode. Don't daemonize, and print all messages to stdout and stderr.
24 .TP 
25 .B -v "level"
26 Verbosity level. Print additional information while running multipathd. A  level of 0 means only print errors. A level of 3 or greater prints debugging information as well. 
27 .TP
28 .B -k 
29 multipathd will enter interactive mode. From this mode, the available commands can be viewed by entering "help". When you are finished entering commands, press CTRL-D to quit.
30
31 .SH COMMANDS
32 .TP
33 The following commands can be used in interactive mode:
34 .TP
35 .B list|show paths
36 Show the paths that multipathd is monitoring, and their state. 
37 .TP
38 .B list|show paths format $format
39 Show the paths that multipathd is monitoring, using a format string with path
40 format wildcards.
41 .TP
42 .B list|show maps|multipaths
43 Show the multipath devices that the multipathd is monitoring. 
44 .TP
45 .B list|show maps|multipaths format $format
46 Show the status of all multipath devices that the multipathd is monitoring,
47 using a format string with multipath format wildcards.
48 .TP
49 .B list|show maps|multipaths status
50 Show the status of all multipath devices that the multipathd is monitoring.
51 .TP
52 .B list|show maps|multipaths stats
53 Show some statistics of all multipath devices that the multipathd is monitoring.
54 .TP
55 .B list|show maps|multipaths topology
56 Show the current multipath topology. Same as "multipath \-ll".
57 .TP
58 .B list|show topology
59 Show the current multipath topology. Same as "multipath \-ll".
60 .TP
61 .B list|show map|multipath $map topology
62 Show topology of a single multipath device specified by $map, e.g. 36005076303ffc56200000000000010aa.
63 This map could be obtained from "list maps".
64 .TP
65 .B list|show wildcards
66 Show the format wildcards used in interactive commands taking $format
67 .TP
68 .B list|show config
69 Show the currently used configuration, derived from default values and values specified within the configuration file /etc/multipath.conf.
70 .TP
71 .B list|show blacklist
72 Show the currently used blacklist rules, derived from default values and values specified within the configuration file /etc/multipath.conf.
73 .TP
74 .B list|show devices
75 Show all available block devices by name including the information if they are blacklisted or not.
76 .TP
77 .B list|show status
78 Show the number of path checkers in each possible state, the number of monitored paths, and whether multipathd is currently handling a uevent.
79 .TP
80 .B add path $path
81 Add a path to the list of monitored paths. $path is as listed in /sys/block (e.g. sda).
82 .TP 
83 .B remove|del path $path
84 Stop monitoring a path. $path is as listed in /sys/block (e.g. sda).
85 .TP
86 .B add map $map
87 Add a multipath device to the list of monitored devices. $map can either be a device-mapper device as listed in /sys/block (e.g. dm-0) or it can be the alias for the multipath device (e.g. mpath1) or the uid of the multipath device (e.g. 36005076303ffc56200000000000010aa). 
88 .TP
89 .B remove|del map $map
90 Stop monitoring a multipath device.
91 .TP
92 .B resize map|multipath $map
93 Resizes map $map to the given size
94 .TP 
95 .B switch|switchgroup map $map group $group
96 Force a multipath device to switch to a specific path group. $group is the path group index, starting with 1.
97 .TP
98 .B reconfigure
99 Reconfigures the multipaths. This should be triggered automatically after any hotplug event.
100 .TP
101 .B suspend map|multipath $map
102 Sets map $map into suspend state.
103 .TP
104 .B resume map|multipath $map
105 Resumes map $map from suspend state.
106 .TP
107 .B fail path $path
108 Sets path $path into failed state.
109 .TP
110 .B reinstate path $path
111 Resumes path $path from failed state.
112 .TP
113 .B disablequeueing maps|multipaths
114 Disable queueing on all multipath devices.
115 .TP
116 .B restorequeueing maps|multipaths
117 Restore queueing on all multipath devices.
118 .TP
119 .B disablequeueing map|multipath $map
120 Disable queuing on multipathed map $map
121 .TP
122 .B restorequeueing map|multipath $map
123 Restore queuing on multipahted map $map
124 .TP
125 .B quit|exit
126 End interactive session.
127
128 .SH "SEE ALSO"
129 .BR multipath (8)
130 .BR kpartx (8)
131 .BR hotplug (8)
132 .SH "AUTHORS"
133 .B multipathd
134 was developed by Christophe Varoqui, <christophe.varoqui@opensvc.com> and others.