Data Object Description

Properties

Name	Type	Description
applicable	xsd: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.
id	xsd:string	Unique identifier for this update.
installed	xsd: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
reconnectRequired	xsd: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.
restartRequired	xsd:boolean	Whether or not this update requires a host restart to take effect.
supersededPatchIds*	xsd:string[]	Patches that are superseded by this update.
vmOffRequired	xsd:boolean	Whether or not this update requires the host in maintenance mode.
Properties inherited from DynamicData
dynamicProperty, dynamicType

Name

Type

Description

applicable

xsd: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.

xsd:string

Unique identifier for this update.

installed

xsd: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

reconnectRequired

xsd: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.

restartRequired

xsd:boolean

Whether or not this update requires a host restart to take effect.

supersededPatchIds*

xsd:string[]

Patches that are superseded by this update.

vmOffRequired

xsd: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

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostPatchManagerStatus">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="id" type="xsd:string"/>
                     <element name="applicable" type="xsd:boolean"/>
                     <element name="reason" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="integrity" type="xsd:string" minOccurs="0"/>
                     <element name="installed" type="xsd:boolean"/>
                     <element name="installState" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="prerequisitePatch" type="vim25:HostPatchManagerStatusPrerequisitePatch" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="restartRequired" type="xsd:boolean"/>
                     <element name="reconnectRequired" type="xsd:boolean"/>
                     <element name="vmOffRequired" type="xsd:boolean"/>
                     <element name="supersededPatchIds" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - HostPatchManagerStatus

Data Object Description