From be158e9bd1c3c99475ff4f213c19b1732ab0f14d Mon Sep 17 00:00:00 2001
From: Lon Hohberger <lhh@redhat.com>
Date: Thu, 16 Dec 2010 16:24:44 -0500
Subject: [PATCH] fence-agents: Add man pages for ucs, ifmib, rhevm

Signed-off-by: Lon Hohberger <lhh@redhat.com>
---
 fence/man/Makefile          |    3 +
 fence/man/fence_cisco_ucs.8 |  251 +++++++++++++++++++++++++++++++++
 fence/man/fence_ifmib.8     |  323 +++++++++++++++++++++++++++++++++++++++++++
 fence/man/fence_rhevm.8     |  251 +++++++++++++++++++++++++++++++++
 4 files changed, 828 insertions(+), 0 deletions(-)
 create mode 100644 fence/man/fence_cisco_ucs.8
 create mode 100644 fence/man/fence_ifmib.8
 create mode 100644 fence/man/fence_rhevm.8

diff --git a/fence/man/Makefile b/fence/man/Makefile
index 080410e..ad64c0c 100644
--- a/fence/man/Makefile
+++ b/fence/man/Makefile
@@ -39,6 +39,9 @@ TARGET8= \
 	fence_vmware.8 \
 	fence_xvm.8 \
 	fence_xvmd.8 \
+	fence_cisco_ucs.8 \
+	fence_ifmib.8 \
+	fence_rhevm.8 \
 	fenced.8
 
 UNINSTALL=${top_srcdir}/scripts/uninstall.pl
diff --git a/fence/man/fence_cisco_ucs.8 b/fence/man/fence_cisco_ucs.8
new file mode 100644
index 0000000..6afa32b
--- /dev/null
+++ b/fence/man/fence_cisco_ucs.8
@@ -0,0 +1,251 @@
+
+.TH FENCE_AGENT 8 2009-10-20 "fence_cisco_ucs (Fence Agent)"
+.SH NAME
+fence_cisco_ucs - Fence agent for Cisco UCS
+.SH DESCRIPTION
+.P
+fence_cisco_ucs is an I/O Fencing agent which can be used with Cisco UCS to fence machines.
+.P
+fence_cisco_ucs accepts options on the command line as well
+as from stdin. Fenced sends parameters through stdin when it execs the
+agent. fence_cisco_ucs 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.cisco.com
+.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 -z, --ssl
+. 
+SSL connection
+	
+.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 -n, --plug=<id>
+. 
+Physical plug number or name of virtual machine This parameter is always required.
+	
+.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-wait
+. 
+Wait X seconds after issuing ON/OFF (Default Value: 0)
+	
+.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 --retry-on
+. 
+Count of attempts to retry power on (Default Value: 1)
+	
+.TP
+.B --delay
+. 
+Wait X seconds before fencing is started (Default Value: 0)
+
+.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 ssl
+. 
+SSL connection
+	
+.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 port
+. 
+Physical plug number or name of virtual machine This parameter is always required.
+	
+.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_wait
+. 
+Wait X seconds after issuing ON/OFF (Default Value: 0)
+	
+.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 retry_on
+. 
+Count of attempts to retry power on (Default Value: 1)
+	
+.TP
+.B delay
+. 
+Wait X seconds before fencing is started (Default Value: 0)
diff --git a/fence/man/fence_ifmib.8 b/fence/man/fence_ifmib.8
new file mode 100644
index 0000000..914d43a
--- /dev/null
+++ b/fence/man/fence_ifmib.8
@@ -0,0 +1,323 @@
+
+.TH FENCE_AGENT 8 2009-10-20 "fence_ifmib (Fence Agent)"
+.SH NAME
+fence_ifmib - Fence agent for IF MIB
+.SH DESCRIPTION
+.P
+fence_ifmib is an I/O Fencing agent which can be used with any SNMP IF-MIB capable device. 
+.P
+It was written with managed ethernet switches in mind, in order to fence iSCSI SAN connections. However, there are many devices that support the IF-MIB interface. The agent uses IF-MIB::ifAdminStatus to control the state of an interface.
+.P
+fence_ifmib accepts options on the command line as well
+as from stdin. Fenced sends parameters through stdin when it execs the
+agent. fence_ifmib 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.ietf.org/wg/concluded/ifmib.html
+.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
+	
+.TP
+.B -p, --password=<password>
+. 
+Login password or passphrase
+	
+.TP
+.B -S, --password-script=<script>
+. 
+Script to retrieve password
+	
+.TP
+.B -n, --plug=<id>
+. 
+Physical plug number or name of virtual machine This parameter is always required.
+	
+.TP
+.B -d, --snmp-version=<ver>
+. 
+Specifies SNMP version to use (1,2c,3)
+	
+.TP
+.B -c, --community=<community>
+. 
+Set the community string
+	
+.TP
+.B -b, --snmp-auth-prot=<prot>
+. 
+Set authentication protocol (MD5|SHA)
+	
+.TP
+.B -E, --snmp-sec-level=<level>
+. 
+Set security level (noAuthNoPriv|authNoPriv|authPriv)
+	
+.TP
+.B -B, --snmp-priv-prot=<prot>
+. 
+Set privacy protocol (DES|AES)
+	
+.TP
+.B -P, --snmp-priv-passwd=<pass>
+. 
+Set privacy protocol password
+	
+.TP
+.B -R, --snmp-priv-passwd-script
+. 
+Script to run to retrieve privacy password
+	
+.TP
+.B -u, --udpport
+. 
+UDP/TCP port to use for connection with device (Default Value: 161)
+	
+.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 -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: 5)
+	
+.TP
+.B --power-wait
+. 
+Wait X seconds after issuing ON/OFF (Default Value: 0)
+	
+.TP
+.B --retry-on
+. 
+Count of attempts to retry power on (Default Value: 1)
+	
+.TP
+.B --delay
+. 
+Wait X seconds before fencing is started (Default Value: 0)
+
+.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
+	
+.TP
+.B passwd
+. 
+Login password or passphrase
+	
+.TP
+.B passwd_script
+. 
+Script to retrieve password
+	
+.TP
+.B port
+. 
+Physical plug number or name of virtual machine This parameter is always required.
+	
+.TP
+.B snmp_version
+. 
+Specifies SNMP version to use (1,2c,3)
+	
+.TP
+.B community
+. 
+Set the community string
+	
+.TP
+.B snmp_auth_prot
+. 
+Set authentication protocol (MD5|SHA)
+	
+.TP
+.B snmp_sec_level
+. 
+Set security level (noAuthNoPriv|authNoPriv|authPriv)
+	
+.TP
+.B snmp_priv_prot
+. 
+Set privacy protocol (DES|AES)
+	
+.TP
+.B snmp_priv_passwd
+. 
+Set privacy protocol password
+	
+.TP
+.B snmp_priv_passwd_script
+. 
+Script to run to retrieve privacy password
+	
+.TP
+.B udpport
+. 
+UDP/TCP port to use for connection with device (Default Value: 161)
+	
+.TP
+.B inet4_only
+. 
+Forces agent to use IPv4 addresses only
+	
+.TP
+.B inet6_only
+. 
+Forces agent to use IPv6 addresses only
+	
+.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: 5)
+	
+.TP
+.B power_wait
+. 
+Wait X seconds after issuing ON/OFF (Default Value: 0)
+	
+.TP
+.B retry_on
+. 
+Count of attempts to retry power on (Default Value: 1)
+	
+.TP
+.B delay
+. 
+Wait X seconds before fencing is started (Default Value: 0)
diff --git a/fence/man/fence_rhevm.8 b/fence/man/fence_rhevm.8
new file mode 100644
index 0000000..ce2e259
--- /dev/null
+++ b/fence/man/fence_rhevm.8
@@ -0,0 +1,251 @@
+
+.TH FENCE_AGENT 8 2009-10-20 "fence_rhevm (Fence Agent)"
+.SH NAME
+fence_rhevm - Fence agent for RHEV-M REST API
+.SH DESCRIPTION
+.P
+fence_rhevm is an I/O Fencing agent which can be used with RHEV-M REST API to fence virtual machines.
+.P
+fence_rhevm accepts options on the command line as well
+as from stdin. Fenced sends parameters through stdin when it execs the
+agent. fence_rhevm 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.redhat.com
+.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 -z, --ssl
+. 
+SSL connection
+	
+.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 -n, --plug=<id>
+. 
+Physical plug number or name of virtual machine This parameter is always required.
+	
+.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-wait
+. 
+Wait X seconds after issuing ON/OFF (Default Value: 1)
+	
+.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 --retry-on
+. 
+Count of attempts to retry power on (Default Value: 1)
+	
+.TP
+.B --delay
+. 
+Wait X seconds before fencing is started (Default Value: 0)
+
+.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 ssl
+. 
+SSL connection
+	
+.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 port
+. 
+Physical plug number or name of virtual machine This parameter is always required.
+	
+.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_wait
+. 
+Wait X seconds after issuing ON/OFF (Default Value: 1)
+	
+.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 retry_on
+. 
+Count of attempts to retry power on (Default Value: 1)
+	
+.TP
+.B delay
+. 
+Wait X seconds before fencing is started (Default Value: 0)
-- 
1.7.2.3