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              Key  to use for the current operation. This key should be unique
45              to a node and have to be written in /etc/multipath.conf. For the
46              "on" action, the key specifies the key use to register the local
47              node. For the "off" action, this key specifies  the  key  to  be
48              removed  from  the device(s). This parameter is always required.
49
50
51       -q, --quiet
52              Disable logging to stderr. Does not affect --verbose or --debug-
53              file or logging to syslog.
54
55       -v, --verbose
56              Verbose mode
57
58       -D, --debug-file=[debugfile]
59              Write debug information to given file
60
61       -V, --version
62              Display version information and exit
63
64       -h, --help
65              Display help and exit
66
67       --delay=[seconds]
68              Wait  X  seconds  before  fencing  is started (Default Value: 0)
69
70
71       --login-timeout=[seconds]
72              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
73
74
75       --mpathpersist-path=[path]
76              Path  to mpathpersist binary (Default Value: /usr/sbin/mpathper‐
77              sist)
78
79       --power-timeout=[seconds]
80              Test X seconds for status change after  ON/OFF  (Default  Value:
81              20)
82
83       --power-wait=[seconds]
84              Wait X seconds after issuing ON/OFF (Default Value: 0)
85
86       --shell-timeout=[seconds]
87              Wait  X  seconds  for  cmd prompt after issuing command (Default
88              Value: 3)
89
90       --store-path=[path]
91              Path to  directory  where  fence  agent  can  store  information
92              (Default Value: /var/run/cluster)
93
94       --retry-on=[attempts]
95              Count  of  attempts  to  retry power on (Default Value: 1)
96
97
98       --use-sudo
99              Use sudo (without password)  when  calling  3rd  party  software
100
101
102       --sudo-path=[path]
103              Path to sudo binary (Default Value: /usr/bin/sudo)
104
105

ACTIONS

107
108
109       on     Power on machine.
110
111       off    Power off machine.
112
113       status This returns the status of the plug/virtual machine.
114
115       monitor
116              Check the health of fence device
117
118       metadata
119              Display the XML metadata describing this resource.
120
121       manpage
122               The operational behavior of this is not known.
123
124       validate-all
125              Validate if all required parameters are entered.
126
127

STDIN PARAMETERS

129
130
131       action Fencing action (Default Value: off)
132
133       devices
134              List  of  devices  to  use for current operation. Devices can be
135              comma-separated list of  device-mapper  multipath  devices  (eg.
136              /dev/mapper/3600508b400105df70000e00000ac0000    or    /dev/map‐
137              per/mpath1). Each device must support SCSI-3 persistent reserva‐
138              tions.
139
140       key    Key  to use for the current operation. This key should be unique
141              to a node and have to be written in /etc/multipath.conf. For the
142              "on" action, the key specifies the key use to register the local
143              node. For the "off" action, this key specifies  the  key  to  be
144              removed  from  the device(s). This parameter is always required.
145
146
147       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
148              file or logging to syslog.
149
150       verbose
151              Verbose mode
152
153       debug_file
154              Write debug information to given file Obsoletes: debug
155
156       version
157              Display version information and exit
158
159       help   Display help and exit
160
161       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
162
163
164       login_timeout
165              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
166
167
168       mpathpersist_path
169              Path  to mpathpersist binary (Default Value: /usr/sbin/mpathper‐
170              sist)
171
172       power_timeout
173              Test X seconds for status change after  ON/OFF  (Default  Value:
174              20)
175
176       power_wait
177              Wait X seconds after issuing ON/OFF (Default Value: 0)
178
179       shell_timeout
180              Wait  X  seconds  for  cmd prompt after issuing command (Default
181              Value: 3)
182
183       store_path
184              Path to  directory  where  fence  agent  can  store  information
185              (Default Value: /var/run/cluster)
186
187       retry_on
188              Count  of  attempts  to  retry power on (Default Value: 1)
189
190
191       use_sudo
192              Use sudo (without password)  when  calling  3rd  party  software
193              Obsoletes: sudo
194
195       sudo_path
196              Path to sudo binary (Default Value: /usr/bin/sudo)
197
198
199
200fence_mpath (Fence Agent)         2009-10-20                    FENCE_AGENT(8)
Impressum