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
52
53       -D, --debug-file=[debugfile]
54              Write debug information to given file
55
56       -V, --version
57              Display version information and exit
58
59       -h, --help
60              Display help and exit
61
62       -C, --separator=[char]
63              Separator for CSV created by 'list' operation (Default Value: ,)
64
65
66       --delay=[seconds]
67              Wait X seconds before fencing  is  started  (Default  Value:  0)
68
69
70       --login-timeout=[seconds]
71              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
72
73
74       --power-timeout=[seconds]
75              Test X seconds for status change after  ON/OFF  (Default  Value:
76              20)
77
78       --power-wait=[seconds]
79              Wait X seconds after issuing ON/OFF (Default Value: 0)
80
81       --shell-timeout=[seconds]
82              Wait  X  seconds  for  cmd prompt after issuing command (Default
83              Value: 3)
84
85       --retry-on=[attempts]
86              Count of attempts to retry power on (Default Value: 1)
87
88

ACTIONS

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

STDIN PARAMETERS

122
123
124       action Fencing action (Default Value: reboot)
125
126       password
127              Login password or passphrase Obsoletes: passwd
128
129       password_script
130              Script  to  run  to  retrieve  password Obsoletes: passwd_script
131
132
133       plug   Physical plug  number  on  device,  UUID  or  identification  of
134              machine This parameter is always required. Obsoletes: port
135
136
137       session_url
138              URL  to  connect  to  XenServer  on  This  parameter  is  always
139              required.
140
141       username
142              Login name Obsoletes: login
143
144       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
145              file or logging to syslog.
146
147       verbose
148              Verbose mode
149
150       debug_file
151              Write debug information to given file Obsoletes: debug
152
153       version
154              Display version information and exit
155
156       help   Display help and exit
157
158       separator
159              Separator for CSV created by 'list' operation (Default Value: ,)
160
161
162       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
163
164
165       login_timeout
166              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
167
168
169       power_timeout
170              Test  X  seconds  for status change after ON/OFF (Default Value:
171              20)
172
173       power_wait
174              Wait X seconds after issuing ON/OFF (Default Value: 0)
175
176       shell_timeout
177              Wait X seconds for cmd prompt  after  issuing  command  (Default
178              Value: 3)
179
180       retry_on
181              Count of attempts to retry power on (Default Value: 1)
182
183
184
185fence_xenapi (Fence Agent)        2009-10-20                    FENCE_AGENT(8)
Impressum