vSphere PowerCLI Reference

Suspend-VMGuest

Synopsis

Suspends virtual machine guests

Syntax

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

Related Commands

Online version
Get-VMGuest
Restart-VMGuest
Shutdown-VMGuest

Detailed Description

Issues a command to the specified guest operating system asking it to prepare for a suspend operation.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
GuestVMGuest[]Specify the guest operating systems you want to suspend.falsetrue (ByValue)
VMVirtualMachine[]Specify the virtual machines whose operating systems you want to suspend. The virtual machines must have VMware Tools installed.falsetrue (ByValue)
ServerVIServer[]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.falsefalse
ConfirmSwitchParameterIf 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
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

VMGuest

Notes

Examples

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

Get-VM VM| Suspend-VMGuest

Suspends the guest OS of the virtual machine named VM.


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