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        - Corosync CPG 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,
41              list-status, validate-all, or metadata) (Default Value: reboot).
42              See the FENCING ACTIONS section.
43
44
45       -t     Fencing timeout (in seconds) (Default Value: 30)
46
47
48       -w     Fencing delay (in seconds). The fence agent will wait the speci‐
49              fied number of seconds before attempting  a  fencing  operation.
50              (Default Value: 0)
51
52

MULTICAST PARAMETERS

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

SERIAL/VMCHANNEL/TCP/VSOCK PARAMETERS

82       These  parameters  are  used  only when using fence_virt in serial mode
83       (e.g. by running fence_virt).
84
85
86       -D     Serial device (fence_virt mode). On the host, the serial  device
87              must  be  mapped  in  each  domain's  configuration  file.   See
88              fence_virt.conf(5) for more information.   Specifying  a  serial
89              device  causes  fence_virt  to  use  serial  mode (as opposed to
90              VMChannel mode).
91
92
93       -P     Serial parameters. (Default Value: 115200,8N1)
94
95
96       -A     VMChannel IP address (Default Value: 10.0.2.179)
97
98
99       -p     VMChannel IP port (Default Value: 1229)
100
101
102       -S [<CID>]
103              Connect to the fence_virt daemon via vsock. If CID is specified,
104              fence_virt  will attempt to connect to the specified CID, other‐
105              wise it will connect to the default hypervisor CID of 2.
106
107
108

GENERAL STDIN PARAMETERS

110       These parameters are passed to fence_virt via standard input if no com‐
111       mand line options are present.  They are presented to fence_virt in the
112       form:
113
114         name=value
115
116       debug  Specify debugging level
117
118
119       port   Virtual machine (domain UUID or name) to fence
120
121
122       action
123
124
125       action Fencing action (null, off, on, reboot,  status,  monitor,  list,
126              list-status, validate-all, or metadata) (Default Value: reboot).
127              See the FENCING ACTIONS section.
128
129       timeout
130              Fencing timeout (in seconds) (Default Value: 30)
131
132

MULTICAST STDIN PARAMETERS

134       ip_family
135              IP Family ([auto], ipv4, ipv6) (Default Value: auto)
136
137       multicast_address
138              Multicast address (Defaults: 225.0.0.12 / ff02::3:1)
139
140       port   IP port (Default Value: 1229)
141
142       multicast_ttl
143              Multicast time-to-live (in hops) (Default Value: 2)
144
145       retrans
146              Multicast retransmit time (in 1/10sec) (Default Value: 20)
147
148       auth   Authentication (none,  sha1,  sha256,  sha512)  (Default  Value:
149              sha256)
150
151       hash   Packet  hash  strength  (none,  sha1,  sha256,  sha512) (Default
152              Value: sha256)
153
154       key_file
155              Shared key file (Default Value: /etc/cluster/fence_xvm.key)
156
157
158       use_uuid
159              Specify if using fence_virt with older fence_xvmd  installations
160              which are using UUIDs.  Fence_virtd ignores this parameter.
161
162

SERIAL/VMCHANNEL/TCP/VSOCK STDIN PARAMETERS

164       serial_device
165              Serial device.  On the host, the serial device must be mapped in
166              each domain's configuration file.   See  fence_virt.conf(5)  for
167              more information.  If specified, causes fence_virt to operate in
168              serial mode (not specifying causes fence_virt to operate  in  VM
169              Channel mode).
170
171
172       serial_params
173              Serial parameters.  Default=115200,8N1.
174
175
176       channel_ip
177              Channel IP.  Default=10.0.2.179
178
179
180       ipport Channel port.  Default=1229
181
182
183       vsock  Connect  to  the  fence_virt daemon via vsock. If an argument is
184              given, fence_virt will use the argument specified as the CID for
185              the  connection. If no argument is given, it will connect to the
186              default hypervisor CID of 2.
187
188

FENCING ACTIONS

190
191
192       off
193               Destroy or turn off virtual machine.
194
195       reboot Reboot virtual machine; i.e. restart the virtual machine on  the
196              same host where it is currently running.
197
198       on     Turn  on  a virtual machine.  Note: Turning on a virtual machine
199              only works with some fence_virt backends.
200
201
202       status Check whether a virtual machine is running or not.
203
204
205       monitor
206              Check the health of fence_virtd's backend plugin.
207
208
209       list and list-status
210              List virtual machines which may be fenced  by  fence_virtd  (not
211              supported on all backends).
212
213
214       validate-all
215              Validate  arguments given on either the command line or standard
216              input. If validation fails, the fence agent will exit with  code
217              1, otherwise it will exit with code 0.
218
219
220       metadata
221              Print XML metadata to standard output.
222
223