ToolsConfigInfo

ToolsConfigInfo
ToolsConfigInfo

ToolsConfigInfo is a data object type containing settings for the VMware Tools software running in the guest operating system.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "toolsVersion": 0,
    "toolsInstallType": "string",
    "afterPowerOn": false,
    "afterResume": false,
    "beforeGuestStandby": false,
    "beforeGuestShutdown": false,
    "beforeGuestReboot": false,
    "toolsUpgradePolicy": "string",
    "pendingCustomization": "string",
    "customizationKeyId": {
        "_typeName": "string",
        "keyId": "string",
        "providerId": {
            "_typeName": "string",
            "id": "string"
        }
    },
    "syncTimeWithHostAllowed": false,
    "syncTimeWithHost": false,
    "lastInstallInfo": {
        "_typeName": "string",
        "counter": 0,
        "fault": {
            "_typeName": "string",
            "faultCause": "MethodFault Object",
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        }
    }
}
integer As int32 As int32
toolsVersion
Optional

Version of VMware Tools installed on the guest operating system.

string
toolsInstallType
Optional

Installation type of VMware Tools in the guest operating system.

The set of possible values is described in VirtualMachineToolsInstallTypeEnum

boolean
afterPowerOn
Optional

Flag to specify whether or not scripts should run after the virtual machine powers on.

boolean
afterResume
Optional

Flag to specify whether or not scripts should run after the virtual machine resumes.

boolean
beforeGuestStandby
Optional

Flag to specify whether or not scripts should run before the virtual machine suspends.

boolean
beforeGuestShutdown
Optional

Flag to specify whether or not scripts should run before the virtual machine powers off.

boolean
beforeGuestReboot
Optional

Flag to specify whether or not scripts should run before the virtual machine reboots.

string
toolsUpgradePolicy
Optional

Tools upgrade policy setting for the virtual machine.

See also UpgradePolicyEnum.

string
pendingCustomization
Optional

When set, this indicates that a customization operation is pending on the VM.

The value represents the filename of the customization package on the host.

CryptoKeyId
customizationKeyId
Optional

Data Object representing a cryptographic key.

boolean
syncTimeWithHostAllowed
Optional

Indicates whether or not the tools program is allowed to synchronize guest time with host time.

When set to false, disallows tool periodic time synchronization as well as guest time step corrections due to one-off events like resume from suspend.

Since: vSphere API Release 7.0.1.0

boolean
syncTimeWithHost
Optional

Flag to specify whether or not the tools program will periodically synchronize guest time with host time.

Periodical synchronization is only allowed if syncTimeWithHostAllowed is not set to false.

ToolsConfigInfoToolsLastInstallInfo
lastInstallInfo
Optional

Describes status of last tools upgrade attempt

Property Of