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

NAME

7       fence_xenapi - Fence agent for Citrix XenServer over XenAPI
8

DESCRIPTION

10       fence_cxs  is  an  I/O Fencing agent used on Citrix XenServer hosts. It
11       uses the XenAPI, supplied by Citrix, to establish an XML-RPC session to
12       a XenServer host. Once the session is established, further XML-RPC com‐
13       mands are issued in order to switch on, switch off, restart  and  query
14       the status of virtual machines running on the host.
15
16       fence_xenapi accepts options on the command line as well as from stdin.
17       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
18       fence_xenapi  can  be run by itself with command line options.  This is
19       useful for testing and for turning outlets on or off from scripts.
20
21       Vendor URL: http://www.xenproject.org
22

PARAMETERS

24
25
26       -o, --action=[action]
27              Fencing action (Default Value: reboot)
28
29       -p, --password=[password]
30              Login password or passphrase
31
32       -S, --password-script=[script]
33              Script to run to retrieve password
34
35       -n, --plug=[id]
36              Physical plug number on device, UUID or  identification  of  ma‐
37              chine This parameter is always required.
38
39       -s, --session-url
40              URL  to  connect  to  XenServer  on This parameter is always re‐
41              quired.
42
43       -l, --username=[name]
44              Login name
45
46       -q, --quiet
47              Disable logging to stderr. Does not affect --verbose or --debug-
48              file or logging to syslog.
49
50       -v, --verbose
51              Verbose  mode.  Multiple  -v flags can be stacked on the command
52              line (e.g., -vvv) to increase verbosity.
53
54       --verbose-level
55              Level of debugging detail in output. Defaults to the  number  of
56              --verbose  flags  specified on the command line, or to 1 if ver‐
57              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
58
59
60       -D, --debug-file=[debugfile]
61              Write debug information to given file
62
63       -V, --version
64              Display version information and exit
65
66       -h, --help
67              Display help and exit
68
69       -C, --separator=[char]
70              Separator for CSV created by 'list' operation (Default Value: ,)
71
72
73       --delay=[seconds]
74              Wait X seconds before fencing  is  started  (Default  Value:  0)
75
76
77       --disable-timeout=[true/false]
78              Disable  timeout (true/false) (default: true when run from Pace‐
79              maker 2.0+)
80
81       --login-timeout=[seconds]
82              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
83
84
85       --power-timeout=[seconds]
86              Test  X  seconds  for status change after ON/OFF (Default Value:
87              20)
88
89       --power-wait=[seconds]
90              Wait X seconds after issuing ON/OFF (Default Value: 0)
91
92       --shell-timeout=[seconds]
93              Wait X seconds for cmd prompt  after  issuing  command  (Default
94              Value: 3)
95
96       --stonith-status-sleep=[seconds]
97              Sleep  X  seconds  between  status calls during a STONITH action
98              (Default Value: 1)
99
100       --retry-on=[attempts]
101              Count of attempts to retry power on (Default Value: 1)
102
103

ACTIONS

105
106
107       on     Power on machine.
108
109       off    Power off machine.
110
111       reboot Reboot machine.
112
113       status This returns the status of the plug/virtual machine.
114
115       list   List available plugs with aliases/virtual machines if  there  is
116              support for more then one device. Returns N/A otherwise.
117
118       list-status
119              List  available  plugs  with  aliases/virtual machines and their
120              power state if it can be obtained without  additional  commands.
121
122
123       monitor
124              Check the health of fence device
125
126       metadata
127              Display the XML metadata describing this resource.
128
129       manpage
130               The operational behavior of this is not known.
131
132       validate-all
133              Validate if all required parameters are entered.
134
135

STDIN PARAMETERS

137
138
139       action Fencing action (Default Value: reboot)
140
141       password
142              Login password or passphrase Obsoletes: passwd
143
144       password_script
145              Script  to  run  to  retrieve  password Obsoletes: passwd_script
146
147
148       plug   Physical plug number on device, UUID or  identification  of  ma‐
149              chine  This  parameter is always required. Obsoletes: port
150
151
152       session_url
153              URL to connect to XenServer on  This  parameter  is  always  re‐
154              quired.
155
156       username
157              Login name Obsoletes: login
158
159       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
160              file or logging to syslog.
161
162       verbose
163              Verbose mode. Multiple -v flags can be stacked  on  the  command
164              line (e.g., -vvv) to increase verbosity.
165
166       verbose_level
167              Level  of  debugging detail in output. Defaults to the number of
168              --verbose flags specified on the command line, or to 1  if  ver‐
169              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
170
171
172       debug_file
173              Write debug information to given file Obsoletes: debug
174
175       version
176              Display version information and exit
177
178       help   Display help and exit
179
180       separator
181              Separator for CSV created by 'list' operation (Default Value: ,)
182
183
184       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
185
186
187       disable_timeout
188              Disable timeout (true/false) (default: true when run from  Pace‐
189              maker 2.0+)
190
191       login_timeout
192              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
193
194
195       power_timeout
196              Test X seconds for status change after  ON/OFF  (Default  Value:
197              20)
198
199       power_wait
200              Wait X seconds after issuing ON/OFF (Default Value: 0)
201
202       shell_timeout
203              Wait  X  seconds  for  cmd prompt after issuing command (Default
204              Value: 3)
205
206       stonith_status_sleep
207              Sleep X seconds between status calls  during  a  STONITH  action
208              (Default Value: 1)
209
210       retry_on
211              Count of attempts to retry power on (Default Value: 1)
212
213
214
215fence_xenapi (Fence Agent)        2009-10-20                    FENCE_AGENT(8)