## PowerCLI Reference

# Update-Tools

## Synopsis

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

Syntax

Update-Tools [-NoReboot] [-RunAsync] [[-Guest] <VMGuest[]>] [<CommonParameters>]
Update-Tools [-NoReboot] [-RunAsync] [[-VM] <VirtualMachine[]>] [[-Server] <VIServer[]>] [<CommonParameters>]

Related Commands

Online version
Mount-Tools
Dismount-Tools
Wait-Tools

Detailed Description

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.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
Guest | VMGuest[] | Specifies the guest operating systems on which you want to update VMware Tools. | false | true (ByValue)
VM | VirtualMachine[] | Specifies a list of the virtual machines whose VMware Tools you want to upgrade. | false | true (ByValue)
Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. | false | false
NoReboot | SwitchParameter | 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. | false | false
RunAsync | SwitchParameter | 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. | false | false

Return Type

None

Notes

On non-Windows operating systems, Update-Tools might not be able to perform automatic upgrade of VMware Tools. In such cases, the cmdlet only mounts the VMware Tools installation drive and you must do the upgrade manually.

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.

Copyright © VMware, Inc. All rights reserved.