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

NAME

7       fence_rsa - Fence agent for IBM RSA
8

DESCRIPTION

10       fence_rsa is an I/O Fencing agent which can be used with the IBM RSA II
11       management interface. It logs into an RSA II device via telnet and  re‐
12       boots  the associated machine. Lengthy telnet connections to the RSA II
13       device should be avoided while a GFS cluster  is  running  because  the
14       connection will block any necessary fencing actions.
15
16       fence_rsa  accepts  options  on the command line as well as from stdin.
17       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
18       fence_rsa can be run by itself with command line options.  This is use‐
19       ful for testing and for turning outlets on or off from scripts.
20
21       Vendor URL: http://www.ibm.com
22

PARAMETERS

24
25
26       -o, --action=[action]
27              Fencing action (Default Value: reboot)
28
29       -c, --command-prompt=[prompt]
30              Force Python regex for command  prompt  (Default  Value:  ['>'])
31
32
33       -k, --identity-file=[filename]
34              Identity file (private key) for SSH
35
36       -4, --inet4-only
37              Forces agent to use IPv4 addresses only
38
39       -6, --inet6-only
40              Forces agent to use IPv6 addresses only
41
42       -a, --ip=[ip]
43              IP address or hostname of fencing device
44
45       -u, --ipport=[port]
46              TCP/UDP  port  to use for connection with device (Default Value:
47              23)
48
49       -p, --password=[password]
50              Login password or passphrase
51
52       -S, --password-script=[script]
53              Script to run to retrieve password
54
55       -n, --plug=[ip]
56              IP address or hostname of fencing device (together with  --port-
57              as-ip)
58
59       -x, --ssh
60              Use SSH connection
61
62       --ssh-options=[options]
63              SSH options to use (Default Value: -F /dev/null)
64
65       -l, --username=[name]
66              Login name This parameter is always required.
67
68       -q, --quiet
69              Disable logging to stderr. Does not affect --verbose or --debug-
70              file or logging to syslog.
71
72       -v, --verbose
73              Verbose mode. Multiple -v flags can be stacked  on  the  command
74              line (e.g., -vvv) to increase verbosity.
75
76       --verbose-level
77              Level  of  debugging detail in output. Defaults to the number of
78              --verbose flags specified on the command line, or to 1  if  ver‐
79              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
80
81
82       -D, --debug-file=[debugfile]
83              Write debug information to given file
84
85       -V, --version
86              Display version information and exit
87
88       -h, --help
89              Display help and exit
90
91       --plug-separator=[char]
92              Separator for plug parameter when specifying more  than  1  plug
93              (Default Value: ,)
94
95       --delay=[seconds]
96              Wait  X  seconds  before  fencing  is started (Default Value: 0)
97
98
99       --disable-timeout=[true/false]
100              Disable timeout (true/false) (default: true when run from  Pace‐
101              maker 2.0+)
102
103       --login-timeout=[seconds]
104              Wait  X  seconds  for cmd prompt after login (Default Value: 10)
105
106
107       --port-as-ip
108              Make "port/plug" to be an alias to IP address
109
110       --power-timeout=[seconds]
111              Test X seconds for status change after  ON/OFF  (Default  Value:
112              20)
113
114       --power-wait=[seconds]
115              Wait X seconds after issuing ON/OFF (Default Value: 0)
116
117       --shell-timeout=[seconds]
118              Wait  X  seconds  for  cmd prompt after issuing command (Default
119              Value: 3)
120
121       --stonith-status-sleep=[seconds]
122              Sleep X seconds between status calls  during  a  STONITH  action
123              (Default Value: 1)
124
125       --retry-on=[attempts]
126              Count of attempts to retry power on (Default Value: 1)
127
128       --ssh-path=[path]
129              Path to ssh binary (Default Value: /usr/bin/ssh)
130
131       --telnet-path=[path]
132              Path to telnet binary (Default Value: /usr/bin/telnet)
133
134

ACTIONS

136
137
138       on     Power on machine.
139
140       off    Power off machine.
141
142       reboot Reboot machine.
143
144       status This returns the status of the plug/virtual machine.
145
146       monitor
147              Check the health of fence device
148
149       metadata
150              Display the XML metadata describing this resource.
151
152       manpage
153               The operational behavior of this is not known.
154
155       validate-all
156              Validate if all required parameters are entered.
157
158

STDIN PARAMETERS

160
161
162       action Fencing action (Default Value: reboot)
163
164       command_prompt
165              Force Python regex for command prompt (Default Value: ['>']) Ob‐
166              soletes: cmd_prompt
167
168       identity_file
169              Identity file (private key) for SSH
170
171       inet4_only
172              Forces agent to use IPv4 addresses only
173
174       inet6_only
175              Forces agent to use IPv6 addresses only
176
177       ip     IP address or hostname of fencing device Obsoletes: ipaddr
178
179
180       ipport TCP/UDP  port  to use for connection with device (Default Value:
181              23)
182
183       password
184              Login password or passphrase Obsoletes: passwd
185
186       password_script
187              Script to run  to  retrieve  password  Obsoletes:  passwd_script
188
189
190       plug   IP  address or hostname of fencing device (together with --port-
191              as-ip) Obsoletes: port
192
193       ssh    Use SSH connection Obsoletes: secure
194
195       ssh_options
196              SSH options to use (Default Value: -F /dev/null)
197
198       username
199              Login name This parameter is always required.  Obsoletes:  login
200
201
202       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
203              file or logging to syslog.
204
205       verbose
206              Verbose mode. Multiple -v flags can be stacked  on  the  command
207              line (e.g., -vvv) to increase verbosity.
208
209       verbose_level
210              Level  of  debugging detail in output. Defaults to the number of
211              --verbose flags specified on the command line, or to 1  if  ver‐
212              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
213
214
215       debug_file
216              Write debug information to given file Obsoletes: debug
217
218       version
219              Display version information and exit
220
221       help   Display help and exit
222
223       plug_separator
224              Separator for plug parameter when specifying more  than  1  plug
225              (Default Value: ,)
226
227       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
228
229
230       disable_timeout
231              Disable timeout (true/false) (default: true when run from  Pace‐
232              maker 2.0+)
233
234       login_timeout
235              Wait  X  seconds  for cmd prompt after login (Default Value: 10)
236
237
238       port_as_ip
239              Make "port/plug" to be an alias to IP address
240
241       power_timeout
242              Test X seconds for status change after  ON/OFF  (Default  Value:
243              20)
244
245       power_wait
246              Wait X seconds after issuing ON/OFF (Default Value: 0)
247
248       shell_timeout
249              Wait  X  seconds  for  cmd prompt after issuing command (Default
250              Value: 3)
251
252       stonith_status_sleep
253              Sleep X seconds between status calls  during  a  STONITH  action
254              (Default Value: 1)
255
256       retry_on
257              Count of attempts to retry power on (Default Value: 1)
258
259       ssh_path
260              Path to ssh binary (Default Value: /usr/bin/ssh)
261
262       telnet_path
263              Path to telnet binary (Default Value: /usr/bin/telnet)
264
265
266
267fence_rsa (Fence Agent)           2009-10-20                    FENCE_AGENT(8)