powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Wait-Tools



NAME
Wait-Tools

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

SYNTAX
Wait-Tools [-VM] [[-TimeoutSeconds] ] [-HostCredential ] [-HostUser >] [-HostPassword ] [-Server ] []

Wait-Tools [[-TimeoutSeconds] ] [-HostCredential ] [-HostUser ] [-HostPassword String>] [-Guest] []


DESCRIPTION
Waits for the VMware Tools of the specified virtual machines to load. The cmdlet returns the virtual machines or gu
ests 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 propert
ies (OSFullName, IPAddress, HostName, and other) might be still empty right after the completion of Wait-Tools.


PARAMETERS
-VM
Specify the virtual machines for which you want to wait VMware Tools to load.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-TimeoutSeconds
Specify the time period in seconds to wait for VMware Tools to start before cancelling the operation.

Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false

-HostCredential
Specify credentials for authenticating with the ESX host of the specified virtual machine. This parameter is ne
eded only if you have authenticated with the vCenter Server via SSPI. If no SSPI is used, the credentials for a
uthentication with vCenter Server are used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-HostUser
Specify a username for authenticating with the ESX host of the specified virtual machine. This parameter is nee
ded only if you have authenticated with the vCenter Server via SSPI. If no SSPI is used, the username for authe
ntication with vCenter Server is used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-HostPassword
Specify a password for authenticating with the ESX host of the specified virtual machine. This parameter is nee
ded only if you have authenticated with the vCenter Server via SSPI. If no SSPI is used, the password for authe
ntication with vCenter Server is used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Guest
Specify the guest operating systems for which you want to wait VMware Tools to load.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
VirtualMachine or VMGuest


NOTES




-------------- Example 1 --------------

C:\PS>$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 --------------

C:\PS>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 --------------

C:\PS>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 --------------

C:\PS>Restart-VMGuest WindowsXP | Wait-Tools


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






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Wait-Tools.html
Mount-Tools
Dismount-Tools
Update-Tools