HostPatchManagerStatus

HostPatchManagerStatus

AllOf

This class requires all of the following:

DataObject

JSON Example

{
    "_typeName": "string",
    "id": "string",
    "applicable": false,
    "reason": [
        "string"
    ],
    "integrity": "string",
    "installed": false,
    "installState": [
        "string"
    ],
    "prerequisitePatch": [
        {
            "_typeName": "string",
            "id": "string",
            "installState": [
                "string"
            ]
        }
    ],
    "restartRequired": false,
    "reconnectRequired": false,
    "vmOffRequired": false,
    "supersededPatchIds": [
        "string"
    ]
}

string

id

Required

Unique identifier for this update.

boolean

applicable

Required

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.

array of string

reason

Optional

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

See also HostPatchManagerReasonEnum.

string

integrity

Optional

The integrity status of the update's metadata.

The value would be unset if the integrity status is unknown to the server.

See also HostPatchManagerIntegrityStatusEnum.

boolean

installed

Required

Whether the update is installed on the server.

array of string

installState

Optional

The installation state of the update.

Unset if the update is not installed on the server.

See also HostPatchManagerInstallStateEnum.

array of HostPatchManagerStatusPrerequisitePatch

prerequisitePatch

Optional

Prerequisite update.

boolean

restartRequired

Required

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

boolean

reconnectRequired

Required

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.

boolean

vmOffRequired

Required

Whether or not this update requires the host in maintenance mode.

array of string

supersededPatchIds

Optional

Patches that are superseded by this update.

Property Of

ArrayOfHostPatchManagerStatus

HostPatchManagerResult