.TH FENCE_AGENT 8 2009-10-20 "fence_pve (Fence Agent)"
.SH NAME
fence_pve - Fencing agent for the Proxmox Virtual Environment
.SH DESCRIPTION
.P
The fence_pve agent can be used to fence virtual machines acting as nodes in a virtualized cluster.
.P
fence_pve accepts options on the command line as well
as from stdin. Fenced sends parameters through stdin when it execs the
agent. fence_pve 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.proxmox.com/
.SH PARAMETERS

	
.TP
.B -o, --action=[action]
. 
Fencing action (Default Value: reboot)
	
.TP
.B -a, --ip=[ip]
. 
IP Address or Hostname of a node within the Proxmox cluster. This parameter is always required.
	
	
.TP
.B -u, --ipport=[port]
. 
TCP/UDP port to use for connection with device (Default Value: 8006)
	
	
.TP
.B -m, --method=[method]
. 
Method to fence (onoff|cycle) (Default Value: onoff)
	
	
	
.TP
.B -p, --password=[password]
. 
Login password or passphrase
	
.TP
.B -S, --password-script=[script]
. 
Script to run to retrieve password
	
.TP
.B -n, --plug=[id]
. 
Id of the virtual machine. This parameter is always required.
	
	
.TP
.B -z, --ssl
. 
Use SSL connection with verifying certificate (Default Value: 1)
	
.TP
.B --ssl-insecure
. 
Use SSL connection without verifying certificate
	
.TP
.B --ssl-secure
. 
Use SSL connection with verifying certificate
	
.TP
.B -l, --username=[name]
. 
Login name (Default Value: root@pam)
	
.TP
.B -N, --pve-node=[node_name]
. 
Proxmox node name on which machine is located. (Must be specified if not using --pve-node-auto)
	
.TP
.B -A, --pve-node-auto
. 
Automatically select proxmox node. (This option overrides --pve-node)
	
.TP
.B --vmtype
. 
Virtual machine type lxc or qemu. (Default: qemu) (Default Value: qemu)
	
	
.TP
.B --nodename
. 
Replaced by --pve-node
	
.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. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.
	
.TP
.B --verbose-level
. 
Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).
	
	
.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 --plug-separator=[char]
. 
Separator for plug parameter when specifying more than 1 plug (Default Value: ,)
	
.TP
.B -C, --separator=[char]
. 
Separator for CSV created by 'list' operation (Default Value: ,)
	
.TP
.B --delay=[seconds]
. 
Wait X seconds before fencing is started (Default Value: 0)
	
.TP
.B --disable-timeout=[true/false]
. 
Disable timeout (true/false) (default: true when run from Pacemaker 2.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 --stonith-status-sleep=[seconds]
. 
Sleep X seconds between status calls during a STONITH action (Default Value: 1)
	
.TP
.B --retry-on=[attempts]
. 
Count of attempts to retry power on (Default Value: 1)
	
.TP
.B --gnutlscli-path=[path]
. 
Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

.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
\fBlist-status \fP
List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.
	
.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 ip
. 
IP Address or Hostname of a node within the Proxmox cluster. This parameter is always required. Obsoletes: ipaddr
	
	
.TP
.B ipport
. 
TCP/UDP port to use for connection with device (Default Value: 8006)
	
	
.TP
.B method
. 
Method to fence (onoff|cycle) (Default Value: onoff)
	
	
	
.TP
.B password
. 
Login password or passphrase Obsoletes: passwd
	
.TP
.B password_script
. 
Script to run to retrieve password Obsoletes: passwd_script
	
.TP
.B plug
. 
Id of the virtual machine. This parameter is always required. Obsoletes: port
	
	
.TP
.B ssl
. 
Use SSL connection with verifying certificate (Default Value: 1)
	
.TP
.B ssl_insecure
. 
Use SSL connection without verifying certificate
	
.TP
.B ssl_secure
. 
Use SSL connection with verifying certificate
	
.TP
.B username
. 
Login name (Default Value: root@pam) Obsoletes: login
	
.TP
.B pve_node
. 
Proxmox node name on which machine is located. (Must be specified if not using --pve-node-auto)
	
.TP
.B pve_node_auto
. 
Automatically select proxmox node. (This option overrides --pve-node)
	
.TP
.B vmtype
. 
Virtual machine type lxc or qemu. (Default: qemu) (Default Value: qemu)
	
	
.TP
.B nodename
. 
Replaced by --pve-node Obsoletes: node_name
	
.TP
.B quiet
. 
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
	
.TP
.B verbose
. 
Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.
	
.TP
.B verbose_level
. 
Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).
	
	
.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 plug_separator
. 
Separator for plug parameter when specifying more than 1 plug (Default Value: ,)
	
.TP
.B separator
. 
Separator for CSV created by 'list' operation (Default Value: ,)
	
.TP
.B delay
. 
Wait X seconds before fencing is started (Default Value: 0)
	
.TP
.B disable_timeout
. 
Disable timeout (true/false) (default: true when run from Pacemaker 2.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 stonith_status_sleep
. 
Sleep X seconds between status calls during a STONITH action (Default Value: 1)
	
.TP
.B retry_on
. 
Count of attempts to retry power on (Default Value: 1)
	
.TP
.B gnutlscli_path
. 
Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)