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       --plug-separator=[char]
70              Separator  for  plug  parameter when specifying more than 1 plug
71              (Default Value: ,)
72
73       -C, --separator=[char]
74              Separator for CSV created by 'list' operation (Default Value: ,)
75
76
77       --delay=[seconds]
78              Wait  X  seconds  before  fencing  is started (Default Value: 0)
79
80
81       --disable-timeout=[true/false]
82              Disable timeout (true/false) (default: true when run from  Pace‐
83              maker 2.0+)
84
85       --login-timeout=[seconds]
86              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
87
88
89       --power-timeout=[seconds]
90              Test X seconds for status change after  ON/OFF  (Default  Value:
91              20)
92
93       --power-wait=[seconds]
94              Wait X seconds after issuing ON/OFF (Default Value: 0)
95
96       --shell-timeout=[seconds]
97              Wait  X  seconds  for  cmd prompt after issuing command (Default
98              Value: 3)
99
100       --stonith-status-sleep=[seconds]
101              Sleep X seconds between status calls  during  a  STONITH  action
102              (Default Value: 1)
103
104       --retry-on=[attempts]
105              Count of attempts to retry power on (Default Value: 1)
106
107

ACTIONS

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

STDIN PARAMETERS

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