Update-Tools Command | Vmware PowerCLI Reference

Update-Tools

This cmdlet upgrades the VMware Tools on the specified virtual machine guest OS. VMware Tools must be installed prior to updating it. After VMware Tools is updated, the virtual machine is restarted unless the NoReboot parameter is specified.

Syntax

Update-Tools
[ [-Server ] < VIServer[] > ]
[-NoReboot ]
[-ProgressAction < ActionPreference > ]
[-RunAsync ]
[-VM < VirtualMachine[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Server VIServer[] 1
  • wildcards
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
optional NoReboot SwitchParameter named
Indicates that you do not want to reboot the system after updating VMware Tools. This parameter is supported only for Windows operating systems. NoReboot passes the following set of options to the VMware Tools installer on the guest OS: /s /v"/qn REBOOT=ReallySuppress" However, the virtual machine might still reboot after updating VMware Tools, depending on the currently installed VMware Tools version, the VMware Tools version to which you want to upgrade, and the vCenter Center/ESX versions.
optional ProgressAction ActionPreference named
optional RunAsync SwitchParameter named
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.
optional VM VirtualMachine[] named
  • pipeline
  • wildcards
Specifies a list of the virtual machines whose VMware Tools you want to upgrade.
Update-Tools
[-Guest < VMGuest[] > ]
[-NoReboot ]
[-ProgressAction < ActionPreference > ]
[-RunAsync ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Guest VMGuest[] named
  • pipeline
Specifies the guest operating systems on which you want to update VMware Tools.
optional NoReboot SwitchParameter named
Indicates that you do not want to reboot the system after updating VMware Tools. This parameter is supported only for Windows operating systems. NoReboot passes the following set of options to the VMware Tools installer on the guest OS: /s /v"/qn REBOOT=ReallySuppress" However, the virtual machine might still reboot after updating VMware Tools, depending on the currently installed VMware Tools version, the VMware Tools version to which you want to upgrade, and the vCenter Center/ESX versions.
optional ProgressAction ActionPreference named
optional RunAsync SwitchParameter named
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.

Output

Examples

Example 1

Update-Tools VM

Updates the VMware Tools on the specified virtual machine. The virtual machine must be powered on.

Example 2

Get-VMGuest VM | Update-Tools

Updates the VMware Tools on the virtual machine specified by its guest operating system. The virtual machine must be powered on.

Related Commands

Tools

This cmdlet dismounts the VMware Tools installer CD.

This cmdlet mounts the VMware Tools CD installer as a CD-ROM on the guest operating system.

This cmdlet upgrades VMware Tools on the specified virtual machine guest OS.

This cmdlet waits for VMware Tools on the specified virtual machines to load.