powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Suspend-VMGuest



NAME
Suspend-VMGuest

SYNOPSIS
Suspends virtual machine guests

SYNTAX
Suspend-VMGuest [[-VM] ] [[-Server] ] [-WhatIf] [-Confirm] []

Suspend-VMGuest [[-Guest] ] [-WhatIf] [-Confirm] []


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


PARAMETERS
-VM
Specify the virtual machines whose operating systems you want to suspend. The virtual machines must have VMware
Tools installed.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Server
One or more vSphere servers to search for virtual machines. If not specified, the command will use the server c
urrently specified in the $DefaultVIServer variable.

Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? true

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

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

-Guest
Specify the guest operating systems you want to suspend.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
VMGuest


NOTES




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

C:\PS>Get-VM VM| Suspend-VMGuest


Suspends the guest OS of the virtual machine named VM.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Suspend-VMGuest.html
Get-VMGuest
Restart-VMGuest
Shutdown-VMGuest