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       fence_scsi accepts options on the command line as well as  from  stdin.
24       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
25       fence_scsi 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:
29

PARAMETERS

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

ACTIONS

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

STDIN PARAMETERS

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