NAME
fence_xvm - General purpose fencing agent for virtual machines.
SYNOPSIS
fence_xvm [OPTION]...
DESCRIPTION
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.
fence_xvm accepts options on the command line as well as from standard
input. If no command line options are present, fence_xvm will
automatically use standard input. fenced sends the options through
stdin when it execs the agent. fence_xvm can be run by itself with
command line options which is useful for testing.
OPTIONS
-d Enable debugging output. The more times you specify this
parameter, the more debugging output you will receive.
-i family
IP family to use (auto, ipv4, or ipv6; default = auto)
-a address
Multicast address to use (default=225.0.0.12 for ipv4, ff02::3:1
for ipv6)
-p port
Port to use for all communications; must match fence_xvmd
(default=1229)
-r retrans
Multicast retransmission time (in 1/10 seconds; default=20).
This is used to tune the amount of retransmission which is done
on busy networks where multicast traffic is unreliable.
-C auth
Authentication type (none, sha1, sha256, sha512;
default=sha256). This controls the authentication mechanism
used to authenticate clients. The three SHA hashes use a key
which must be shared between both the Xen virtual machines and
the host domain-0 cluster. The three SHA authentication
mechanisms use a simple bidirectional challenge-response based
on pseudo- random number generation and a shared private key.
-c hash
Packet hash type (none, sha1, sha256, sha512; default=sha256).
This controls the hashing mechanism used to authenticate fencing
requests. The three SHA hashes use a key which must be shared
between both the virtual machines and the host (physical)
cluster.
-k key_file
Use the specified key file for packet hashing / SHA
authentication. When both the hash type and the authentication
type are set to "none", this parameter is ignored.
-H domain
This specifies unique domain name of the virtual machine name
(or UUID) which needs to be fenced.
-u Fence by UUID instead of virtual machine name. If specified,
the above -H parameter should be the statically-defined
36-character UUID of the virtual machine rather than its human-
readable name.
-o operation
Fencing operation to perform (null, off, reboot; default=off).
This specifies the fencing operation to perform. The null
operation does not actually do anything, but allows you to check
to see if communication with fence_xvmd is working correctly
(note: the result of the null operation is *always* failure!).
-t timeout
This specifies the amount of time, in seconds, to wait before a
response to the multicast request before giving up (default=30).
-? Print out a help message describing available options, then
exit.
-h Print out a help message describing available options, then
exit.
-V Print out a version message, then exit.
STDIN PARAMETERS
debug = 1
Same as the -d option. Specify numbers >1 for more debugging
information.
family = < param >
Same as the -i option.
multicast_address = < param >
Same as the -a option.
port = < param >
Same as the -p option.
retrans = < param >
Same as the -r option.
auth = < param >
Same as the -C option.
hash = < param >
Same as the -c option.
key_file = < param >
Same as the -k option.
retrans = < param >
Same as the -r option.
domain = < param >
Same as the -H option.
use_uuid = 1
Same as the -u option.
option = < param >
Same as the -o option.
timeout = < param >
Same as the -t option.
domain = < param >
Same as the -H option.
SEE ALSO
fence(8), fence_node(8), fence_xvmd(8)
fence_xvm(8)