.TH FENCE_AGENT 8 2009-10-20 "fence_lpar (Fence Agent)"
.SH NAME
fence_lpar - Fence agent for IBM LPAR
.SH DESCRIPTION
.P

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

.SH PARAMETERS

	
.TP
.B -o, --action=<action>
. 
Fencing Action (Default Value: reboot)
	
.TP
.B -a, --ip=<ip>
. 
IP Address or Hostname This parameter is always required.
	
.TP
.B -l, --username=<name>
. 
Login Name This parameter is always required.
	
.TP
.B -p, --password=<password>
. 
Login password or passphrase
	
.TP
.B -S, --password-script=<script>
. 
Script to retrieve password
	
.TP
.B -x, --ssh
. 
SSH connection (Default Value: 1)
	
.TP
.B -k, --identity-file=<filename>
. 
Identity file for ssh
	
.TP
.B -n <id>                        Name of the partition
. 
Partition name
	
.TP
.B -s <id>                        Name of the managed system
. 
Managed system name
	
.TP
.B -H, --hmc-version=<version>
. 
Force HMC version to use (3 or 4) (Default Value: 4)
	
.TP
.B -c, --command-prompt=<prompt>
. 
Force command prompt (Default Value: [':~>', ']\\$', '\\$ '])
	
.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 -u, --ipport=<port>
. 
TCP port to use for connection with device
	
.TP
.B -v, --verbose
. 
Verbose mode
	
.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 -C, --separator=<char>
. 
Separator for CSV created by operation list (Default Value: ,)
	
.TP
.B --power-timeout
. 
Test X seconds for status change after ON/OFF (Default Value: 20)
	
.TP
.B --shell-timeout
. 
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
	
.TP
.B --login-timeout
. 
Wait X seconds for cmd prompt after login (Default Value: 15)
	
.TP
.B --power-wait
. 
Wait X seconds after issuing ON/OFF (Default Value: 0)
	
.TP
.B --delay
. 
Wait X seconds before fencing is started (Default Value: 0)
	
.TP
.B --retry-on
. 
Count of attempts to retry power on (Default Value: 1)

.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
\fBlist \fP
List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.
	
.TP
\fBmonitor \fP
Check if fencing device is running. List available plugs/virtual machines or get status of machine (if it does not support more).
	
.TP
\fBmetadata \fP
 The operational behavior of this is not known.

.SH STDIN PARAMETERS

	
.TP
.B action
. 
Fencing Action (Default Value: reboot)
	
.TP
.B ipaddr
. 
IP Address or Hostname This parameter is always required.
	
.TP
.B login
. 
Login Name This parameter is always required.
	
.TP
.B passwd
. 
Login password or passphrase
	
.TP
.B passwd_script
. 
Script to retrieve password
	
.TP
.B secure
. 
SSH connection (Default Value: 1)
	
.TP
.B identity_file
. 
Identity file for ssh
	
.TP
.B partition
. 
Partition name
	
.TP
.B managed
. 
Managed system name
	
.TP
.B hmc_version
. 
Force HMC version to use (3 or 4) (Default Value: 4)
	
.TP
.B cmd_prompt
. 
Force command prompt (Default Value: [':~>', ']\\$', '\\$ '])
	
.TP
.B inet4_only
. 
Forces agent to use IPv4 addresses only
	
.TP
.B inet6_only
. 
Forces agent to use IPv6 addresses only
	
.TP
.B ipport
. 
TCP port to use for connection with device
	
.TP
.B verbose
. 
Verbose mode
	
.TP
.B debug
. 
Write debug information to given file
	
.TP
.B version
. 
Display version information and exit
	
.TP
.B help
. 
Display help and exit
	
.TP
.B separator
. 
Separator for CSV created by operation list (Default Value: ,)
	
.TP
.B power_timeout
. 
Test X seconds for status change after ON/OFF (Default Value: 20)
	
.TP
.B shell_timeout
. 
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
	
.TP
.B login_timeout
. 
Wait X seconds for cmd prompt after login (Default Value: 15)
	
.TP
.B power_wait
. 
Wait X seconds after issuing ON/OFF (Default Value: 0)
	
.TP
.B delay
. 
Wait X seconds before fencing is started (Default Value: 0)
	
.TP
.B retry_on
. 
Count of attempts to retry power on (Default Value: 1)