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       fence_virt accepts options on the command line as well as  from  stdin.
14       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
15       fence_virt can be run by itself with command  line  options.   This  is
16       useful for testing and for turning outlets on or off from scripts.
17
18       Vendor URL: https://libvirt.org
19

PARAMETERS

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

ACTIONS

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

STDIN PARAMETERS

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