[Cluster-devel] [PATCH] RHEL5: fence-agents: Regerate fence_ipmilan.8 man page

[Fabio M. Di Nitto <fdinitto@redhat.com>]

ACK'ed

Fabio

On 02/15/2011 11:11 PM, Lon Hohberger wrote:
> Resolves: rhbz#671089
> 
> Signed-off-by: Lon Hohberger <lhh@redhat.com>
> ---
>  fence/man/fence_ipmilan.8 |  262 ++++++++++++++++++++++++++++----------------
>  1 files changed, 167 insertions(+), 95 deletions(-)
> 
> diff --git a/fence/man/fence_ipmilan.8 b/fence/man/fence_ipmilan.8
> index 9b10198..3bca4d1 100644
> --- a/fence/man/fence_ipmilan.8
> +++ b/fence/man/fence_ipmilan.8
> @@ -1,111 +1,183 @@
> -.\"  Copyright (C) Sistina Software, Inc.  1997-2003  All rights reserved.
> -.\"  Copyright (C) 2004 Red Hat, Inc.  All rights reserved.
> -.\"  
> -.\"  This copyrighted material is made available to anyone wishing to use,
> -.\"  modify, copy, or redistribute it subject to the terms and conditions
> -.\"  of the GNU General Public License v.2.
> -
> -.TH fence_ipmilan 8
>  
> +.TH FENCE_AGENT 8 2009-10-20 "fence_ipmilan (Fence Agent)"
>  .SH NAME
> -fence_ipmilan - I/O Fencing agent for machines controlled by IPMI over
> -LAN.
> +fence_ipmilan - Fence agent for IPMI over LAN
> +.SH DESCRIPTION
> +.P
>  
> -.SH SYNOPSIS
> -.B
> -fence_ipmilan
> -[\fIOPTION\fR]...
> +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/).
>  
> -.SH DESCRIPTION
> -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/).
> +To use fence_ipmilan with HP iLO 3 you have to enable lanplus option (lanplus / -P) and increase wait after operation to 4 seconds (power_wait=4 / -T 4)
> +.P
> +fence_ipmilan accepts options on the command line as well
> +as from stdin. Fenced sends parameters through stdin when it execs the
> +agent. fence_ipmilan can be run by itself with command
> +line options.  This is useful for testing and for turning outlets on or off
> +from scripts.
>  
> -fence_ipmilan accepts options on the command line as well as from stdin.  
> -fenced sends the options through stdin when it execs the agent.  fence_ipmilan
> -can be run by itself with command line options which is useful for testing.
> +.SH PARAMETERS
>  
> -.SH OPTIONS
> -.TP
> -\fB-a\fP \fIIPaddress\fP
> -IP address or hostname of the IPMI controller.
> -.TP
> -\fB-h\fP
> -Print out a help message describing available options, then exit.
> -.TP
> -\fB-l\fP \fIlogin\fP
> -Login (if required) with administrative privileges.
> -.TP
> -\fB-o\fP \fIoption\fP
> -Action to perform (on, off, reboot).
> -.TP
> -\fB-p\fP \fIpassword\fP
> -Password (if required) for login.
> -.TP
> -\fB-P\fP
> -Use the lanplus option if this is a lanplus capable interface (for example iLo2)
> +	
> +.TP
> +.B -A
> +. 
> +IPMI Lan Auth type (md5, password, or none)
> +	
> +.TP
> +.B -a
> +. 
> +IPMI Lan IP to talk to
> +	
> +.TP
> +.B -p
> +. 
> +Password (if required) to control power on IPMI device
> +	
> +.TP
> +.B -S
> +. 
> +Script to retrieve password (if required)
> +	
> +.TP
> +.B -P
> +. 
> +Use Lanplus
> +	
> +.TP
> +.B -l
> +. 
> +Username/Login (if required) to control power on IPMI device
> +	
> +.TP
> +.B -o
> +. 
> +Operation to perform. Valid operations: on, off, reboot, status, list, monitor or metadata (Default Value: reboot)
> +	
> +.TP
> +.B -t
> +. 
> +Timeout (sec) for IPMI operation
> +	
> +.TP
> +.B -C
> +. 
> +Ciphersuite to use (same as ipmitool -C parameter)
> +	
> +.TP
> +.B -M
> +. 
> +Method to fence (onoff or cycle) (Default Value: onoff)
> +	
> +.TP
> +.B -T
> +. 
> +Wait X seconds after on/off operation (Default Value: 2)
> +	
> +.TP
> +.B -f
> +. 
> +Wait X seconds before fencing is started
> +	
> +.TP
> +.B -v
> +. 
> +Verbose mode
> +
> +.SH ACTIONS
> +
> +	
>  .TP
> -\fB-A\fP \fIAuthentication Type\fP
> -Can be set to none, password, md2, or md5.
> +\fBon \fP
> +Power on machine.
> +	
>  .TP
> -\fB-C\fP \fICiphersuite Type\fP
> -If you are using lanplus, this option avails you to define type of ciphersuite to
> -use. Standard is 3 (defined if you just use lanplus). For more information please
> -refer ipmitool man page (option -C).
> +\fBoff \fP
> +Power off machine.
> +	
>  .TP
> -\fB-M\fP \fImethod\fP
> -Method to fence (onoff or cycle). Default is onoff. Use cycle in case your management
> -card will power off with default method so there will be no chance to power machine
> -on by IPMI.
> +\fBreboot \fP
> +Reboot machine.
> +	
>  .TP
> -\fB-t\fP \fItimeout\fP
> -Timeout in seconds for IPMI operation. Default is 10, but in some cases it
> -must be set to higher value (anything above 30 is not recommended and may
> -cause strange problems).
> +\fBstatus \fP
> +This returns the status of the plug/virtual machine.
> +	
>  .TP
> -\fB-q\fP
> -Quiet operation.  Only print out error messages.
> +\fBlist \fP
> +List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.
> +	
>  .TP
> -\fB-V\fP
> -Print out a version message, then exit.
> +\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
> -\fB-v\fP
> -Verbose mode.
> +\fBmetadata \fP
> + The operational behavior of this is not known.
>  
>  .SH STDIN PARAMETERS
> -.TP
> -\fIipaddr = < hostname | ip >\fR
> -IP address or hostname of the IPMI controller.
> -.TP
> -\fIlogin= < param >\fR
> -Login (if required) with administrative privileges.
> -.TP
> -\fIoption = < param >\fR
> -Action to perform (on, off, reboot).
> -.TP
> -\fIpasswd = < param >\fR
> -Password (if required) for login.
> -.TP
> -\fIauth = < param >\fR
> -Authentication type (none, password, md2, md5).
> -.TP
> -\fItimeout = < param >\fR
> -Timeout in seconds for IPMI operation. Default is 10, but in some cases it
> -must be set to higher value (anything above 30 is not recommended and may
> -cause strange problems).
> -.TP
> -\fIcipher = < param >\fR
> -If you are using lanplus, this option avails you to define type of ciphersuite to
> -use. Standard is 3 (defined if you just use lanplus). For more information please
> -refer ipmitool man page (option -C).
> -.TP
> -\fImethod = < param >\fR
> -Method to fence (onoff or cycle). Default is onoff. Use cycle in case your management
> -card will power off with default method so there will be no chance to power machine
> -on by IPMI.
> -.TP
> -\fIlanplus\fR
> -If we are using the lanplus option for ipmitool
>  
> -.SH SEE ALSO
> -fence(8), fence_node(8), ipmitool(1)
> +	
> +.TP
> +.B auth
> +. 
> +IPMI Lan Auth type (md5, password, or none)
> +	
> +.TP
> +.B ipaddr
> +. 
> +IPMI Lan IP to talk to
> +	
> +.TP
> +.B passwd
> +. 
> +Password (if required) to control power on IPMI device
> +	
> +.TP
> +.B passwd_script
> +. 
> +Script to retrieve password (if required)
> +	
> +.TP
> +.B lanplus
> +. 
> +Use Lanplus
> +	
> +.TP
> +.B login
> +. 
> +Username/Login (if required) to control power on IPMI device
> +	
> +.TP
> +.B action
> +. 
> +Operation to perform. Valid operations: on, off, reboot, status, list, monitor or metadata (Default Value: reboot)
> +	
> +.TP
> +.B timeout
> +. 
> +Timeout (sec) for IPMI operation
> +	
> +.TP
> +.B cipher
> +. 
> +Ciphersuite to use (same as ipmitool -C parameter)
> +	
> +.TP
> +.B method
> +. 
> +Method to fence (onoff or cycle) (Default Value: onoff)
> +	
> +.TP
> +.B power_wait
> +. 
> +Wait X seconds after on/off operation (Default Value: 2)
> +	
> +.TP
> +.B delay
> +. 
> +Wait X seconds before fencing is started
> +	
> +.TP
> +.B verbose
> +. 
> +Verbose mode