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 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 This parameter is always required.
44
45       -u, --ipport=[port]
46              TCP/UDP  port  to use for connection with device (Default Value:
47              23)
48
49       -l, --username=[name]
50              Login Name This parameter is always required.
51
52       -p, --password=[password]
53              Login password or passphrase
54
55       -S, --password-script=[script]
56              Script to retrieve password
57
58       -x, --ssh
59              SSH connection
60
61       --ssh-options=[options]
62              SSH options to use (Default Value: -F /dev/null)
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: 10)
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       --ssh-path=[path]
99              Path to ssh binary (Default Value: /usr/bin/ssh)
100
101       --telnet-path=[path]
102              Path to telnet binary (Default Value: /usr/bin/telnet)
103
104

ACTIONS

106
107
108       on     Power on machine.
109
110       off    Power off machine.
111
112       reboot Reboot machine.
113
114       status This returns the status of the plug/virtual machine.
115
116       list   List available plugs with aliases/virtual machines if  there  is
117              support for more then one device. Returns N/A otherwise.
118
119       list-status
120              List  available  plugs  with  aliases/virtual machines and their
121              power state if it can be obtained without  additional  commands.
122
123
124       monitor
125              Check the health of fence device
126
127       metadata
128              Display the XML metadata describing this resource.
129
130

STDIN PARAMETERS

132
133
134       action Fencing Action (Default Value: reboot)
135
136       cmd_prompt
137              Force  Python  regex  for  command prompt (Default Value: ['>'])
138
139
140       identity_file
141              Identity file for ssh
142
143       inet4_only
144              Forces agent to use IPv4 addresses only
145
146       inet6_only
147              Forces agent to use IPv6 addresses only
148
149       ipaddr IP Address or Hostname This parameter is always required.
150
151       ipport TCP/UDP port to use for connection with device  (Default  Value:
152              23)
153
154       login  Login Name This parameter is always required.
155
156       passwd Login password or passphrase
157
158       passwd_script
159              Script to retrieve password
160
161       secure SSH connection
162
163       ssh_options
164              SSH options to use (Default Value: -F /dev/null)
165
166       verbose
167              Verbose mode
168
169       debug  Write debug information to given file
170
171       version
172              Display version information and exit
173
174       help   Display help and exit
175
176       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
177
178
179       login_timeout
180              Wait X seconds for cmd prompt after login  (Default  Value:  10)
181
182
183       power_timeout
184              Test  X  seconds  for status change after ON/OFF (Default Value:
185              20)
186
187       power_wait
188              Wait X seconds after issuing ON/OFF (Default Value: 0)
189
190       shell_timeout
191              Wait X seconds for cmd prompt  after  issuing  command  (Default
192              Value: 3)
193
194       retry_on
195              Count of attempts to retry power on (Default Value: 1)
196
197       ssh_path
198              Path to ssh binary (Default Value: /usr/bin/ssh)
199
200       telnet_path
201              Path to telnet binary (Default Value: /usr/bin/telnet)
202
203
204
205fence_rsa (Fence Agent)           2009-10-20                    FENCE_AGENT(8)