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
74
75       -D, --debug-file=[debugfile]
76              Write debug information to given file
77
78       -V, --version
79              Display version information and exit
80
81       -h, --help
82              Display help and exit
83
84       --delay=[seconds]
85              Wait X seconds before fencing  is  started  (Default  Value:  0)
86
87
88       --login-timeout=[seconds]
89              Wait  X  seconds  for cmd prompt after login (Default Value: 10)
90
91
92       --port-as-ip
93              Make "port/plug" to be an alias to IP address
94
95       --power-timeout=[seconds]
96              Test X seconds for status change after  ON/OFF  (Default  Value:
97              20)
98
99       --power-wait=[seconds]
100              Wait X seconds after issuing ON/OFF (Default Value: 0)
101
102       --shell-timeout=[seconds]
103              Wait  X  seconds  for  cmd prompt after issuing command (Default
104              Value: 3)
105
106       --retry-on=[attempts]
107              Count of attempts to retry power on (Default Value: 1)
108
109       --ssh-path=[path]
110              Path to ssh binary (Default Value: /usr/bin/ssh)
111
112       --telnet-path=[path]
113              Path to telnet binary (Default Value: /usr/bin/telnet)
114
115

ACTIONS

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

STDIN PARAMETERS

141
142
143       action Fencing action (Default Value: reboot)
144
145       command_prompt
146              Force Python regex for command  prompt  (Default  Value:  ['>'])
147              Obsoletes: cmd_prompt
148
149       identity_file
150              Identity file (private key) for SSH
151
152       inet4_only
153              Forces agent to use IPv4 addresses only
154
155       inet6_only
156              Forces agent to use IPv6 addresses only
157
158       ip     IP address or hostname of fencing device Obsoletes: ipaddr
159
160
161       ipport TCP/UDP port to use for connection with device  (Default  Value:
162              23)
163
164       password
165              Login password or passphrase Obsoletes: passwd
166
167       password_script
168              Script  to  run  to  retrieve  password Obsoletes: passwd_script
169
170
171       plug   IP address or hostname of fencing device (together with  --port-
172              as-ip) Obsoletes: port
173
174       ssh    Use SSH connection Obsoletes: secure
175
176       ssh_options
177              SSH options to use (Default Value: -F /dev/null)
178
179       username
180              Login  name  This parameter is always required. Obsoletes: login
181
182
183       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
184              file or logging to syslog.
185
186       verbose
187              Verbose mode
188
189       debug_file
190              Write debug information to given file Obsoletes: debug
191
192       version
193              Display version information and exit
194
195       help   Display help and exit
196
197       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
198
199
200       login_timeout
201              Wait X seconds for cmd prompt after login  (Default  Value:  10)
202
203
204       port_as_ip
205              Make "port/plug" to be an alias to IP address
206
207       power_timeout
208              Test  X  seconds  for status change after ON/OFF (Default Value:
209              20)
210
211       power_wait
212              Wait X seconds after issuing ON/OFF (Default Value: 0)
213
214       shell_timeout
215              Wait X seconds for cmd prompt  after  issuing  command  (Default
216              Value: 3)
217
218       retry_on
219              Count of attempts to retry power on (Default Value: 1)
220
221       ssh_path
222              Path to ssh binary (Default Value: /usr/bin/ssh)
223
224       telnet_path
225              Path to telnet binary (Default Value: /usr/bin/telnet)
226
227
228
229fence_rsa (Fence Agent)           2009-10-20                    FENCE_AGENT(8)