Data Object - ToolsConfigInfo(vim.vm.ToolsConfigInfo)

Property of
VirtualMachineConfigInfo, VirtualMachineConfigSpec
Extends
DynamicData
See also
CryptoKeyId, ToolsConfigInfoToolsLastInstallInfo
Since
2.0

Data Object Description

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

Properties

Name Type Description
afterPowerOn*xsd:boolean

Flag to specify whether or not scripts should run after the virtual machine powers on.
afterResume*xsd:boolean

Flag to specify whether or not scripts should run after the virtual machine resumes.
beforeGuestReboot*xsd:boolean

Flag to specify whether or not scripts should run before the virtual machine reboots.
beforeGuestShutdown*xsd:boolean

Flag to specify whether or not scripts should run before the virtual machine powers off.
beforeGuestStandby*xsd:boolean

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

When set, provides the id of the key used to encrypt the customization package attached to the VM.

Since vSphere API 6.5
lastInstallInfo*ToolsConfigInfoToolsLastInstallInfo

Information about the last tools upgrade attempt if applicable. This information is maintained by the server and is ignored if set by the client.

Since vSphere API 5.0
pendingCustomization*xsd:string

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.

Since VI API 2.5
syncTimeWithHost*xsd:boolean

Flag to specify whether or not the tools program will periodically synchronize guest time with host time. Periodical synchronization is only allowed if vim.vm.ToolsConfigInfo#syncTimeWithHostAllowed is not set to false.

Since VI API 2.5
toolsInstallType*xsd:string

Installation type of VMware Tools in the guest operating system. The set of possible values is described in VirtualMachineToolsInstallType

Since vSphere API 6.5
toolsUpgradePolicy*xsd:string

Tools upgrade policy setting for the virtual machine.
See UpgradePolicy

Since VI API 2.5
toolsVersion*xsd:int

Version of VMware Tools installed on the guest operating system.
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition