FENCE_AGENT(8)						      System Manager's Manual						    FENCE_AGENT(8)

NAME

       fence_virt - Fencing agent for virtual machines using VM Channel

       fence_xvm - Fencing agent for virtual machines using multicast

DESCRIPTION

       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.

       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.

GENERAL PARAMETERS


       -d     Increment (command line) debug level

       -H     Virtual machine (domain UUID or name) to fence

       -o     Fencing action (null, off, on, reboot, status, monitor, list, or metadata) (Default Value: reboot).  See the  FENCING  ACTIONS  sec-
	      tion.

       -t     Fencing timeout (in seconds) (Default Value: 30)

       -w     Fencing  delay  (in  seconds).  The  fence  agent  will  wait the specified number of seconds before attempting a fencing operation.
	      (Default Value: 0)

MULTICAST PARAMETERS

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

       -i     IP Family (auto, ipv4, ipv6) (Default Value: auto)

       -a     Multicast address (Default Values: 225.0.0.12 / ff02::3:1)

       -p     IP port (Default Value: 1229)

       -T     Multicast time-to-live (in hops) (Default Value: 2)

       -r     Multicast retransmit time (in 1/10sec) (Default Value: 20)

       -C     Authentication (none, sha1, sha256, sha512) (Default Value: sha256)

       -c     Packet hash strength (none, sha1, sha256, sha512) (Default Value: sha256)

       -k     Shared key file (Default Value: /etc/cluster/fence_xvm.key)

       -u     Specify if using fence_virt with older fence_xvmd installations which are using UUIDs.  Fence_virtd ignores this parameter.

SERIAL
/VMCHANNEL PARAMETERS
       These parameters are used only when using fence_virt in serial mode (e.g. by running fence_virt).

       -D     Serial device (fence_virt mode). On the host,  the  serial  device  must	be  mapped  in	each  domain's	configuration  file.   See
	      fence_virt.conf(5)  for  more information.  Specifying a serial device causes fence_virt to use serial mode (as opposed to VMChannel
	      mode).

       -P     Serial parameters. (Default Value: 115200,8N1)

       -A     VMChannel IP address (Default Value: 10.0.2.179)

       -p     VMChannel IP port (Default Value: 1229)

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

       debug  Specify debugging level

       port   Virtual machine (domain UUID or name) to fence

       action Fencing  action  (null,  off, on, reboot, status, monitor, list, or metadata) (Default Value: reboot).  See the FENCING ACTIONS sec-
	      tion.

       timeout
	      Fencing timeout (in seconds) (Default Value: 30)

MULTICAST STDIN PARAMETERS

       ip_family
	      IP Family ([auto], ipv4, ipv6) (Default Value: auto)

       multicast_address
	      Multicast address (Defaults: 225.0.0.12 / ff02::3:1)

       port   IP port (Default Value: 1229)

       multicast_ttl
	      Multicast time-to-live (in hops) (Default Value: 2)

       retrans
	      Multicast retransmit time (in 1/10sec) (Default Value: 20)

       auth   Authentication (none, sha1, sha256, sha512) (Default Value: sha256)

       hash   Packet hash strength (none, sha1, sha256, sha512) (Default Value: sha256)

       key_file
	      Shared key file (Default Value: /etc/cluster/fence_xvm.key)

       use_uuid
	      Specify if using fence_virt with older fence_xvmd installations which are using UUIDs.  Fence_virtd ignores this parameter.

SERIAL
/VMCHANNEL STDIN PARAMETERS
       serial_device
	      Serial device.  On the host, the serial device must be mapped in each domain's configuration file.  See fence_virt.conf(5) for  more
	      information.   If  specified, causes fence_virt to operate in serial mode (not specifying causes fence_virt to operate in VM Channel
	      mode).

       serial_params
	      Serial parameters.  Default=115200,8N1.

       channel_ip
	      Channel IP.  Default=10.0.2.179

       ipport Channel port.  Default=1229

FENCING ACTIONS


       off
	       Destroy or turn off virtual machine.

       reboot Reboot virtual machine; i.e. restart the virtual machine on the same host where it is currently running.

       on     Turn on a virtual machine.  Note: Turning on a virtual machine only works with some fence_virt backends.

       status Check whether a virtual machine is running or not.

       monitor
	      Check the health of fence_virtd's backend plugin.

       list   List virtual machines which may be fenced by fence_virtd (not supported on all backends).

       metadata
	      Print XML metadata to standard output.

SEE ALSO

       fence_virtd(8), fence(8), fence_virtd.conf(5)

fence_virt (Fence Agent)					    2009-12-04							    FENCE_AGENT(8)