vSphere PowerCLI Reference

Shutdown-VMGuest

Synopsis

Shutdowns the specified virtual machine guest OS.

Syntax

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

Related Commands

Online version
Get-VMGuest
Restart-VMGuest
Suspend-VMGuest

Detailed Description

Issues a command to the guest operating system asking it to prepare for a shutdown operation. Returns immediately and does not wait for the guest operating system to complete the operation.

Parameters

Name	Type	Description	Required?	Pipeline Input	Default Value
Guest	VMGuest[]	Specify the virtual machine guests you want to shut down.	false	true (ByValue)
VM	VirtualMachine[]	Specify the virtual machines whose operating systems you want to shut down. The virtual machines must have VMware Tools installed.	false	true (ByValue)
Server	VIServer[]	vSphere servers to search for virtual machine names. 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 | Shutdown-VMGuest

Shutdowns the guest OS of the virtual machine named VM.