summaryrefslogtreecommitdiffstats
path: root/tests/data/metadata/fence_virsh.xml
blob: 82fe9b6d128c19454a53620b33422045cfc98b17 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<?xml version="1.0" ?>
<resource-agent name="fence_virsh" shortdesc="Fence agent for virsh" >
<longdesc>fence_virsh is an I/O Fencing agent which can be used with the virtual machines managed by libvirt. It logs via ssh to a dom0 and there run virsh command, which does all work. 

By default, virsh needs root account to do properly work. So you must allow ssh login in your sshd_config.</longdesc>
<vendor-url>http://libvirt.org</vendor-url>
<parameters>
	<parameter name="action" unique="0" required="1">
		<getopt mixed="-o, --action=[action]" />
		<content type="string" default="reboot"  />
		<shortdesc lang="en">Fencing action</shortdesc>
	</parameter>
	<parameter name="cmd_prompt" unique="0" required="0" deprecated="1">
		<getopt mixed="-c, --command-prompt=[prompt]" />
		<content type="string" default="[&apos;\\[EXPECT\\]#&apos;]"  />
		<shortdesc lang="en">Force Python regex for command prompt</shortdesc>
	</parameter>
	<parameter name="command_prompt" unique="0" required="0" obsoletes="cmd_prompt">
		<getopt mixed="-c, --command-prompt=[prompt]" />
		<content type="string" default="[&apos;\\[EXPECT\\]#&apos;]"  />
		<shortdesc lang="en">Force Python regex for command prompt</shortdesc>
	</parameter>
	<parameter name="identity_file" unique="0" required="0">
		<getopt mixed="-k, --identity-file=[filename]" />
		<shortdesc lang="en">Identity file (private key) for SSH</shortdesc>
	</parameter>
	<parameter name="inet4_only" unique="0" required="0">
		<getopt mixed="-4, --inet4-only" />
		<content type="boolean"  />
		<shortdesc lang="en">Forces agent to use IPv4 addresses only</shortdesc>
	</parameter>
	<parameter name="inet6_only" unique="0" required="0">
		<getopt mixed="-6, --inet6-only" />
		<content type="boolean"  />
		<shortdesc lang="en">Forces agent to use IPv6 addresses only</shortdesc>
	</parameter>
	<parameter name="ip" unique="0" required="1" obsoletes="ipaddr">
		<getopt mixed="-a, --ip=[ip]" />
		<content type="string"  />
		<shortdesc lang="en">IP address or hostname of fencing device</shortdesc>
	</parameter>
	<parameter name="ipaddr" unique="0" required="1" deprecated="1">
		<getopt mixed="-a, --ip=[ip]" />
		<content type="string"  />
		<shortdesc lang="en">IP address or hostname of fencing device</shortdesc>
	</parameter>
	<parameter name="ipport" unique="0" required="0">
		<getopt mixed="-u, --ipport=[port]" />
		<content type="integer" default="22"  />
		<shortdesc lang="en">TCP/UDP port to use for connection with device</shortdesc>
	</parameter>
	<parameter name="login" unique="0" required="1" deprecated="1">
		<getopt mixed="-l, --username=[name]" />
		<content type="string"  />
		<shortdesc lang="en">Login name</shortdesc>
	</parameter>
	<parameter name="passwd" unique="0" required="0" deprecated="1">
		<getopt mixed="-p, --password=[password]" />
		<content type="string"  />
		<shortdesc lang="en">Login password or passphrase</shortdesc>
	</parameter>
	<parameter name="passwd_script" unique="0" required="0" deprecated="1">
		<getopt mixed="-S, --password-script=[script]" />
		<content type="string"  />
		<shortdesc lang="en">Script to run to retrieve password</shortdesc>
	</parameter>
	<parameter name="password" unique="0" required="0" obsoletes="passwd">
		<getopt mixed="-p, --password=[password]" />
		<content type="string"  />
		<shortdesc lang="en">Login password or passphrase</shortdesc>
	</parameter>
	<parameter name="password_script" unique="0" required="0" obsoletes="passwd_script">
		<getopt mixed="-S, --password-script=[script]" />
		<content type="string"  />
		<shortdesc lang="en">Script to run to retrieve password</shortdesc>
	</parameter>
	<parameter name="plug" unique="0" required="1" obsoletes="port">
		<getopt mixed="-n, --plug=[id]" />
		<content type="string"  />
		<shortdesc lang="en">Physical plug number on device, UUID or identification of machine</shortdesc>
	</parameter>
	<parameter name="port" unique="0" required="1" deprecated="1">
		<getopt mixed="-n, --plug=[id]" />
		<content type="string"  />
		<shortdesc lang="en">Physical plug number on device, UUID or identification of machine</shortdesc>
	</parameter>
	<parameter name="secure" unique="0" required="0" deprecated="1">
		<getopt mixed="-x, --ssh" />
		<content type="boolean" default="1"  />
		<shortdesc lang="en">Use SSH connection</shortdesc>
	</parameter>
	<parameter name="ssh" unique="0" required="0" obsoletes="secure">
		<getopt mixed="-x, --ssh" />
		<content type="boolean" default="1"  />
		<shortdesc lang="en">Use SSH connection</shortdesc>
	</parameter>
	<parameter name="ssh_options" unique="0" required="0">
		<getopt mixed="--ssh-options=[options]" />
		<content type="string" default="-t &apos;/bin/bash -c &quot;PS1=\\[EXPECT\\]# /bin/bash --noprofile --norc&quot;&apos;"  />
		<shortdesc lang="en">SSH options to use</shortdesc>
	</parameter>
	<parameter name="username" unique="0" required="1" obsoletes="login">
		<getopt mixed="-l, --username=[name]" />
		<content type="string"  />
		<shortdesc lang="en">Login name</shortdesc>
	</parameter>
	<parameter name="quiet" unique="0" required="0">
		<getopt mixed="-q, --quiet" />
		<content type="boolean"  />
		<shortdesc lang="en">Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.</shortdesc>
	</parameter>
	<parameter name="verbose" unique="0" required="0">
		<getopt mixed="-v, --verbose" />
		<content type="boolean"  />
		<shortdesc lang="en">Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.</shortdesc>
	</parameter>
	<parameter name="verbose_level" unique="0" required="0">
		<getopt mixed="--verbose-level" />
		<content type="integer"  />
		<shortdesc lang="en">Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).</shortdesc>
	</parameter>
	<parameter name="debug" unique="0" required="0" deprecated="1">
		<getopt mixed="-D, --debug-file=[debugfile]" />
		<content type="string"  />
		<shortdesc lang="en">Write debug information to given file</shortdesc>
	</parameter>
	<parameter name="debug_file" unique="0" required="0" obsoletes="debug">
		<getopt mixed="-D, --debug-file=[debugfile]" />
		<shortdesc lang="en">Write debug information to given file</shortdesc>
	</parameter>
	<parameter name="version" unique="0" required="0">
		<getopt mixed="-V, --version" />
		<content type="boolean"  />
		<shortdesc lang="en">Display version information and exit</shortdesc>
	</parameter>
	<parameter name="help" unique="0" required="0">
		<getopt mixed="-h, --help" />
		<content type="boolean"  />
		<shortdesc lang="en">Display help and exit</shortdesc>
	</parameter>
	<parameter name="plug_separator" unique="0" required="0">
		<getopt mixed="--plug-separator=[char]" />
		<content type="string" default=","  />
		<shortdesc lang="en">Separator for plug parameter when specifying more than 1 plug</shortdesc>
	</parameter>
	<parameter name="separator" unique="0" required="0">
		<getopt mixed="-C, --separator=[char]" />
		<content type="string" default=","  />
		<shortdesc lang="en">Separator for CSV created by 'list' operation</shortdesc>
	</parameter>
	<parameter name="delay" unique="0" required="0">
		<getopt mixed="--delay=[seconds]" />
		<content type="second" default="0"  />
		<shortdesc lang="en">Wait X seconds before fencing is started</shortdesc>
	</parameter>
	<parameter name="disable_timeout" unique="0" required="0">
		<getopt mixed="--disable-timeout=[true/false]" />
		<content type="string"  />
		<shortdesc lang="en">Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)</shortdesc>
	</parameter>
	<parameter name="login_timeout" unique="0" required="0">
		<getopt mixed="--login-timeout=[seconds]" />
		<content type="second" default="5"  />
		<shortdesc lang="en">Wait X seconds for cmd prompt after login</shortdesc>
	</parameter>
	<parameter name="missing_as_off" unique="0" required="0">
		<getopt mixed="--missing-as-off" />
		<content type="boolean"  />
		<shortdesc lang="en">Missing port returns OFF instead of failure</shortdesc>
	</parameter>
	<parameter name="power_timeout" unique="0" required="0">
		<getopt mixed="--power-timeout=[seconds]" />
		<content type="second" default="20"  />
		<shortdesc lang="en">Test X seconds for status change after ON/OFF</shortdesc>
	</parameter>
	<parameter name="power_wait" unique="0" required="0">
		<getopt mixed="--power-wait=[seconds]" />
		<content type="second" default="0"  />
		<shortdesc lang="en">Wait X seconds after issuing ON/OFF</shortdesc>
	</parameter>
	<parameter name="shell_timeout" unique="0" required="0">
		<getopt mixed="--shell-timeout=[seconds]" />
		<content type="second" default="3"  />
		<shortdesc lang="en">Wait X seconds for cmd prompt after issuing command</shortdesc>
	</parameter>
	<parameter name="stonith_status_sleep" unique="0" required="0">
		<getopt mixed="--stonith-status-sleep=[seconds]" />
		<content type="second" default="1"  />
		<shortdesc lang="en">Sleep X seconds between status calls during a STONITH action</shortdesc>
	</parameter>
	<parameter name="retry_on" unique="0" required="0">
		<getopt mixed="--retry-on=[attempts]" />
		<content type="integer" default="1"  />
		<shortdesc lang="en">Count of attempts to retry power on</shortdesc>
	</parameter>
	<parameter name="sudo" unique="0" required="0" deprecated="1">
		<getopt mixed="--use-sudo" />
		<content type="boolean"  />
		<shortdesc lang="en">Use sudo (without password) when calling 3rd party software</shortdesc>
	</parameter>
	<parameter name="use_sudo" unique="0" required="0" obsoletes="sudo">
		<getopt mixed="--use-sudo" />
		<content type="boolean"  />
		<shortdesc lang="en">Use sudo (without password) when calling 3rd party software</shortdesc>
	</parameter>
	<parameter name="ssh_path" unique="0" required="0">
		<getopt mixed="--ssh-path=[path]" />
		<shortdesc lang="en">Path to ssh binary</shortdesc>
	</parameter>
	<parameter name="sudo_path" unique="0" required="0">
		<getopt mixed="--sudo-path=[path]" />
		<shortdesc lang="en">Path to sudo binary</shortdesc>
	</parameter>
</parameters>
<actions>
	<action name="on" automatic="0"/>
	<action name="off" />
	<action name="reboot" />
	<action name="status" />
	<action name="list" />
	<action name="list-status" />
	<action name="monitor" />
	<action name="metadata" />
	<action name="manpage" />
	<action name="validate-all" />
</actions>
</resource-agent>