1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
|
.. _str: https://docs.python.org/2/library/stdtypes.html
.. _Task: ../../vim/Task.rst
.. _bool: https://docs.python.org/2/library/stdtypes.html
.. _vim.Task: ../../vim/Task.rst
.. _vSphere API 4.0: ../../vim/version.rst#vimversionversion5
.. _PatchInstallFailed: ../../vim/fault/PatchInstallFailed.rst
.. _vim.fault.NoDiskSpace: ../../vim/fault/NoDiskSpace.rst
.. _vim.fault.InvalidState: ../../vim/fault/InvalidState.rst
.. _vim.fault.TaskInProgress: ../../vim/fault/TaskInProgress.rst
.. _vim.fault.RebootRequired: ../../vim/fault/RebootRequired.rst
.. _vmodl.fault.RequestCanceled: ../../vmodl/fault/RequestCanceled.rst
.. _vim.host.PatchManager.Result: ../../vim/host/PatchManager/Result.rst
.. _vim.fault.PatchNotApplicable: ../../vim/fault/PatchNotApplicable.rst
.. _vim.host.PatchManager.Status: ../../vim/host/PatchManager/Status.rst
.. _vim.fault.PatchInstallFailed: ../../vim/fault/PatchInstallFailed.rst
.. _vim.fault.PlatformConfigFault: ../../vim/fault/PlatformConfigFault.rst
.. _vim.host.PatchManager.Locator: ../../vim/host/PatchManager/Locator.rst
.. _vim.fault.PatchMetadataInvalid: ../../vim/fault/PatchMetadataInvalid.rst
.. _vim.fault.PatchBinariesNotFound: ../../vim/fault/PatchBinariesNotFound.rst
.. _vim.host.PatchManager.PatchManagerOperationSpec: ../../vim/host/PatchManager/PatchManagerOperationSpec.rst
vim.host.PatchManager
=====================
This managed object is the interface for scanning and patching an ESX server. VMware publishes updates through its external website. A patch update is synonymous with a bulletin. An update may contain many individual patch binaries, but its installation and uninstallation are atomic.
Attributes
----------
Methods
-------
CheckHostPatch(metaUrls, bundleUrls, spec):
Check the list of metadata and returns the dependency, obsolete and conflict information The operation is cancelable through the returned `Task`_ object. No integrity checks are performed on the metadata.
since: `vSphere API 4.0`_
Privilege:
System.Read
Args:
metaUrls (`str`_, optional):
a list of urls pointing to metadata.zip.
bundleUrls (`str`_, optional):
a list of urls pointing to an "offline" bundle. It is not supported in 5.0 or later.
spec (`vim.host.PatchManager.PatchManagerOperationSpec`_, optional):
Returns:
`vim.Task`_:
Raises:
`vmodl.fault.RequestCanceled`_:
if the operation is canceled.
`vim.fault.InvalidState`_:
If the feature cannot be supported on the platform, potentially because the hardware configuration does not support it.
`vim.fault.TaskInProgress`_:
if there is already a patch installation in progress.
`vim.fault.PlatformConfigFault`_:
if any error occurs during the operation. More detailed information will be returned within the payload of the exception as xml string.
ScanHostPatch(repository, updateID):
Scan the host for the patch status. The operation is cancelable through the returned `Task`_ object. Integrity checks are performed on the metadata only during the scan operation.
Privilege:
System.Read
Args:
repository (`vim.host.PatchManager.Locator`_):
Location of the repository that contains the bulletin depot. The depot must be organized as a flat collection of bulletins with each one being a folder named after the bulletin ID. Each folder must contain the full update metadata.
updateID (`str`_, optional):
The updates to scan. Wildcards can be used to specify the update IDs. The wildcards will be expanded to include all updates whose IDs match the specified wildcard and whose metadata is available in the repository. Specifying no update is equivalent to a wildcard "*". In this case all updates available in the repository will be scanned.
Returns:
`vim.Task`_:
Raises:
`vmodl.fault.RequestCanceled`_:
if the operation is canceled.
`vim.fault.PatchMetadataInvalid`_:
if query required metadata is invalid--for example, it is not found in the repository, is corrupted and so on. Typically a more specific subclass of PatchMetadataInvalid is thrown.
`vim.fault.PlatformConfigFault`_:
if there is any error in the repository access, metadata download, repository level integrity check, or reading the metadata. See `text`_ for specific details.
ScanHostPatchV2(metaUrls, bundleUrls, spec):
Scan the host for the patch status. The operation is cancelable through the returned `Task`_ object. Integrity checks are performed on the metadata only during the scan operation.
since: `vSphere API 4.0`_
Privilege:
System.Read
Args:
metaUrls (`str`_, optional):
a list of urls pointing to metadata.zip.
bundleUrls (`str`_, optional):
a list of urls pointing to an "offline" bundle. It is not supported in 5.0 or later.
spec (`vim.host.PatchManager.PatchManagerOperationSpec`_, optional):
Returns:
`vim.Task`_:
Raises:
`vmodl.fault.RequestCanceled`_:
if the operation is canceled.
`vim.fault.InvalidState`_:
If the feature cannot be supported on the platform, potentially because the hardware configuration does not support it.
`vim.fault.TaskInProgress`_:
if there is already a patch installation in progress.
`vim.fault.PlatformConfigFault`_:
if there is any error in the repository access, metadata download, repository level integrity check, or reading the metadata. See `text`_ for specific details.
StageHostPatch(metaUrls, bundleUrls, vibUrls, spec):
Stage the vib files to esx local location and possibly do some run time check.
since: `vSphere API 4.0`_
Privilege:
Host.Config.Patch
Args:
metaUrls (`str`_, optional):
A list of urls pointing to metadata.zip.
bundleUrls (`str`_, optional):
a list of urls pointing to an "offline" bundle. It is not supported in 5.0 or later.
vibUrls (`str`_, optional):
The urls of update binary files to be staged.
spec (`vim.host.PatchManager.PatchManagerOperationSpec`_, optional):
Returns:
`vim.Task`_:
Raises:
`vmodl.fault.RequestCanceled`_:
if the operation is canceled.
`vim.fault.InvalidState`_:
If the feature cannot be supported on the platform, potentially because the hardware configuration does not support it.
`vim.fault.TaskInProgress`_:
if there is already a patch installation in progress.
`vim.fault.PlatformConfigFault`_:
if any error occurs during the operation. More detailed information will be returned within the payload of the exception as xml string.
InstallHostPatch(repository, updateID, force):
Patch the host. The operation is not cancelable. If the patch installation failed, an atomic rollback of the installation will be attempted. Manual rollback is required if the atomic rollback failed, see `PatchInstallFailed`_ for details.
Privilege:
Host.Config.Patch
Args:
repository (`vim.host.PatchManager.Locator`_):
Location of the repository that contains the bulletin depot. The depot must be organized as a flat collection of bulletins with each one being a folder named after the bulletin ID. Each folder must contain both update metadata and required binaries.
updateID (`str`_):
The update to be installed on the host.
force (`bool`_, optional):
Specify whether to force reinstall an update. By default, installing an already-installed update would fail with the `PatchAlreadyInstalled`_ fault. If force is set to true, the update will be forcifully reinstalled, thus overwriting the already installed update.
Returns:
`vim.Task`_:
Raises:
`vim.fault.PatchMetadataInvalid`_:
if the requried metadata is invalid--for example, it is not found in the repository, is corrupted and so on. Typically a more specific subclass of PatchMetadataInvalid is thrown.
`vim.fault.PatchBinariesNotFound`_:
if required update related binaries were not available.
`vim.fault.PatchNotApplicable`_:
if the patch is not applicable. Typically a more specific subclass of PatchNotApplicable is thrown to indicate a specific problem--for example, PatchSuperseded if the patch is superseded, MissingDependency if required patch or libraries are not installed, AlreadyInstalled if the patch is already installed.
`vim.fault.NoDiskSpace`_:
if the update can not be installed because there is insufficent disk space for the installation, including temporary space used for rollback.
`vim.fault.PatchInstallFailed`_:
if the installation failed, `text`_ has details of the failure. Automatic rollback might have succeeded or failed.
`vim.fault.RebootRequired`_:
if the update cannot be installed without restarting the host. This might occur on account of a prior update installation which needed to be installed separately from other updates.
`vim.fault.InvalidState`_:
if the host is not in maintenance mode but the patch install requires all virtual machines to be powered off.
`vim.fault.TaskInProgress`_:
if there is already a patch installation in progress.
InstallHostPatchV2(metaUrls, bundleUrls, vibUrls, spec):
Patch the host. The operation is not cancelable. If the patch installation failed, an atomic rollback of the installation will be attempted. Manual rollback is required if the atomic rollback failed, see `PatchInstallFailed`_ for details.
since: `vSphere API 4.0`_
Privilege:
Host.Config.Patch
Args:
metaUrls (`str`_, optional):
A list of urls pointing to metadata.zip.
bundleUrls (`str`_, optional):
a list of urls pointing to an "offline" bundle. It is not supported in 5.0 or later.
vibUrls (`str`_, optional):
The urls of update binary files to be installed.
spec (`vim.host.PatchManager.PatchManagerOperationSpec`_, optional):
Returns:
`vim.Task`_:
Raises:
`vmodl.fault.RequestCanceled`_:
Thrown if the operation is canceled.
`vim.fault.InvalidState`_:
If the feature cannot be supported on the platform, potentially because the hardware configuration does not support it.
`vim.fault.TaskInProgress`_:
if there is already a patch installation in progress.
`vim.fault.PlatformConfigFault`_:
vim.fault.PlatformConfigFault
UninstallHostPatch(bulletinIds, spec):
Uninstall patch from the host. The operation is not cancelable.
since: `vSphere API 4.0`_
Privilege:
Host.Config.Patch
Args:
bulletinIds (`str`_, optional):
A list of bulletin IDs to be removed.
spec (`vim.host.PatchManager.PatchManagerOperationSpec`_, optional):
Returns:
`vim.Task`_:
Raises:
`vim.fault.InvalidState`_:
If the feature cannot be supported on the platform, potentially because the hardware configuration does not support it.
`vim.fault.TaskInProgress`_:
if there is already a patch installation in progress.
`vim.fault.PlatformConfigFault`_:
vim.fault.PlatformConfigFault
QueryHostPatch(spec):
Query the host for installed bulletins.
since: `vSphere API 4.0`_
Privilege:
System.Read
Args:
spec (`vim.host.PatchManager.PatchManagerOperationSpec`_, optional):
Returns:
`vim.Task`_:
Raises:
`vmodl.fault.RequestCanceled`_:
vmodl.fault.RequestCanceled
`vim.fault.InvalidState`_:
If the bulletin ID did not exist.
`vim.fault.TaskInProgress`_:
if there is already a patch installation in progress.
`vim.fault.PlatformConfigFault`_:
vim.fault.PlatformConfigFault
|
