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

NAME

7       fence_xenapi  -  XenAPI  based fencing for the Citrix XenServer virtual
8       machines.
9

DESCRIPTION

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

PARAMETERS

24
25
26       -o, --action=<action>
27              Fencing Action (Default Value: reboot)
28
29       -l, --username=<name>
30              Login Name
31
32       -p, --password=<password>
33              Login password or passphrase
34
35       -S, --password-script=<script>
36              Script to retrieve password
37
38       -n, --plug=<id>
39              Physical  plug  number or name of virtual machine This parameter
40              is always required.
41
42       -s, --session-url
43              The  URL  of  the  XenServer  host.  This  parameter  is  always
44              required.
45
46       -U, --uuid
47              The UUID of the virtual machine to fence.
48
49       -v, --verbose
50              Verbose mode
51
52       -D, --debug-file=<debugfile>
53              Write debug information to given file
54
55       -V, --version
56              Display version information and exit
57
58       -h, --help
59              Display help and exit
60
61       -C, --separator=<char>
62              Separator  for  CSV created by operation list (Default Value: ,)
63
64
65       --power-timeout
66              Test X seconds for status change after  ON/OFF  (Default  Value:
67              20)
68
69       --shell-timeout
70              Wait  X  seconds  for  cmd prompt after issuing command (Default
71              Value: 3)
72
73       --login-timeout
74              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
75
76
77       --power-wait
78              Wait X seconds after issuing ON/OFF (Default Value: 0)
79
80       --delay
81              Wait  X  seconds  before  fencing  is started (Default Value: 0)
82
83
84       --retry-on
85              Count of attempts to retry power on (Default Value: 1)
86
87

ACTIONS

89
90
91       on     Power on machine.
92
93       off    Power off machine.
94
95       reboot Reboot machine.
96
97       status This returns the status of the plug/virtual machine.
98
99       list   List available plugs with aliases/virtual machines if  there  is
100              support for more then one device. Returns N/A otherwise.
101
102       monitor
103              Check if fencing device is running. List available plugs/virtual
104              machines or get status of machine (if it does not support more).
105
106
107       metadata
108               The operational behavior of this is not known.
109
110

STDIN PARAMETERS

112
113
114       action Fencing Action (Default Value: reboot)
115
116       login  Login Name
117
118       passwd Login password or passphrase
119
120       passwd_script
121              Script to retrieve password
122
123       port   Physical  plug  number or name of virtual machine This parameter
124              is always required.
125
126       session_url
127              The  URL  of  the  XenServer  host.  This  parameter  is  always
128              required.
129
130       uuid   The UUID of the virtual machine to fence.
131
132       verbose
133              Verbose mode
134
135       debug  Write debug information to given file
136
137       version
138              Display version information and exit
139
140       help   Display help and exit
141
142       separator
143              Separator  for  CSV created by operation list (Default Value: ,)
144
145
146       power_timeout
147              Test X seconds for status change after  ON/OFF  (Default  Value:
148              20)
149
150       shell_timeout
151              Wait  X  seconds  for  cmd prompt after issuing command (Default
152              Value: 3)
153
154       login_timeout
155              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
156
157
158       power_wait
159              Wait X seconds after issuing ON/OFF (Default Value: 0)
160
161       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
162
163
164       retry_on
165              Count of attempts to retry power on (Default Value: 1)
166
167
168
169fence_xenapi (Fence Agent)        2009-10-20                    FENCE_AGENT(8)
Impressum