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

NAME

7       fence_vmware_soap - Fence agent for VMWare over SOAP API
8

DESCRIPTION

10       fence_vmware_soap  is  an  I/O Fencing agent which can be used with the
11       virtual machines managed by VMWare products that have SOAP API v4.1+.
12
13       Name of virtual machine (-n / port) has to be used  in  inventory  path
14       format   (e.g.  /datacenter/vm/Discovered  virtual  machine/myMachine).
15       Alternatively you can use UUID (-U / uuid) to access virtual machine.
16
17       fence_vmware_soap accepts options on the command line as well  as  from
18       stdin.  Fenced  sends parameters through stdin when it execs the agent.
19       fence_vmware_soap can be run by itself with command line options.  This
20       is useful for testing and for turning outlets on or off from scripts.
21
22       Vendor URL: http://www.vmware.com
23

PARAMETERS

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

ACTIONS

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

STDIN PARAMETERS

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