Wait-Tools

This cmdlet waits for VMware Tools of the specified virtual machines to load. The cmdlet returns the virtual machines or guests on which VMware Tools have loaded successfully within the specified time limits. You can cancel the operation before completion using Ctrl+C. The successful completion of Wait-Tools means that VMware Tools have loaded, but it does not guarantee for the start of other services. Updating the returned VMGuest objects requires additional communication with VMware Tools and some of their properties (OSFullName, IPAddress, HostName, and other) might be still empty right after the completion of Wait-Tools.

Syntax

[-Guest]  <VMGuest[]>
[-HostCredential  <PSCredential>]
[-HostPassword  <SecureString>]
[-HostUser  <String>]
[-TimeoutSeconds  <Int32>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Guest
VMGuest[] 1
  • pipeline
  • Specifies the guest operating systems for which you want to wait VMware Tools to load.
    optional
    HostCredential
    PSCredential named Specifies credentials for authenticating with the ESX/ESXi host of the specified virtual machine. This parameter is needed only if you have authenticated with vCenter Server via SSPI. If SSPI is not used, the credentials for authentication with vCenter Server are used.
    optional
    HostPassword
    SecureString named Specifies a password for authenticating with the ESX host of the specified virtual machine. This parameter is needed only if you have authenticated with the vCenter Server via SSPI. If no SSPI is used, the password for authentication with vCenter Server is used.
    optional
    HostUser
    String named Specifies a username for authenticating with the ESX/ESXi host of the specified virtual machine. This parameter is needed only if you have authenticated with vCenter Server via SSPI. If SSPI is not used, the username for authentication with vCenter Server is used.
    optional
    TimeoutSeconds
    Int32 named Specifies the time period in seconds to wait for VMware Tools to start before cancelling the operation.

    [-VM]  <VirtualMachine[]>
    [-HostCredential  <PSCredential>]
    [-HostPassword  <SecureString>]
    [-HostUser  <String>]
    [-Server  <VIServer[]>]
    [-TimeoutSeconds  <Int32>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    VM
    VirtualMachine[] 1
  • wildcards
  • pipeline
  • Specifies the virtual machines for which you want to wait VMware Tools to load.
    optional
    HostCredential
    PSCredential named Specifies credentials for authenticating with the ESX/ESXi host of the specified virtual machine. This parameter is needed only if you have authenticated with vCenter Server via SSPI. If SSPI is not used, the credentials for authentication with vCenter Server are used.
    optional
    HostPassword
    SecureString named Specifies a password for authenticating with the ESX host of the specified virtual machine. This parameter is needed only if you have authenticated with the vCenter Server via SSPI. If no SSPI is used, the password for authentication with vCenter Server is used.
    optional
    HostUser
    String named Specifies a username for authenticating with the ESX/ESXi host of the specified virtual machine. This parameter is needed only if you have authenticated with vCenter Server via SSPI. If SSPI is not used, the username for authentication with vCenter Server is used.
    optional
    Server
    VIServer[] named
  • 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
    TimeoutSeconds
    Int32 named Specifies the time period in seconds to wait for VMware Tools to start before cancelling the operation.

    Output

    VMware.VimAutomation.ViCore.Types.V1.VM.Guest.VMGuest

    Examples


    Example 1

    $vm = Start-VM VM* | Wait-Tools

    Starts the virtual machines with names starting with VM and Waits for their VMware Tools to load.

    Example 2

    Wait-Tools -VM $vm -TimeoutSeconds 180

    Waits for the VMware Tools of the virtual machines in the $vm variable to start. If VMware Tools do not load after 180 seconds, the operation is aborted.

    Example 3

    Wait-Tools -VM VM* -TimeoutSeconds 120 -HostCredential $vmhostCredential

    Waits for the VMware Tools of the virtual machines in the $vm variable to start. If VMware Tools do not load after 120 seconds, the operation is aborted. Host credentials are required when you run the cmdlet on environments older than vSphere 4.0.

    Example 4

    Restart-VMGuest WindowsXP | Wait-Tools

    Restart the guest operating system WindowsXP and waits for the VMware Tools to load.

    Related Commands

    Feedback

    Was this page helpful?