Suspend-VMGuest

NAME Suspend-VMGuest



SYNOPSIS

This cmdlet suspends the specified guest operating systems.





SYNTAX

Suspend-VMGuest [[-Guest] <VMGuest[]>] [-Confirm] [-WhatIf] [<CommonParameters>]



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





DESCRIPTION

This cmdlet issues a command to the specified guest operating system asking it to prepare for a suspend operation.





PARAMETERS

-Guest <VMGuest[]>

Specifies the guest operating systems you want to suspend.



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-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.



Required? false

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-VM <VirtualMachine[]>

Specifies the virtual machines whose operating systems you want to suspend. The virtual machines must have

VMware Tools installed.



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-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.



Required? false

Position? named

Default value $true

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are

modified.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Zero or more suspended VMGuest objects







NOTES









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



Get-VM VM| Suspend-VMGuest



Suspends the guest OS of the virtual machine named VM.



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... Guest.html

Get-VMGuest

Restart-VMGuest

Stop-VMGuest