vSphere PowerCLI Reference

Wait-Tools

Synopsis

Waits for the VMware Tools of the specified virtual machines to load.

Syntax

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

Related Commands

Online version
Mount-Tools
Dismount-Tools
Update-Tools

Detailed Description

Waits for the 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 the VMware Tools have loaded, but it doesn't 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.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
TimeoutSecondsInt32Specify the time period in seconds to wait for VMware Tools to start before cancelling the operation.falsefalse
GuestVMGuest[]Specify the guest operating systems for which you want to wait VMware Tools to load.truetrue (ByValue)
VMVirtualMachine[]Specify the virtual machines for which you want to wait VMware Tools to load.truetrue (ByValue)
HostCredentialPSCredentialSpecify credentials 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 credentials for authentication with vCenter Server are used.falsefalse
HostPasswordSecureStringSpecify 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.falsefalse
HostUserStringSpecify a username 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 username for authentication with vCenter Server is used.falsefalse
ServerVIServer[]Specify the vSphere servers 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.falsefalse

Return Type

VirtualMachine or VMGuest

Notes

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 $hostCredential

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.


Copyright © 1998 - 2012 VMware, Inc. All rights reserved.