fence_xvm(8)

1FENCE_AGENT(8)              System Manager's Manual             FENCE_AGENT(8)
2
3
4

NAME

6       fence_virt - Fencing agent for virtual machines using VM Channel
7
8       fence_xvm - Fencing agent for virtual machines using multicast
9

DESCRIPTION

11       fence_virt  and  fence_xvm  are an I/O Fencing agents which can be used
12       with  virtual  machines.   Fence_xvm  is   backward   compatible   with
13       fence_xvmd.
14
15       Fence_virt  and  fence_xvm talk to fence_virtd, which supports multiple
16       backend plugins, including:
17        - libvirt for single-node operation
18        - Cluster Checkpoints when using Linux-cluster release 3.0.0 or later
19        - libvirt-qpid for multi-node, non-cluster operation
20
21       For compatibility, fence_xvm may talk to fence_xvmd from  linux-cluster
22       release 2 or later.
23
24
25       fence_virt  and fence_xvm accept options on the command line as well as
26       from stdin.  The fencing daemon sends parameters through stdin when  it
27       execs  the  agent.   The  agent  may be run by itself with command line
28       options, which is useful for testing  or  turning  on  or  off  virtual
29       machines from scripts.
30
31

GENERAL PARAMETERS

33
34
35       -d     Increment (command line) debug level
36
37       -H     Virtual machine (domain UUID or name) to fence
38
39
40       -o     Fencing action (null, off, on, reboot, status, monitor, list, or
41              metadata) (Default Value: reboot).  See the FENCING ACTIONS sec‐
42              tion.
43
44
45       -t     Fencing timeout (in seconds) (Default Value: 30)
46
47

MULTICAST PARAMETERS

49       These  parameters are used only when using fence_virt in multicast mode
50       (e.g. by running fence_xvm).
51
52
53       -i     IP Family (auto, ipv4, ipv6) (Default Value: auto)
54
55       -a     Multicast address (Default Values: 225.0.0.12 / ff02::3:1)
56
57       -p     IP port (Default Value: 1229)
58
59       -T     Multicast time-to-live (in hops) (Default Value: 2)
60
61       -r     Multicast retransmit time (in 1/10sec) (Default Value: 20)
62
63       -C     Authentication (none,  sha1,  sha256,  sha512)  (Default  Value:
64              sha256)
65
66       -c     Packet  hash  strength  (none,  sha1,  sha256,  sha512) (Default
67              Value: sha256)
68
69       -k     Shared key file (Default Value: /etc/cluster/fence_xvm.key)
70
71
72       -u     Specify if using fence_virt with older fence_xvmd  installations
73              which are using UUIDs.  Fence_virtd ignores this parameter.
74
75

SERIAL/VMCHANNEL PARAMETERS

77       These  parameters are used only when using fence_virt in multicast mode
78       (e.g. by running fence_xvm).
79
80
81       -D     Serial device (fence_virt mode). On the host, the serial  device
82              must  be  mapped  in  each  domain's  configuration  file.   See
83              fence_virt.conf(5) for more information.   Specifying  a  serial
84              device  causes  fence_virt  to  use  serial  mode (as opposed to
85              VMChannel mode).
86
87
88       -P     Serial parameters. (Default Value: 115200,8N1)
89
90
91       -A     VMChannel IP address (Default Value: 10.0.2.179)
92
93
94       -p     VMChannel IP port (Default Value: 1229)
95
96

GENERAL STDIN PARAMETERS

98       These parameters are passed to fence_virt via standard input if no com‐
99       mand line options are present.  They are presented to fence_virt in the
100       form:
101
102         name=value
103
104       debug  Specify debugging level
105
106
107       port   Virtual machine (domain UUID or name) to fence
108
109
110       action Fencing action (null, off, on, reboot, status, monitor, list, or
111              metadata) (Default Value: reboot).  See the FENCING ACTIONS sec‐
112              tion.
113
114       timeout
115              Fencing timeout (in seconds) (Default Value: 30)
116
117

MULTICAST STDIN PARAMETERS

119       ip_family
120              IP Family ([auto], ipv4, ipv6) (Default Value: auto)
121
122       multicast_address
123              Multicast address (Defaults: 225.0.0.12 / ff02::3:1)
124
125       port   IP port (Default Value: 1229)
126
127       multicast_ttl
128              Multicast time-to-live (in hops) (Default Value: 2)
129
130       retrans
131              Multicast retransmit time (in 1/10sec) (Default Value: 20)
132
133       auth   Authentication (none,  sha1,  sha256,  sha512)  (Default  Value:
134              sha256)
135
136       hash   Packet  hash  strength  (none,  sha1,  sha256,  sha512) (Default
137              Value: sha256)
138
139       key_file
140              Shared key file (Default Value: /etc/cluster/fence_xvm.key)
141
142
143       use_uuid
144              Specify if using fence_virt with older fence_xvmd  installations
145              which are using UUIDs.  Fence_virtd ignores this parameter.
146
147

SERIAL/VMCHANNEL STDIN PARAMETERS

149       serial_device
150              Serial device.  On the host, the serial device must be mapped in
151              each domain's configuration file.   See  fence_virt.conf(5)  for
152              more information.  If specified, causes fence_virt to operate in
153              serial mode (not specifying causes fence_virt to operate  in  VM
154              Channel mode).
155
156
157       serial_params
158              Serial parameters.  Default=115200,8N1.
159
160
161       channel_ip
162              Channel IP.  Default=10.0.2.179
163
164
165       ipport Channel port.  Default=1229
166
167
168

FENCING ACTIONS

170
171
172       off
173               Destroy or turn off virtual machine.
174
175       reboot Reboot  virtual machine; i.e. restart the virtual machine on the
176              same host where it is currently running.
177
178       on     Turn on a virtual machine.  Note: Turning on a  virtual  machine
179              only works with some fence_virt backends.
180
181
182       status Check whether a virtual machine is running or not.
183
184
185       monitor
186              Check the health of fence_virtd's backend plugin.
187
188
189       list   List  virtual  machines  which may be fenced by fence_virtd (not
190              supported on all backends).
191
192
193       metadata
194              Print XML metadata to standard output.
195
196