Invoke-VMScript
This cmdlet runs a script in the guest OS of each of the specified virtual machines. To run Invoke-VMScript, the user must have read access to the folder containing the virtual machine and a Virtual Machine.Interaction.Console Interaction privilege. The virtual machines must be powered on and have VMware Tools installed. Network connectivity to the ESX system hosting the virtual machine on port 902 must be present. To authenticate with the host or the guest OS, one of the HostUser/HostPassword (GuestUser/GuestPassword) pair and HostCredential (GuestCredential) parameters must be provided. The guest account you use to authenticate with the guest operating system must have administrator's privileges. For a list of supported operating systems, see the PowerCLI User's Guide.To run this cmdlet against vCenter Server/ESX/ESXi versions earlier than 5.0, you need to meet the following requirements: *You must run the cmdlet on the 32-bit version of Windows PowerShell. *You must have access to the ESX that hosts the virtual machine over TCP port 902. *For vCenter Server/ESX/ESXi versions earlier than 4.1, you need VirtualMachine.Interact.ConsoleInteract privilege. For vCenter Server/ESX/ESXi 4.1 and later, you need VirtualMachine.Interact.GuestControl privilege.To run this cmdlet against vCenter Server/ESXi 5.0 and later, you need VirtualMachine.GuestOperations.Modify and VirtualMachine.GuestOperations.Execute privileges.
Syntax
-ScriptText <String>
[-GuestCredential <PSCredential>]
[-GuestPassword <SecureString>]
[-GuestUser <String>]
[-HostCredential <PSCredential>]
[-HostPassword <SecureString>]
[-HostUser <String>]
[-RunAsync]
[-ScriptType <ScriptType>]
[-Server <VIServer[]>]
[-ToolsWaitSecs <Int32>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
VirtualMachine[] | 1 |
|
Specifies the virtual machines on whose guest operating systems you want to run the script. | required |
|
String | named |
|
Provides the text of the script you want to run. You can also pass to this parameter a string variable containing the path to the script. | optional |
|
PSCredential | named |
|
Specifies a PSCredential object containing the credentials you want to use for authenticating with the virtual machine guest OS. | optional |
|
SecureString | named |
|
Specifies the password you want to use for authenticating with the virtual machine guest OS. | optional |
|
String | named |
|
Specifies the user name you want to use for authenticating with the virtual machine guest OS. | optional |
|
PSCredential | named |
|
Specifies a PSCredential object containing the credentials you want to use for authenticating with the host. You need to specify host credentials only if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you have installed is earlier than 1.10. | optional |
|
SecureString | named |
|
Specifies the password you want to use for authenticating with the host. You need to specify host credentials only if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you have installed is earlier than 1.10. | optional |
|
String | named |
|
Specifies the user name you want to use for authenticating with the host. You need to specify host credentials only if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you have installed is earlier than 1.10. | optional |
|
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 |
|
ScriptType | named |
|
Specifies the type of the script. The valid values are PowerShell, Bat, and Bash. If the virtual machine OS is Windows, the default value is PowerShell. If the virtual machine OS is Linux, the default value is Bash. | optional |
|
VIServer[] | named |
|
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 |
|
Int32 | named |
|
Specifies how long in seconds the system waits for connecting to the VMware Tools. The default value is 20. |
Output
VMware.VimAutomation.ViCore.Types.V1.VM.Guest.VMScriptResult
Examples
Example 1
Lists the directory entries on the guest OS.
Example 2
Runs a PowerShell script. In PowerShell, to access environment variables, you must use the following syntax: $env:
Example 3
Runs a BAT script. In BAT scripts, to access environment variables, you must use the following syntax: %
Related Commands
VM
VMConsoleWindow
VMGuest
VMGuestDisk
VMGuestFile
VMQuestion
VMResourceConfiguration
VMScript
