Syntax
Suspend-VMGuest [[-Guest] <VMGuest[]>] [-Confirm] [-WhatIf] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet issues a command to the specified guest operating system asking it to prepare for a suspend operation.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Guest | VMGuest[] | Specifies the guest operating systems you want to suspend. | false | True (ByValue) | |
| VM | VirtualMachine[] | Specifies the virtual machines whose operating systems you want to suspend. The virtual machines must have VMware Tools installed. | false | True (ByValue) | |
| Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. | 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 | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | False |
Return Type
Zero or more suspended VMGuest objectsNotes
Examples
-------------------------- Example 1 --------------------------
Get-VM VM| Suspend-VMGuest
Suspends the guest OS of the virtual machine named VM.