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       --delay=[seconds]
92              Wait X seconds before fencing  is  started  (Default  Value:  0)
93
94
95       --disable-timeout=[true/false]
96              Disable  timeout (true/false) (default: true when run from Pace‐
97              maker 2.0+)
98
99       --login-timeout=[seconds]
100              Wait X seconds for cmd prompt after login  (Default  Value:  10)
101
102
103       --port-as-ip
104              Make "port/plug" to be an alias to IP address
105
106       --power-timeout=[seconds]
107              Test  X  seconds  for status change after ON/OFF (Default Value:
108              20)
109
110       --power-wait=[seconds]
111              Wait X seconds after issuing ON/OFF (Default Value: 0)
112
113       --shell-timeout=[seconds]
114              Wait X seconds for cmd prompt  after  issuing  command  (Default
115              Value: 3)
116
117       --stonith-status-sleep=[seconds]
118              Sleep  X  seconds  between  status calls during a STONITH action
119              (Default Value: 1)
120
121       --retry-on=[attempts]
122              Count of attempts to retry power on (Default Value: 1)
123
124       --ssh-path=[path]
125              Path to ssh binary (Default Value: /usr/bin/ssh)
126
127       --telnet-path=[path]
128              Path to telnet binary (Default Value: /usr/bin/telnet)
129
130

ACTIONS

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

STDIN PARAMETERS

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