.TH FENCE_AGENT 8 2009-10-20 "fence_heuristics_ping (Fence Agent)"
.SH NAME
fence_heuristics_ping - Fence agent for ping-heuristic based fencing
.SH DESCRIPTION
.P
fence_heuristics_ping uses ping-heuristics to control execution of another fence agent on the same fencing level.
.P
This is not a fence agent by itself! Its only purpose is to enable/disable another fence agent that lives on the same fencing level but after fence_heuristics_ping.
.P
fence_heuristics_ping accepts options on the command line as well
as from stdin. Fenced sends parameters through stdin when it execs the
agent. fence_heuristics_ping 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: 
.SH PARAMETERS

	
.TP
.B -o, --action=[action]
. 
Fencing action (Default Value: reboot)
	
.TP
.B -m, --method=[method]
. 
Method to fence (onoff|cycle) (Default Value: cycle)
	
.TP
.B --ping-count=[number]
. 
The number of ping-probes that is being sent per target (Default Value: 10)
	
.TP
.B --ping-good-count=[number]
. 
The number of positive ping-probes required to account a target as available (Default Value: 8)
	
.TP
.B --ping-interval=[seconds]
. 
The interval in seconds between ping-probes (Default Value: 1)
	
.TP
.B --ping-maxfail=[number]
. 
The number of failed ping-targets to still account as overall success (Default Value: 0)
	
.TP
.B --ping-targets=tgt1,[inet6:]tgt2
. 
A comma separated list of ping-targets (optionally prepended by 'inet:' or 'inet6:') to be probed (Default Value: )
	
.TP
.B --ping-timeout=[seconds]
. 
The timeout in seconds till an individual ping-probe is accounted as lost (Default Value: 2)
	
.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
	
	
.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 --delay=[seconds]
. 
Wait X seconds before fencing is started (Default Value: 0)
	
.TP
.B --login-timeout=[seconds]
. 
Wait X seconds for cmd prompt after login (Default Value: 5)
	
.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: 0)
	
.TP
.B --shell-timeout=[seconds]
. 
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
	
.TP
.B --retry-on=[attempts]
. 
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
\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 method
. 
Method to fence (onoff|cycle) (Default Value: cycle)
	
.TP
.B ping_count
. 
The number of ping-probes that is being sent per target (Default Value: 10)
	
.TP
.B ping_good_count
. 
The number of positive ping-probes required to account a target as available (Default Value: 8)
	
.TP
.B ping_interval
. 
The interval in seconds between ping-probes (Default Value: 1)
	
.TP
.B ping_maxfail
. 
The number of failed ping-targets to still account as overall success (Default Value: 0)
	
.TP
.B ping_targets
. 
A comma separated list of ping-targets (optionally prepended by 'inet:' or 'inet6:') to be probed (Default Value: )
	
.TP
.B ping_timeout
. 
The timeout in seconds till an individual ping-probe is accounted as lost (Default Value: 2)
	
.TP
.B quiet
. 
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
	
.TP
.B verbose
. 
Verbose mode
	
	
.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 delay
. 
Wait X seconds before fencing is started (Default Value: 0)
	
.TP
.B login_timeout
. 
Wait X seconds for cmd prompt after login (Default Value: 5)
	
.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: 0)
	
.TP
.B shell_timeout
. 
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
	
.TP
.B retry_on
. 
Count of attempts to retry power on (Default Value: 1)