powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Suspend-VM



NAME
Suspend-VM

SYNOPSIS
Suspends virtual machines.

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


DESCRIPTION
Suspends the virtual machines specified by the VM parameter. You can use the suspend feature to make resources avai
lable on a short-term basis or for other situations in which you want to put a virtual machine on hold without powe
ring it down. Using wildcards is supported with virtual machine names.


PARAMETERS
-RunAsync
Indicate that the command returns immediately without waiting for the task to complete. In this mode, the outpu
t of the cmdlet is a Task object. For more information about the -RunAsync parameter run " help About_RunAsync"
in the vSphere PowerCLI console.

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

-VM
Specify the virtual machines you want to suspend.

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

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
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


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
VirtualMachine


NOTES




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

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


Suspends the virtual machine named VM.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Suspend-VM.html
Get-VM
Move-VM
New-VM
Remove-VM
Set-VM
Start-VM
Stop-VM