.TH FENCE_AGENT 8 2009-10-20 "fence_ilo5_ssh (Fence Agent)"
.SH NAME
fence_ilo5_ssh - Fence agent for HP iLO over SSH
.P
fence_ilo3_ssh - Fence agent for HP iLO3 over SSH (symlink)

.P
fence_ilo4_ssh - Fence agent for HP iLO4 over SSH (symlink)

.P
fence_ilo5_ssh - Fence agent for HP iLO5 over SSH (symlink)

.SH DESCRIPTION
.P
fence_ilo_ssh is a fence agent that connects to iLO device. It logs into device via ssh and reboot a specified outlet.
.P
WARNING: The monitor-action is prone to timeouts. Use the fence_ilo-equivalent to avoid this issue.
.P
fence_ilo5_ssh accepts options on the command line as well
as from stdin. Fenced sends parameters through stdin when it execs the
agent. fence_ilo5_ssh 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.hp.com
.SH PARAMETERS

	
.TP
.B -o, --action=[action]
. 
Fencing action (Default Value: reboot)
	
	
.TP
.B -c, --command-prompt=[prompt]
. 
Force Python regex for command prompt (Default Value: ['MP>', 'hpiLO->'])
	
.TP
.B -k, --identity-file=[filename]
. 
Identity file (private key) for SSH
	
.TP
.B -4, --inet4-only
. 
Forces agent to use IPv4 addresses only
	
.TP
.B -6, --inet6-only
. 
Forces agent to use IPv6 addresses only
	
.TP
.B -a, --ip=[ip]
. 
IP address or hostname of fencing device
	
	
.TP
.B -u, --ipport=[port]
. 
TCP/UDP port to use for connection with device (Default Value: 23)
	
	
.TP
.B -m, --method=[method]
. 
Method to fence (onoff|cycle) (Default Value: onoff)
	
	
	
.TP
.B -p, --password=[password]
. 
Login password or passphrase
	
.TP
.B -S, --password-script=[script]
. 
Script to run to retrieve password
	
.TP
.B -n, --plug=[ip]
. 
IP address or hostname of fencing device (together with --port-as-ip)
	
	
	
.TP
.B -x, --ssh
. 
Use SSH connection
	
.TP
.B --ssh-options=[options]
. 
SSH options to use
	
.TP
.B -l, --username=[name]
. 
Login name This parameter is always required.
	
.TP
.B -q, --quiet
. 
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
	
.TP
.B -v, --verbose
. 
Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.
	
.TP
.B --verbose-level
. 
Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).
	
	
.TP
.B -D, --debug-file=[debugfile]
. 
Write debug information to given file
	
.TP
.B -V, --version
. 
Display version information and exit
	
.TP
.B -h, --help
. 
Display help and exit
	
.TP
.B --plug-separator=[char]
. 
Separator for plug parameter when specifying more than 1 plug (Default Value: ,)
	
.TP
.B --delay=[seconds]
. 
Wait X seconds before fencing is started (Default Value: 0)
	
.TP
.B --disable-timeout=[true/false]
. 
Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)
	
.TP
.B --login-timeout=[seconds]
. 
Wait X seconds for cmd prompt after login (Default Value: 5)
	
.TP
.B --port-as-ip
. 
Make "port/plug" to be an alias to IP address
	
.TP
.B --power-timeout=[seconds]
. 
Test X seconds for status change after ON/OFF (Default Value: 20)
	
.TP
.B --power-wait=[seconds]
. 
Wait X seconds after issuing ON/OFF (Default Value: 5)
	
.TP
.B --shell-timeout=[seconds]
. 
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
	
.TP
.B --stonith-status-sleep=[seconds]
. 
Sleep X seconds between status calls during a STONITH action (Default Value: 1)
	
.TP
.B --retry-on=[attempts]
. 
Count of attempts to retry power on (Default Value: 1)
	
.TP
.B --ssh-path=[path]
. 
Path to ssh binary (Default Value: /usr/bin/ssh)
	
.TP
.B --telnet-path=[path]
. 
Path to telnet binary (Default Value: /usr/bin/telnet)

.SH ACTIONS

	
.TP
\fBon \fP
Power on machine.
	
.TP
\fBoff \fP
Power off machine.
	
.TP
\fBreboot \fP
Reboot machine.
	
.TP
\fBstatus \fP
This returns the status of the plug/virtual machine.
	
.TP
\fBmonitor \fP
Check the health of fence device
	
.TP
\fBmetadata \fP
Display the XML metadata describing this resource.
	
.TP
\fBmanpage \fP
 The operational behavior of this is not known.
	
.TP
\fBvalidate-all \fP
Validate if all required parameters are entered.

.SH STDIN PARAMETERS

	
.TP
.B action
. 
Fencing action (Default Value: reboot)
	
	
.TP
.B command_prompt
. 
Force Python regex for command prompt (Default Value: ['MP>', 'hpiLO->']) Obsoletes: cmd_prompt
	
.TP
.B identity_file
. 
Identity file (private key) for SSH
	
.TP
.B inet4_only
. 
Forces agent to use IPv4 addresses only
	
.TP
.B inet6_only
. 
Forces agent to use IPv6 addresses only
	
.TP
.B ip
. 
IP address or hostname of fencing device Obsoletes: ipaddr
	
	
.TP
.B ipport
. 
TCP/UDP port to use for connection with device (Default Value: 23)
	
	
.TP
.B method
. 
Method to fence (onoff|cycle) (Default Value: onoff)
	
	
	
.TP
.B password
. 
Login password or passphrase Obsoletes: passwd
	
.TP
.B password_script
. 
Script to run to retrieve password Obsoletes: passwd_script
	
.TP
.B plug
. 
IP address or hostname of fencing device (together with --port-as-ip) Obsoletes: port
	
	
	
.TP
.B ssh
. 
Use SSH connection Obsoletes: secure
	
.TP
.B ssh_options
. 
SSH options to use
	
.TP
.B username
. 
Login name This parameter is always required. Obsoletes: login
	
.TP
.B quiet
. 
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
	
.TP
.B verbose
. 
Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.
	
.TP
.B verbose_level
. 
Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).
	
	
.TP
.B debug_file
. 
Write debug information to given file Obsoletes: debug
	
.TP
.B version
. 
Display version information and exit
	
.TP
.B help
. 
Display help and exit
	
.TP
.B plug_separator
. 
Separator for plug parameter when specifying more than 1 plug (Default Value: ,)
	
.TP
.B delay
. 
Wait X seconds before fencing is started (Default Value: 0)
	
.TP
.B disable_timeout
. 
Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)
	
.TP
.B login_timeout
. 
Wait X seconds for cmd prompt after login (Default Value: 5)
	
.TP
.B port_as_ip
. 
Make "port/plug" to be an alias to IP address
	
.TP
.B power_timeout
. 
Test X seconds for status change after ON/OFF (Default Value: 20)
	
.TP
.B power_wait
. 
Wait X seconds after issuing ON/OFF (Default Value: 5)
	
.TP
.B shell_timeout
. 
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
	
.TP
.B stonith_status_sleep
. 
Sleep X seconds between status calls during a STONITH action (Default Value: 1)
	
.TP
.B retry_on
. 
Count of attempts to retry power on (Default Value: 1)
	
.TP
.B ssh_path
. 
Path to ssh binary (Default Value: /usr/bin/ssh)
	
.TP
.B telnet_path
. 
Path to telnet binary (Default Value: /usr/bin/telnet)