Gitweb: http://git.fedorahosted.org/git/cluster.git?p=cluster.git;a=commitdiff;h=93c... Commit: 93ccda3ab24e76d3e3bcd8da372e2eee1fc23ce1 Parent: 52a605b85acd70177c8592483e232dde5645f1db Author: Marek 'marx' Grac mgrac@redhat.com AuthorDate: Tue Oct 20 00:54:48 2009 +0200 Committer: Fabio M. Di Nitto fdinitto@redhat.com CommitterDate: Tue Oct 20 05:34:51 2009 +0200
fencing: long description added
--- fence/agents/alom/fence_alom.py | 3 ++- fence/agents/apc/fence_apc.py | 6 +++++- fence/agents/apc_snmp/fence_apc_snmp.py | 5 ++++- fence/agents/bladecenter/fence_bladecenter.py | 5 ++++- fence/agents/cisco_mds/fence_cisco_mds.py | 3 ++- fence/agents/drac5/fence_drac5.py | 6 +++++- fence/agents/eps/fence_eps.py | 9 ++++++++- fence/agents/ibmblade/fence_ibmblade.py | 5 ++++- fence/agents/ifmib/fence_ifmib.py | 8 +++++++- fence/agents/ilo/fence_ilo.py | 6 +++++- fence/agents/intelmodular/fence_intelmodular.py | 9 ++++++++- fence/agents/ipmilan/ipmilan.c | 3 +++ fence/agents/ldom/fence_ldom.py | 13 ++++++++++++- fence/agents/lib/fence2man.xsl | 4 +++- fence/agents/rsa/fence_rsa.py | 7 ++++++- fence/agents/virsh/fence_virsh.py | 8 +++++++- fence/agents/vmware/fence_vmware.py | 22 +++++++++++++++++++++- fence/agents/wti/fence_wti.py | 6 +++++- fence/agents/xvm/options.c | 6 ++++++ 19 files changed, 117 insertions(+), 17 deletions(-)
diff --git a/fence/agents/alom/fence_alom.py b/fence/agents/alom/fence_alom.py index cb057b7..086b69b 100644 --- a/fence/agents/alom/fence_alom.py +++ b/fence/agents/alom/fence_alom.py @@ -62,7 +62,8 @@ def main(): docs = { } docs["shortdesc"] = "Fence agent for Sun ALOM" - docs["longdesc"] = "" + docs["longdesc"] = "fence_alom is an I/O Fencing \ +agent which can be used with ALOM connected machines." show_docs(options, docs) # Operate the fencing device diff --git a/fence/agents/apc/fence_apc.py b/fence/agents/apc/fence_apc.py index 71ed70c..ea29d6a 100755 --- a/fence/agents/apc/fence_apc.py +++ b/fence/agents/apc/fence_apc.py @@ -202,7 +202,11 @@ def main():
docs = { } docs["shortdesc"] = "Fence agent for APC over telnet/ssh" - docs["longdesc"] = "" + docs["longdesc"] = "fence_apc is an I/O Fencing agent \ +which can be used with the APC network power switch. It logs into device \ +via telnet/ssh and reboots a specified outlet. Lengthy telnet/ssh connections \ +should be avoided while a GFS cluster is running because the connection \ +will block any necessary fencing actions." show_docs(options, docs)
## Support for -n [switch]:[plug] notation that was used before diff --git a/fence/agents/apc_snmp/fence_apc_snmp.py b/fence/agents/apc_snmp/fence_apc_snmp.py index 5054fae..ea3a89f 100644 --- a/fence/agents/apc_snmp/fence_apc_snmp.py +++ b/fence/agents/apc_snmp/fence_apc_snmp.py @@ -191,7 +191,10 @@ def main():
docs = { } docs["shortdesc"] = "Fence agent for APC over SNMP" - docs["longdesc"] = "" + docs["longdesc"] = "fence_apc_snmp is an I/O Fencing agent \ +which can be used with the APC network power switch. It logs \ +into a device via SNMP and reboots a specified outlet. It supports \ +SNMP v1 and v3 with all combinations of authenticity/privacy settings." show_docs(options, docs)
# Operate the fencing device diff --git a/fence/agents/bladecenter/fence_bladecenter.py b/fence/agents/bladecenter/fence_bladecenter.py index 0590f57..64b7351 100644 --- a/fence/agents/bladecenter/fence_bladecenter.py +++ b/fence/agents/bladecenter/fence_bladecenter.py @@ -106,7 +106,10 @@ def main():
docs = { } docs["shortdesc"] = "Fence agent for IBM BladeCenter" - docs["longdesc"] = "" + docs["longdesc"] = "fence_bladecenter is an I/O Fencing agent \ +which can be used with IBM Bladecenters with recent enough firmware that \ +includes telnet support. It logs into a Brocade chasis via telnet or ssh \ +and uses the command line interface to power on and off blades." show_docs(options, docs) ## diff --git a/fence/agents/cisco_mds/fence_cisco_mds.py b/fence/agents/cisco_mds/fence_cisco_mds.py index 68be9eb..c345c2e 100644 --- a/fence/agents/cisco_mds/fence_cisco_mds.py +++ b/fence/agents/cisco_mds/fence_cisco_mds.py @@ -109,7 +109,8 @@ def main():
docs = { } docs["shortdesc"] = "Fence agent for Cisco MDS" - docs["longdesc"] = "" + docs["longdesc"] = "fence_cisco_mds is an I/O Fencing agent \ +which can be used with any Cisco MDS 9000 series with SNMP enabled device." show_docs(options, docs)
if (not (options["-o"] in ["list","monitor"])): diff --git a/fence/agents/drac5/fence_drac5.py b/fence/agents/drac5/fence_drac5.py index 3f161ab..b185541 100755 --- a/fence/agents/drac5/fence_drac5.py +++ b/fence/agents/drac5/fence_drac5.py @@ -99,7 +99,11 @@ def main():
docs = { } docs["shortdesc"] = "Fence agent for Dell DRAC CMC/5" - docs["longdesc"] = "" + docs["longdesc"] = "fence_drac5 is an I/O Fencing agent \ +which can be used with the Dell Remote Access Card v5 or CMC (DRAC). \ +This device provides remote access to controlling power to a server. \ +It logs into the DRAC through the telnet/ssh interface of the card. \ +By default, the telnet interface is not enabled." show_docs(options, docs)
## diff --git a/fence/agents/eps/fence_eps.py b/fence/agents/eps/fence_eps.py index c9ead36..ffcb69b 100644 --- a/fence/agents/eps/fence_eps.py +++ b/fence/agents/eps/fence_eps.py @@ -109,7 +109,14 @@ def main():
docs = { } docs["shortdesc"] = "Fence agent for ePowerSwitch" - docs["longdesc"] = "" + docs["longdesc"] = "fence_eps is an I/O Fencing agent \ +which can be used with the ePowerSwitch 8M+ power switch to fence \ +connected machines. Fence agent works ONLY on 8M+ device, because \ +this is only one, which has support for hidden page feature. \ +\n.TP\n\ +Agent basically works by connecting to hidden page and pass \ +appropriate arguments to GET request. This means, that hidden \ +page feature must be enabled and properly configured." show_docs(options, docs)
#Run fence action. Conn is None, beacause we always need open new http connection diff --git a/fence/agents/ibmblade/fence_ibmblade.py b/fence/agents/ibmblade/fence_ibmblade.py index c1c75ec..3ad6acc 100644 --- a/fence/agents/ibmblade/fence_ibmblade.py +++ b/fence/agents/ibmblade/fence_ibmblade.py @@ -73,7 +73,10 @@ def main():
docs = { } docs["shortdesc"] = "Fence agent for IBM BladeCenter over SNMP" - docs["longdesc"] = "" + docs["longdesc"] = "fence_ibmblade is an I/O Fencing agent \ +which can be used with IBM BladeCenter chassis. It issues SNMP Set \ +request to BladeCenter chassis, rebooting, powering up or down \ +the specified Blade Server." show_docs(options, docs)
# Operate the fencing device diff --git a/fence/agents/ifmib/fence_ifmib.py b/fence/agents/ifmib/fence_ifmib.py index 44ff927..9f388d0 100644 --- a/fence/agents/ifmib/fence_ifmib.py +++ b/fence/agents/ifmib/fence_ifmib.py @@ -130,7 +130,13 @@ def main():
docs = { } docs["shortdesc"] = "Fence agent for IF MIB" - docs["longdesc"] = "" + docs["longdesc"] = "fence_ifmib is an I/O Fencing agent \ +which can be used with any SNMP IF-MIB capable device. \ +\n.P\n\ +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." show_docs(options, docs)
# Operate the fencing device diff --git a/fence/agents/ilo/fence_ilo.py b/fence/agents/ilo/fence_ilo.py index 32a6edf..9207ec1 100755 --- a/fence/agents/ilo/fence_ilo.py +++ b/fence/agents/ilo/fence_ilo.py @@ -70,7 +70,11 @@ def main():
docs = { } docs["shortdesc"] = "Fence agent for HP iLO" - docs["longdesc"] = "" + docs["longdesc"] = "fence_ilo is an I/O Fencing agent \ +used for HP servers with the Integrated Light Out (iLO) PCI card.\ +The agent opens an SSL connection to the iLO card. Once the SSL \ +connection is established, the agent is able to communicate with \ +the iLO card through an XML stream." show_docs(options, docs)
## diff --git a/fence/agents/intelmodular/fence_intelmodular.py b/fence/agents/intelmodular/fence_intelmodular.py index c3f9252..1a313ae 100644 --- a/fence/agents/intelmodular/fence_intelmodular.py +++ b/fence/agents/intelmodular/fence_intelmodular.py @@ -79,7 +79,14 @@ def main():
docs = { } docs["shortdesc"] = "Fence agent for Intel Modular" - docs["longdesc"] = "" + docs["longdesc"] = "fence_intelmodular is an I/O Fencing agent \ +which can be used with Intel Modular device (tested on Intel MFSYS25, should \ +work with MFSYS35 as well). \ +\n.P\n\ +Note: Since firmware update version 2.7, SNMP v2 write support is \ +removed, and replaced by SNMP v3 support. So agent now has default \ +SNMP version 3. If you are using older firmware, please supply -d \ +for command line and snmp_version option for your cluster.conf." show_docs(options, docs)
# Operate the fencing device diff --git a/fence/agents/ipmilan/ipmilan.c b/fence/agents/ipmilan/ipmilan.c index d980c87..c25a9a5 100644 --- a/fence/agents/ipmilan/ipmilan.c +++ b/fence/agents/ipmilan/ipmilan.c @@ -827,6 +827,9 @@ static void print_xml_metadata(char *pname) { printf("%s\n","<?xml version=\"1.0\" ?>"); printf("%s%s%s\n","<resource-agent name="",pname,"" shortdesc="Fence agent for IPMI over LAN">"); printf("<longdesc>\n"); + printf("fence_ipmilan is an I/O Fencing agent which can be used with " + "machines controlled by IPMI. This agent calls support software " + "using ipmitool (http://ipmitool.sf.net/)."); printf("</longdesc>\n"); printf("%s\n","<parameters>");
diff --git a/fence/agents/ldom/fence_ldom.py b/fence/agents/ldom/fence_ldom.py index ac2bfea..d520fca 100644 --- a/fence/agents/ldom/fence_ldom.py +++ b/fence/agents/ldom/fence_ldom.py @@ -101,7 +101,18 @@ def main(): docs = { } docs["shortdesc"] = "Fence agent for Sun LDOM" - docs["longdesc"] = "" + docs["longdesc"] = "fence_ldom is an I/O Fencing agent \ +which can be used with LDoms virtual machines. This agent works \ +so, that run ldm command on host machine. So ldm must be directly \ +runnable.\ +\n.P\n\ +Very useful parameter is -c (or cmd_prompt in stdin mode). This \ +must be set to something, what is displayed after successful login \ +to host machine. Default string is space on end of string (default \ +for root in bash). But (for example) csh use ], so in that case you \ +must use parameter -c with argument ]. Very similar situation is, \ +if you use bash and login to host machine with other user than \ +root. Than prompt is $, so again, you must use parameter -c." show_docs(options, docs)
## diff --git a/fence/agents/lib/fence2man.xsl b/fence/agents/lib/fence2man.xsl index f8ff237..e2d3dca 100644 --- a/fence/agents/lib/fence2man.xsl +++ b/fence/agents/lib/fence2man.xsl @@ -32,12 +32,14 @@ .SH NAME <xsl:value-of select="@name" /> - <xsl:value-of select="@shortdesc" /> .SH DESCRIPTION +.P +<xsl:value-of select="longdesc"/> +.P <xsl:value-of select="@name" /> accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. <xsl:value-of select="@name" /> can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts. -<xsl:value-of select="normalize-space(longdesc)"/> .SH PARAMETERS <xsl:apply-templates select="parameters"><xsl:with-param name="show">getopt</xsl:with-param></xsl:apply-templates> .SH ACTIONS diff --git a/fence/agents/rsa/fence_rsa.py b/fence/agents/rsa/fence_rsa.py index da8646b..a18b43d 100644 --- a/fence/agents/rsa/fence_rsa.py +++ b/fence/agents/rsa/fence_rsa.py @@ -59,7 +59,12 @@ def main():
docs = { } docs["shortdesc"] = "Fence agent for IBM RSA" - docs["longdesc"] = "" + docs["longdesc"] = "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." show_docs(options, docs) ## diff --git a/fence/agents/virsh/fence_virsh.py b/fence/agents/virsh/fence_virsh.py index 8508c17..1d8afea 100644 --- a/fence/agents/virsh/fence_virsh.py +++ b/fence/agents/virsh/fence_virsh.py @@ -80,7 +80,13 @@ def main():
docs = { } docs["shortdesc"] = "Fence agent for virsh" - docs["longdesc"] = "" + docs["longdesc"] = "fence_virsh is an I/O Fencing agent \ +which can be used with the virtual machines managed by libvirt. \ +It logs via ssh to a dom0 and there run virsh command, which does \ +all work. \ +\n.P\n\ +By default, virsh needs root account to do properly work. So you \ +must allow ssh login in your sshd_config." show_docs(options, docs)
## Operate the fencing device diff --git a/fence/agents/vmware/fence_vmware.py b/fence/agents/vmware/fence_vmware.py index b435632..75fd887 100644 --- a/fence/agents/vmware/fence_vmware.py +++ b/fence/agents/vmware/fence_vmware.py @@ -301,7 +301,27 @@ def main():
docs = { } docs["shortdesc"] = "Fence agent for VMWare" - docs["longdesc"] = "" + docs["longdesc"] = "fence_vmware is an I/O Fencing agent \ +which can be used with the VMware ESX, VMware ESXi or VMware Server \ +to fence virtual machines.\ +\n.P\n\ +Before you can use this agent, it must be installed VI Perl Toolkit or \ +vmrun command on every node you want to make fencing.\ +\n.P\n\ +VI Perl Toolkit is preferred for VMware ESX/ESXi and Virtual Center. Vmrun \ +command is only solution for VMware Server 1/2 (this command will works against \ +ESX/ESXi 3.5 up2 and VC up2 too, but not cluster aware!) and is available as part \ +of VMware VIX API SDK package. VI Perl and VIX API SDK are both available from \ +VMware web pages (not int RHEL repository!). \ +\n.P\n\ +You can specify type of VMware you are connecting to with \fB-d\fP switch \ +(or \fIvmware_type\fR for stdin). Possible values are esx, server2 and server1.\ +Default value is esx, which will use VI Perl. With server1 and server2, vmrun \ +command is used.\ +\n.P\n\ +After you have successfully installed VI Perl Toolkit or VIX API, you should \ +be able to run fence_vmware_helper (part of this agent) or vmrun command. \ +This agent supports only vmrun from version 2.0.0 (VIX API 1.6.0)." show_docs(options, docs)
# Check vmware type and set path diff --git a/fence/agents/wti/fence_wti.py b/fence/agents/wti/fence_wti.py index eac79a3..3ac9217 100644 --- a/fence/agents/wti/fence_wti.py +++ b/fence/agents/wti/fence_wti.py @@ -91,7 +91,11 @@ def main():
docs = { } docs["shortdesc"] = "Fence agent for WTI" - docs["longdesc"] = "" + docs["longdesc"] = "fence_wti is an I/O Fencing agent \ +which can be used with the WTI Network Power Switch (NPS). It logs \ +into an NPS via telnet or ssh and boots a specified plug. \ +Lengthy telnet connections to the NPS should be avoided while a GFS cluster \ +is running because the connection will block any necessary fencing actions." show_docs(options, docs) ## diff --git a/fence/agents/xvm/options.c b/fence/agents/xvm/options.c index 612ecf0..0e5d394 100644 --- a/fence/agents/xvm/options.c +++ b/fence/agents/xvm/options.c @@ -563,6 +563,12 @@ args_metadata(char *progname, const char *optstr)
printf("<?xml version=\"1.0\" ?>\n"); printf("<resource-agent name="%s" shortdesc="Fence agent for virtual machines">\n", basename(progname)); + printf("<longdesc>fence_xvm is an I/O Fencing agent which can be used with any " +"virtual machines for which libvirt has a backend. When used on virtual " +"machines which are backed by clustered storage (and thus, may " +"be migrated about several physical machines), there is a " +"requirement that the host machines are also a part of a CMAN/OpenAIS based " +"cluster, such as linux-cluster.</longdesc>\n"); printf("<parameters>\n");
for (x = 0; x < strlen(optstr); x++) {
cluster-commits@lists.stg.fedorahosted.org