vSphere PowerCLI Reference

Restart-VMGuest

Synopsis

Restarts the virtual machine guest operating systems.

Syntax

Restart-VMGuest [[-VM] <VirtualMachine[]>] [[-Server] <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Restart-VMGuest [[-Guest] <VMGuest[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-VMGuest
Shutdown-VMGuest
Suspend-VMGuest

Detailed Description

Restarts the virtual machine guest operating systems.

Parameters

Name	Type	Description	Required?	Pipeline Input	Default Value
Guest	VMGuest[]	Specify the virtual machine guest operating systems you want to restart.	false	true (ByValue)
VM	VirtualMachine[]	Specify the virtual machines whose operating systems you want to restart. The specified virtual machines must have VMware Tools installed.	false	true (ByValue)
Server	VIServer[]	One or more vSphere servers to search for virtual machines. If not specified, the command will use the server currently specified in the $DefaultVIServer variable.	false	false
Confirm	SwitchParameter	If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.	false	false	$true
WhatIf	SwitchParameter	Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	false

Return Type

VMGuest

Notes

Examples

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

Get-VM VM | Restart-VMGuest

Restarts the guest OS of the virtual machine named VM.