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
37              machine This parameter is always required.
38
39       -s, --session-url
40              URL  to  connect  to  XenServer  on  This  parameter  is  always
41              required.
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       --retry-on=[attempts]
97              Count of attempts to retry power on (Default Value: 1)
98
99

ACTIONS

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

STDIN PARAMETERS

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