fence-virt/man/fence_virt.8

.TH FENCE_AGENT 8 2009-12-04 "fence_virt (Fence Agent)"
.SH NAME
fence_virt - Fencing agent for virtual machines using VM Channel

fence_xvm - Fencing agent for virtual machines using multicast
.SH DESCRIPTION
.P
fence_virt and fence_xvm are an I/O Fencing agents which can be used with virtual machines.  Fence_xvm is backward compatible with fence_xvmd.

Fence_virt and fence_xvm talk to fence_virtd, which supports multiple backend plugins, including:
 - libvirt for single-node operation
 - Cluster Checkpoints when using Linux-cluster release 3.0.0 or later
 - libvirt-qpid for multi-node, non-cluster operation

For compatibility, fence_xvm may talk to fence_xvmd from linux-cluster
release 2 or later.

.P
fence_virt and fence_xvm accept options on the command line as well
as from stdin.  The fencing daemon sends parameters through stdin
when it execs the agent.  The agent may be run by itself with command
line options, which is useful for testing or turning on or off virtual
machines from scripts.

.SH GENERAL PARAMETERS
	
.TP
.B -d
. 
Specify (CCS) / increment (command line) debug level
	
.TP
.B -H
. 
Virtual machine (domain name) to fence

.TP
.B -o
. 
Fencing action (null, off, on, [reboot], status, devstatus, or hostlist) (Default Value: reboot)

.TP
.B -t
. 
Fencing timeout (in seconds; default=30) (Default Value: 30)

.SH MULTICAST PARAMETERS
These parameters are used only when using fence_virt in multicast mode
(e.g. by running fence_xvm).

.TP
.B -i
. 
IP Family ([auto], ipv4, ipv6) (Default Value: auto)
	
.TP
.B -a
. 
Multicast address (default=225.0.0.12 / ff02::3:1)
	
.TP
.B -p
. 
IP port (default=1229) (Default Value: 1229)
	
.TP
.B -T
. 
Multicast time-to-live (in hops; default=2) (Default Value: 2)
	
.TP
.B -r
. 
Multicast retransmit time (in 1/10sec; default=20) (Default Value: 20)
	
.TP
.B -C
. 
Authentication (none, sha1, [sha256], sha512) (Default Value: sha256)
	
.TP
.B -c
. 
Packet hash strength (none, sha1, [sha256], sha512) (Default Value: sha256)
	
.TP
.B -k
. 
Shared key file (Default Value: /etc/cluster/fence_xvm.key)

.TP
.B -u
. 
Treat 'domain' as UUID instead of domain name.
	
.SH MULTICAST PARAMETERS
These parameters are used only when using fence_virt in multicast mode
(e.g. by running fence_xvm).

.TP
.B -D
. 
Serial device (fence_virt mode).  Default=/dev/ttyS1.  On the host, the
serial device must be mapped in each domain's configuration file.  See
fence_virt.conf(5) for more information.

.TP
.B -P
.
Serial parameters.  Default=115200,8N1

.SH GENERAL STDIN PARAMETERS
These parameters are passed to fence_virt via standard input if
no command line options are present.  They are presented to
fence_virt in the form:

  name=value
	
.TP
.B debug
. 
Specify debugging level

.TP
.B domain
. 
Virtual machine (domain name) to fence

.TP
.B action
. 
Fencing action to perform (See FENCING ACTIONS section)
	
.TP
.B timeout
. 
Fencing timeout (in seconds; default=30) (Default Value: 30)

.SH MULTICAST STDIN PARAMETERS
.TP
.B ip_family
. 
IP Family ([auto], ipv4, ipv6) (Default Value: auto)
	
.TP
.B multicast_address
. 
Multicast address (default=225.0.0.12 / ff02::3:1)
	
.TP
.B port
. 
IP port (default=1229) (Default Value: 1229)
	
.TP
.B multicast_ttl
. 
Multicast time-to-live (in hops; default=2) (Default Value: 2)
	
.TP
.B retrans
. 
Multicast retransmit time (in 1/10sec; default=20) (Default Value: 20)
	
.TP
.B auth
. 
Authentication (none, sha1, [sha256], sha512) (Default Value: sha256)
	
.TP
.B hash
. 
Packet hash strength (none, sha1, [sha256], sha512) (Default Value: sha256)
	
.TP
.B key_file
. 
Shared key file (default=/etc/cluster/fence_xvm.key) (Default Value: /etc/cluster/fence_xvm.key)

.TP
.B use_uuid
. 
Treat 'domain' as UUID instead of domain name

.SH SERIAL STDIN PARAMETERS
.TP
.B serial_device
. 
Serial device.  Default=/dev/ttyS1.  On the host, the serial device must
be mapped in each domain's configuration file.  See fence_virt.conf(5)
for more information.

.TP
.B serial_params
. 
Serial parameters.  Default=115200,8N1.

.SH FENCING ACTIONS
	
.TP
\fBoff \fP
 Destroy or turn off virtual machine.
	
.TP
\fBreboot \fP
Reboot virtual machine; i.e. restart the virtual machine on the same
host where it is currently running.
	
.TP
\fBon \fP
Turn on a virtual machine.  Note: Turning on a virtual machine only works
with some fence_virt backends.

.TP
\fBstatus \fP
Check whether a virtual machine is running or not.

.TP
\fBdevstatus \fP
Check the health of fence_virtd.

.TP
\fBhostlist \fP
List virtual machines which may be fenced by fence_virtd (not supported
on all backends).

.SH SEE ALSO
fence_virtd(8), fence(8), fence_virtd.conf(5)