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
12       reboots  the  associated machine. Lengthy telnet connections to the RSA
13       II 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       --retry-on=[attempts]
118              Count of attempts to retry power on (Default Value: 1)
119
120       --ssh-path=[path]
121              Path to ssh binary (Default Value: /usr/bin/ssh)
122
123       --telnet-path=[path]
124              Path to telnet binary (Default Value: /usr/bin/telnet)
125
126

ACTIONS

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

STDIN PARAMETERS

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