1
2FENCE_AGENT(8)              System Manager's Manual             FENCE_AGENT(8)
3
4
5

NAME

7       fence_mpath - Fence agent for multipath persistent reservation
8

DESCRIPTION

10       fence_mpath  is an I/O fencing agent that uses SCSI-3 persistent reser‐
11       vations to control access multipath devices.  Underlying  devices  must
12       support  SCSI-3  persistent  reservations (SPC-3 or greater) as well as
13       the "preempt-and-abort" subcommand.  The  fence_mpath  agent  works  by
14       having  a  unique  key  for each node that has to be set in /etc/multi‐
15       path.conf. Once registered, a single node will become  the  reservation
16       holder by creating a "write exclusive, registrants only" reservation on
17       the device(s). The result is that only registered nodes  may  write  to
18       the  device(s).  When a node failure occurs, the fence_mpath agent will
19       remove the key belonging to the failed node  from  the  device(s).  The
20       failed  node will no longer be able to write to the device(s). A manual
21       reboot is required.
22
23       fence_mpath accepts options on the command line as well as from  stdin.
24       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
25       fence_mpath can be run by itself with command line  options.   This  is
26       useful for testing and for turning outlets on or off from scripts.
27
28       Vendor URL: https://www.sourceware.org/dm/
29

PARAMETERS

31
32
33       -o, --action=[action]
34              Fencing action (Default Value: off)
35
36       -d, --devices=[devices]
37              List  of  devices  to  use for current operation. Devices can be
38              comma-separated list of  device-mapper  multipath  devices  (eg.
39              /dev/mapper/3600508b400105df70000e00000ac0000    or    /dev/map‐
40              per/mpath1). Each device must support SCSI-3 persistent reserva‐
41              tions.
42
43       -k, --key=[key]
44              Replaced by port/-n/--plug
45
46       -n, --plug=[key]
47              Key  to use for the current operation. This key should be unique
48              to a node and have to be written in /etc/multipath.conf. For the
49              "on" action, the key specifies the key use to register the local
50              node. For the "off" action, this key specifies  the  key  to  be
51              removed from the device(s).
52
53       -q, --quiet
54              Disable logging to stderr. Does not affect --verbose or --debug-
55              file or logging to syslog.
56
57       -v, --verbose
58              Verbose mode. Multiple -v flags can be stacked  on  the  command
59              line (e.g., -vvv) to increase verbosity.
60
61       --verbose-level
62              Level  of  debugging detail in output. Defaults to the number of
63              --verbose flags specified on the command line, or to 1  if  ver‐
64              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
65
66
67       -D, --debug-file=[debugfile]
68              Write debug information to given file
69
70       -V, --version
71              Display version information and exit
72
73       -h, --help
74              Display help and exit
75
76       --delay=[seconds]
77              Wait X seconds before fencing  is  started  (Default  Value:  0)
78
79
80       --disable-timeout=[true/false]
81              Disable  timeout (true/false) (default: true when run from Pace‐
82              maker 2.0+)
83
84       --login-timeout=[seconds]
85              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
86
87
88       --mpathpersist-path=[path]
89              Path  to mpathpersist binary (Default Value: /usr/sbin/mpathper‐
90              sist)
91
92       --power-timeout=[seconds]
93              Test X seconds for status change after  ON/OFF  (Default  Value:
94              20)
95
96       --power-wait=[seconds]
97              Wait X seconds after issuing ON/OFF (Default Value: 0)
98
99       --shell-timeout=[seconds]
100              Wait  X  seconds  for  cmd prompt after issuing command (Default
101              Value: 3)
102
103       --store-path=[path]
104              Path to  directory  where  fence  agent  can  store  information
105              (Default Value: /var/run/cluster)
106
107       --retry-on=[attempts]
108              Count  of  attempts  to  retry power on (Default Value: 1)
109
110
111       --use-sudo
112              Use sudo (without password)  when  calling  3rd  party  software
113
114
115       --sudo-path=[path]
116              Path to sudo binary (Default Value: /usr/bin/sudo)
117
118

ACTIONS

120
121
122       on     Power on machine.
123
124       off    Power off machine.
125
126       status This returns the status of the plug/virtual machine.
127
128       monitor
129              Check the health of fence device
130
131       metadata
132              Display the XML metadata describing this resource.
133
134       manpage
135               The operational behavior of this is not known.
136
137       validate-all
138              Validate if all required parameters are entered.
139
140

STDIN PARAMETERS

142
143
144       action Fencing action (Default Value: off)
145
146       devices
147              List  of  devices  to  use for current operation. Devices can be
148              comma-separated list of  device-mapper  multipath  devices  (eg.
149              /dev/mapper/3600508b400105df70000e00000ac0000    or    /dev/map‐
150              per/mpath1). Each device must support SCSI-3 persistent reserva‐
151              tions.
152
153       key    Replaced by port/-n/--plug
154
155       plug   Key  to use for the current operation. This key should be unique
156              to a node and have to be written in /etc/multipath.conf. For the
157              "on" action, the key specifies the key use to register the local
158              node. For the "off" action, this key specifies  the  key  to  be
159              removed from the device(s). Obsoletes: port
160
161       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
162              file or logging to syslog.
163
164       verbose
165              Verbose mode. Multiple -v flags can be stacked  on  the  command
166              line (e.g., -vvv) to increase verbosity.
167
168       verbose_level
169              Level  of  debugging detail in output. Defaults to the number of
170              --verbose flags specified on the command line, or to 1  if  ver‐
171              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
172
173
174       debug_file
175              Write debug information to given file Obsoletes: debug
176
177       version
178              Display version information and exit
179
180       help   Display help and exit
181
182       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
183
184
185       disable_timeout
186              Disable  timeout (true/false) (default: true when run from Pace‐
187              maker 2.0+)
188
189       login_timeout
190              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
191
192
193       mpathpersist_path
194              Path  to mpathpersist binary (Default Value: /usr/sbin/mpathper‐
195              sist)
196
197       power_timeout
198              Test X seconds for status change after  ON/OFF  (Default  Value:
199              20)
200
201       power_wait
202              Wait X seconds after issuing ON/OFF (Default Value: 0)
203
204       shell_timeout
205              Wait  X  seconds  for  cmd prompt after issuing command (Default
206              Value: 3)
207
208       store_path
209              Path to  directory  where  fence  agent  can  store  information
210              (Default Value: /var/run/cluster)
211
212       retry_on
213              Count  of  attempts  to  retry power on (Default Value: 1)
214
215
216       use_sudo
217              Use sudo (without password)  when  calling  3rd  party  software
218              Obsoletes: sudo
219
220       sudo_path
221              Path to sudo binary (Default Value: /usr/bin/sudo)
222
223
224
225fence_mpath (Fence Agent)         2009-10-20                    FENCE_AGENT(8)
Impressum