fence_rsa man page

fence_rsa — Fence agent for IBM RSA

Description

fence_rsa is an I/O Fencing agent which can be used with the IBM RSA II management interface. It logs into an RSA II device via telnet and reboots the associated machine. Lengthy telnet connections to the RSA II device should be avoided while a GFS cluster is running because the connection will block any necessary fencing actions.

fence_rsa accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_rsa can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL: http://www.ibm.com

Parameters

-o, --action=[action]
Fencing action (Default Value: reboot)
-c, --command-prompt=[prompt]
Force Python regex for command prompt (Default Value: ['>'])
-k, --identity-file=[filename]
Identity file (private key) for SSH
-4, --inet4-only
Forces agent to use IPv4 addresses only
-6, --inet6-only
Forces agent to use IPv6 addresses only
-a, --ip=[ip]
IP address or hostname of fencing device
-u, --ipport=[port]
TCP/UDP port to use for connection with device (Default Value: 23)
-l, --username=[name]
Login name This parameter is always required.
-p, --password=[password]
Login password or passphrase
-S, --password-script=[script]
Script to run to retrieve password
-n, --plug=[ip]
IP address or hostname of fencing device (together with --port-as-ip)
-x, --ssh
Use SSH connection
--ssh-options=[options]
SSH options to use (Default Value: -F /dev/null)
-v, --verbose
Verbose mode
-D, --debug-file=[debugfile]
Write debug information to given file
-V, --version
Display version information and exit
-h, --help
Display help and exit
--delay=[seconds]
Wait X seconds before fencing is started (Default Value: 0)
--login-timeout=[seconds]
Wait X seconds for cmd prompt after login (Default Value: 10)
--port-as-ip
Make "port/plug" to be an alias to IP address
--power-timeout=[seconds]
Test X seconds for status change after ON/OFF (Default Value: 20)
--power-wait=[seconds]
Wait X seconds after issuing ON/OFF (Default Value: 0)
--shell-timeout=[seconds]
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
--retry-on=[attempts]
Count of attempts to retry power on (Default Value: 1)
--ssh-path=[path]
Path to ssh binary (Default Value: /usr/bin/ssh)
--telnet-path=[path]
Path to telnet binary (Default Value: /usr/bin/telnet)

Actions

on
Power on machine.
off
Power off machine.
reboot
Reboot machine.
status
This returns the status of the plug/virtual machine.
monitor
Check the health of fence device
metadata
Display the XML metadata describing this resource.
validate-all
Validate if all required parameters are entered.

Stdin Parameters

action
Fencing action (Default Value: reboot)
cmd_prompt
Force Python regex for command prompt (Default Value: ['>'])
identity_file
Identity file (private key) for SSH
inet4_only
Forces agent to use IPv4 addresses only
inet6_only
Forces agent to use IPv6 addresses only
ipaddr
IP address or hostname of fencing device
ipport
TCP/UDP port to use for connection with device (Default Value: 23)
login
Login name This parameter is always required.
passwd
Login password or passphrase
passwd_script
Script to run to retrieve password
port
IP address or hostname of fencing device (together with --port-as-ip)
secure
Use SSH connection
ssh_options
SSH options to use (Default Value: -F /dev/null)
verbose
Verbose mode
debug
Write debug information to given file
version
Display version information and exit
help
Display help and exit
delay
Wait X seconds before fencing is started (Default Value: 0)
login_timeout
Wait X seconds for cmd prompt after login (Default Value: 10)
port_as_ip
Make "port/plug" to be an alias to IP address
power_timeout
Test X seconds for status change after ON/OFF (Default Value: 20)
power_wait
Wait X seconds after issuing ON/OFF (Default Value: 0)
shell_timeout
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
retry_on
Count of attempts to retry power on (Default Value: 1)
ssh_path
Path to ssh binary (Default Value: /usr/bin/ssh)
telnet_path
Path to telnet binary (Default Value: /usr/bin/telnet)

Info

2009-10-20 fence_rsa (Fence Agent)