VmToolsInfo

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


Properties

boolean
auto_update_supported Required

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


run_state Required

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

Possible values are: NOT_RUNNINGRUNNINGEXECUTING_SCRIPTS


upgrade_policy Required

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

Possible values are: MANUALUPGRADE_AT_POWER_CYCLE


object
error Optional

Error that happened, if any, during last attempt to upgrade or install Tools. This field will be unset if a the last Tools install or upgrade attempt succeeded.


integer as int64
install_attempt_count Optional

Number of attempts that have been made to install or upgrade the version of Tools installed on this virtual machine. This field will be unset if there have been no Tools install or upgrade attempt.


install_type Optional

Current installation type of VMware Tools in the guest operating system. This field will be unset if the installation type is not known, for example if VMware Tools is too old to report the information.

Possible values are: UNKNOWNMSITAROSPOPEN_VM_TOOLS


string
version Optional

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


integer as int64
version_number Optional

Version of VMware Tools installed on the guest operating system. This field wil be unset if VMWare Tools is not 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


version_status Optional

Current version status of VMware Tools in the guest operating system, if known. This field will be unset if the version status is not known, for example if VMware Tools is too old to report the information.

Possible values are: NOT_INSTALLEDCURRENTUNMANAGEDTOO_OLD_UNSUPPORTEDSUPPORTED_OLDSUPPORTED_NEWTOO_NEWBLACKLISTED

JSON Example

{
    "auto_update_supported": false,
    "run_state": "enum",
    "upgrade_policy": "enum"
}
Returned By

Get Tools

Feedback

Was this page helpful?