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

NAME

7       fence_virsh - Fence agent for virsh
8

DESCRIPTION

10       fence_virsh  is an I/O Fencing agent which can be used with the virtual
11       machines managed by libvirt. It logs via ssh to a dom0  and  there  run
12       virsh command, which does all work.
13
14       By  default,  virsh needs root account to do properly work. So you must
15       allow ssh login in your sshd_config.
16
17       fence_virsh accepts options on the command line as well as from  stdin.
18       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
19       fence_virsh can be run by itself with command line  options.   This  is
20       useful for testing and for turning outlets on or off from scripts.
21
22

PARAMETERS

24
25
26       -o, --action=<action>
27              Fencing Action (Default Value: reboot)
28
29       -a, --ip=<ip>
30              IP Address or Hostname This parameter is always required.
31
32       -l, --username=<name>
33              Login Name This parameter is always required.
34
35       -p, --password=<password>
36              Login password or passphrase
37
38       -S, --password-script=<script>
39              Script to retrieve password
40
41       -x, --ssh
42              SSH connection (Default Value: true)
43
44       -k, --identity-file=<filename>
45              Identity file for ssh
46
47       -n, --plug=<id>
48              Physical  plug  number or name of virtual machine This parameter
49              is always required.
50
51       -4, --inet4-only
52              Forces agent to use IPv4 addresses only
53
54       -6, --inet6-only
55              Forces agent to use IPv6 addresses only
56
57       -u, --ipport=<port>
58              TCP port to use for connection with device
59
60       -v, --verbose
61              Verbose mode
62
63       -D, --debug-file=<debugfile>
64              Write debug information to given file
65
66       -V, --version
67              Display version information and exit
68
69       -h, --help
70              Display help and exit
71
72       -C, --separator=<char>
73              Separator for CSV created by operation list (Default  Value:  ,)
74
75
76       --power-timeout
77              Test  X  seconds  for status change after ON/OFF (Default Value:
78              20)
79
80       --shell-timeout
81              Wait X seconds for cmd prompt  after  issuing  command  (Default
82              Value: 3)
83
84       --login-timeout
85              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
86
87
88       --power-wait
89              Wait X seconds after issuing ON/OFF (Default Value: 0)
90
91       --delay
92              Wait X seconds before fencing  is  started  (Default  Value:  0)
93
94
95       --retry-on
96              Count of attempts to retry power on (Default Value: 1)
97
98

ACTIONS

100
101
102       on     Power on machine.
103
104       off    Power off machine.
105
106       reboot Reboot machine.
107
108       status This returns the status of the plug/virtual machine.
109
110       list   List  available  plugs with aliases/virtual machines if there is
111              support for more then one device. Returns N/A otherwise.
112
113       monitor
114              Check if fencing device is running. List available plugs/virtual
115              machines or get status of machine (if it does not support more).
116
117
118       metadata
119               The operational behavior of this is not known.
120
121

STDIN PARAMETERS

123
124
125       action Fencing Action (Default Value: reboot)
126
127       ipaddr IP Address or Hostname This parameter is always required.
128
129       login  Login Name This parameter is always required.
130
131       passwd Login password or passphrase
132
133       passwd_script
134              Script to retrieve password
135
136       secure SSH connection (Default Value: true)
137
138       identity_file
139              Identity file for ssh
140
141       port   Physical plug number or name of virtual machine  This  parameter
142              is always required.
143
144       inet4_only
145              Forces agent to use IPv4 addresses only
146
147       inet6_only
148              Forces agent to use IPv6 addresses only
149
150       ipport TCP port to use for connection with device
151
152       verbose
153              Verbose mode
154
155       debug  Write debug information to given file
156
157       version
158              Display version information and exit
159
160       help   Display help and exit
161
162       separator
163              Separator  for  CSV created by operation list (Default Value: ,)
164
165
166       power_timeout
167              Test X seconds for status change after  ON/OFF  (Default  Value:
168              20)
169
170       shell_timeout
171              Wait  X  seconds  for  cmd prompt after issuing command (Default
172              Value: 3)
173
174       login_timeout
175              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
176
177
178       power_wait
179              Wait X seconds after issuing ON/OFF (Default Value: 0)
180
181       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
182
183
184       retry_on
185              Count of attempts to retry power on (Default Value: 1)
186
187
188
189fence_virsh (Fence Agent)         2009-10-20                    FENCE_AGENT(8)