VmToolsInfo

The Tools.Info structure describes the VMWare Tools properties of a virtual machine.


Properties

Required Property Name Type Description
required auto_update_supported boolean

Set if the virtual machine supports auto-upgrading Tools via Tools.UpgradePolicy.

optional error object

Error that happened, if any, during last attempt to upgrade or install Tools. Only set if a the last Tools install or upgrade attempt failed.

optional install_attempt_count integer

Number of attempts that have been made to install or upgrade the version of Tools installed on this virtual machine. Only set if there was a recent Tools install or upgrade attempt.

optional install_type VmToolsToolsInstallType Enum

Current installation type of VMware Tools in the guest operating system. Only set if Tools install type is known.

required run_state VmToolsRunState Enum

Current run state of VMware Tools in the guest operating system.

required upgrade_policy VmToolsUpgradePolicy Enum

Tools upgrade policy setting for the virtual machine. Tools.UpgradePolicy

optional version string

Version of VMware Tools installed on the guest operating system. This is a human-readable value that should not be parsed. Only set if Tools is installed.

optional version_number integer

Version of VMware Tools installed on the guest operating system. Only set if Tools is installed. This is an integer constructed as follows: (((MJR) << 10) + ((MNR) << 5) + (REV)) Where MJR is tha major verson, MNR is the minor version and REV is the revision. Tools version = T Tools Version Major = MJR = (T / 1024) Tools Version Minor = MNR = ((T % 1024) / 32) Tools Version Revision = BASE = ((T % 1024) % 32) Tools actual version = MJR.MNR.REV

optional version_status VmToolsVersionStatus Enum

Current version status of VMware Tools in the guest operating system, if known. Only set if Tools version status is known.

JSON Example

{
    "auto_update_supported": false,
    "run_state": "enum",
    "upgrade_policy": "enum"
}
Feedback

Was this page helpful?