Data Object - HostPatchManagerStatus

Property of
HostPatchManagerResult
Returned by
ScanHostPatch_Task
Extends
DynamicData
See also
HostPatchManagerStatusPrerequisitePatch
Since
VI API 2.5

Data Object Description

Properties

Name Type Description
applicablexsd:boolean

Whether or not this update is applicable to this host. An update may not be applicable to the ESX host for many reasons--for example, it is obsolete, it conflicts with other installed patches or libraries, and so on. The reason shows some of the reasons why the update is not applicable. An update could be inapplicable with no reason listed. This is because the prerequisite install state is not correct. For example, update A is one of the prerequisites of update B. B not only requires A to be installed, but also requires the host is rebooted after A is installed. When A is installed and the host has not been restarted after the installation, B will not be applicable. In such a case, the scan on both updates A and B would yield a whole picture of the update applicable status.
idxsd:string

Unique identifier for this update.
installedxsd:boolean

Whether the update is installed on the server.
installState*xsd:string[]

The installation state of the update. Unset if the update is not installed on the server.
See HostPatchManagerInstallState

integrity*xsd:string

The integrity status of the update's metadata. The value would be unset if the integrity status is unknown to the server.
See HostPatchManagerIntegrityStatus

prerequisitePatch*HostPatchManagerStatusPrerequisitePatch[]

Prerequisite update.
reason*xsd:string[]

Possible reasons why an update is not applicable to the ESX host.
See HostPatchManagerReason

reconnectRequiredxsd:boolean

Whether or not this update requires caller to reconnect to the host. This is usually because the update is on the agent that running on the host, the agent would thus be restarted when the update is applied. Caller can reconnect (and possibly relogin) to the host after the agent has been restarted.
restartRequiredxsd:boolean

Whether or not this update requires a host restart to take effect.
supersededPatchIds*xsd:string[]

Patches that are superseded by this update.
vmOffRequiredxsd:boolean

Whether or not this update requires the host in maintenance mode.
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition