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

NAME

7       fence_virt - Fence agent for virtual machines
8

DESCRIPTION

10       fence_virt  is  an I/O Fencing agent which can be used with virtual ma‐
11       chines.
12
13       NOTE: reboot-action does not power on nodes that are powered off.
14
15       fence_virt accepts options on the command line as well as  from  stdin.
16       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
17       fence_virt can be run by itself with command  line  options.   This  is
18       useful for testing and for turning outlets on or off from scripts.
19
20       Vendor URL: https://libvirt.org
21

PARAMETERS

23
24
25       -d     Specify (stdin) or increment (command line) debug level
26
27       -D     Serial  device  (default=/dev/ttyS1) (Default Value: /dev/ttyS1)
28
29
30       -P     Serial   Parameters   (default=115200,8N1)    (Default    Value:
31              115200,8N1)
32
33       -A     VM  Channel  IP  address  (default=10.0.2.179)  (Default  Value:
34              10.0.2.179)
35
36       -p     TCP, Multicast, VMChannel, or VM socket port (default=1229) (De‐
37              fault Value: 1229)
38
39       -n     Virtual  Machine (domain name) to fence This parameter is always
40              required.
41
42       -o     Fencing action (null, off, on, [reboot], status, list, list-sta‐
43              tus,  monitor,  validate-all,  metadata) (Default Value: reboot)
44
45
46       -t     Fencing timeout (in seconds;  default=30)  (Default  Value:  30)
47
48
49       -T     IP  address  to connect to in TCP mode (default=127.0.0.1 / ::1)
50              (Default Value: 127.0.0.1)
51
52       -S     vm socket CID to connect to in vsock  mode  (Default  Value:  2)
53
54
55       -C     Authentication  (none,  sha1,  [sha256], sha512) (Default Value:
56              sha256)
57
58       -c     Packet hash strength (none,  sha1,  [sha256],  sha512)  (Default
59              Value: sha256)
60
61       -k     Shared  key  file  (default=/etc/cluster/fence_xvm.key) (Default
62              Value: /etc/cluster/fence_xvm.key)
63
64       -w     Fencing delay (in seconds; default=0) (Default Value: 0)
65
66

ACTIONS

68
69
70       null
71               The operational behavior of this is not known.
72
73       on     Power on machine.
74
75       off    Power off machine.
76
77       reboot Reboot machine.
78
79       metadata
80              Display the XML metadata describing this resource.
81
82       status This returns the status of the plug/virtual machine.
83
84       monitor
85              Check the health of fence device
86
87       list   List available plugs with aliases/virtual machines if  there  is
88              support for more then one device. Returns N/A otherwise.
89
90       list-status
91              List  available  plugs  with  aliases/virtual machines and their
92              power state if it can be obtained without  additional  commands.
93
94
95       validate-all
96              Validate if all required parameters are entered.
97
98

STDIN PARAMETERS

100
101
102       debug  Specify (stdin) or increment (command line) debug level
103
104       serial_device
105              Serial  device  (default=/dev/ttyS1) (Default Value: /dev/ttyS1)
106
107
108       serial_params
109              Serial   Parameters   (default=115200,8N1)    (Default    Value:
110              115200,8N1)
111
112       channel_address
113              VM  Channel  IP  address  (default=10.0.2.179)  (Default  Value:
114              10.0.2.179)
115
116       ipport TCP, Multicast, VMChannel, or VM socket port (default=1229) (De‐
117              fault Value: 1229)
118
119       plug   Virtual  Machine (domain name) to fence This parameter is always
120              required. Obsoletes: port
121
122       action Fencing action (null, off, on, [reboot], status, list, list-sta‐
123              tus,  monitor,  validate-all,  metadata) (Default Value: reboot)
124
125
126       timeout
127              Fencing timeout (in seconds;  default=30)  (Default  Value:  30)
128
129
130       ipaddr IP  address  to connect to in TCP mode (default=127.0.0.1 / ::1)
131              (Default Value: 127.0.0.1)
132
133       vsock  vm socket CID to connect to in vsock  mode  (Default  Value:  2)
134
135
136       auth   Authentication  (none,  sha1,  [sha256], sha512) (Default Value:
137              sha256)
138
139       hash   Packet hash strength (none,  sha1,  [sha256],  sha512)  (Default
140              Value: sha256)
141
142       key_file
143              Shared  key  file  (default=/etc/cluster/fence_xvm.key) (Default
144              Value: /etc/cluster/fence_xvm.key)
145
146       delay  Fencing delay (in seconds; default=0) (Default Value: 0)
147
148
149
150fence_virt (Fence Agent)          2009-10-20                    FENCE_AGENT(8)
Impressum