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

[-Guest  <VMGuest[]>]
[-NoReboot]
[-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:
    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.

    [[-Server]  <VIServer[]>]
    [-NoReboot]
    [-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:
    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
  • wildcards
  • pipeline
  • Specifies a list of the virtual machines whose VMware Tools you want to upgrade.

    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

    Feedback

    Was this page helpful?