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

NAME

7       fence_scsi - Fence agent for SCSI persistent reservation
8

DESCRIPTION

10       fence_scsi is an I/O fencing agent that uses SCSI-3 persistent reserva‐
11       tions to control access to shared storage devices. These  devices  must
12       support  SCSI-3  persistent  reservations (SPC-3 or greater) as well as
13       the "preempt-and-abort" subcommand.  The fence_scsi agent works by hav‐
14       ing  each  node  in  the  cluster  register  a unique key with the SCSI
15       device(s). 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_scsi 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       When used as a watchdog device you  can  define  e.g.  retry=1,  retry-
24       sleep=2  and  verbose=yes  parameters  in /etc/sysconfig/stonith if you
25       have issues with it failing.
26
27       fence_scsi accepts options on the command line as well as  from  stdin.
28       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
29       fence_scsi can be run by itself with command  line  options.   This  is
30       useful for testing and for turning outlets on or off from scripts.
31
32       Vendor URL:
33

PARAMETERS

35
36
37       -o, --action=[action]
38              Fencing action (Default Value: off)
39
40       -a, --aptpl
41              Use  the  APTPL flag for registrations. This option is only used
42              for the 'on' action.
43
44       -d, --devices=[devices]
45              List of devices to use for current  operation.  Devices  can  be
46              comma-separated  list of raw devices (eg. /dev/sdc). Each device
47              must support SCSI-3 persistent reservations.
48
49       -k, --key=[key]
50              Key to use for the current operation. This key should be  unique
51              to a node. For the "on" action, the key specifies the key use to
52              register the local node. For the "off" action, this  key  speci‐
53              fies the key to be removed from the device(s).
54
55       -n, --plug=[nodename]
56              Name of the node to be fenced. The node name is used to generate
57              the key value used for the current operation. This  option  will
58              be  ignored  when  used  with  the  -k option. This parameter is
59              always required.
60
61       -f, --logfile
62              Log output (stdout and stderr) to file
63
64       -q, --quiet
65              Disable logging to stderr. Does not affect --verbose or --debug-
66              file or logging to syslog.
67
68       -v, --verbose
69              Verbose mode
70
71       -D, --debug-file=[debugfile]
72              Write debug information to given file
73
74       -V, --version
75              Display version information and exit
76
77       -h, --help
78              Display help and exit
79
80       --delay=[seconds]
81              Wait  X  seconds  before  fencing  is started (Default Value: 0)
82
83
84       --login-timeout=[seconds]
85              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
86
87
88       --power-timeout=[seconds]
89              Test  X  seconds  for status change after ON/OFF (Default Value:
90              20)
91
92       --power-wait=[seconds]
93              Wait X seconds after issuing ON/OFF (Default Value: 0)
94
95       --shell-timeout=[seconds]
96              Wait X seconds for cmd prompt  after  issuing  command  (Default
97              Value: 3)
98
99       --retry-on=[attempts]
100              Count of attempts to retry power on (Default Value: 1)
101
102       --corosync-cmap-path=[path]
103              Path     to     corosync-cmapctl    binary    (Default    Value:
104              /usr/sbin/corosync-cmapctl)
105
106       --sg_persist-path=[path]
107              Path to sg_persist binary (Default  Value:  /usr/bin/sg_persist)
108
109
110       --sg_turs-path=[path]
111              Path to sg_turs binary (Default Value: /usr/bin/sg_turs)
112
113       --vgs-path=[path]
114              Path to vgs binary (Default Value: /usr/sbin/vgs)
115
116

ACTIONS

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

STDIN PARAMETERS

140
141
142       action Fencing action (Default Value: off)
143
144       aptpl  Use  the  APTPL flag for registrations. This option is only used
145              for the 'on' action.
146
147       devices
148              List of devices to use for current  operation.  Devices  can  be
149              comma-separated  list of raw devices (eg. /dev/sdc). Each device
150              must support SCSI-3 persistent reservations.
151
152       key    Key to use for the current operation. This key should be  unique
153              to a node. For the "on" action, the key specifies the key use to
154              register the local node. For the "off" action, this  key  speci‐
155              fies the key to be removed from the device(s).
156
157       plug   Name of the node to be fenced. The node name is used to generate
158              the key value used for the current operation. This  option  will
159              be  ignored  when  used  with  the  -k option. This parameter is
160              always required. Obsoletes: port
161
162       logfile
163              Log output (stdout and stderr) to file
164
165       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
166              file or logging to syslog.
167
168       verbose
169              Verbose mode
170
171       debug_file
172              Write debug information to given file Obsoletes: debug
173
174       version
175              Display version information and exit
176
177       help   Display help and exit
178
179       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
180
181
182       login_timeout
183              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
184
185
186       power_timeout
187              Test  X  seconds  for status change after ON/OFF (Default Value:
188              20)
189
190       power_wait
191              Wait X seconds after issuing ON/OFF (Default Value: 0)
192
193       shell_timeout
194              Wait X seconds for cmd prompt  after  issuing  command  (Default
195              Value: 3)
196
197       retry_on
198              Count of attempts to retry power on (Default Value: 1)
199
200       corosync_cmap_path
201              Path     to     corosync-cmapctl    binary    (Default    Value:
202              /usr/sbin/corosync-cmapctl)
203
204       sg_persist_path
205              Path to sg_persist binary (Default  Value:  /usr/bin/sg_persist)
206
207
208       sg_turs_path
209              Path to sg_turs binary (Default Value: /usr/bin/sg_turs)
210
211       vgs_path
212              Path to vgs binary (Default Value: /usr/sbin/vgs)
213
214
215
216fence_scsi (Fence Agent)          2009-10-20                    FENCE_AGENT(8)
Impressum