vSphere PowerCLI Cmdlets 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 suspend operation. Returns immediately and does not wait for the guest operating system to complete the operation.

Parameters

NameDescriptionRequired?Pipeline InputDefault Value
VMSpecify the virtual machines whose operating systems you want to shut down. The virtual machines must have VMware Tools installed.falsetrue (ByValue)
ServervSphere servers to search for virtual machine names. If not specified, the command will use the server currently specified in the $DefaultVIServer variable.falsefalse
WhatIfIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse
ConfirmIf 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.falsefalse$true
GuestSpecify the virtual machine guests you want to shut down.falsetrue (ByValue)

Return Type

VMGuest

Notes

Examples

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

Get-VM VM | Shutdown-VMGuest

Shutdowns the guest OS of the virtual machine named VM.


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