PowerCLI Reference



This cmdlet suspends hosts.


Suspend-VMHost [-VMHost] <VMHost[]> [-Evacuate] [-RunAsync] [-Server <VIServer[]>] [-TimeoutSeconds <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet puts the specified host machines in standby mode. You can use the suspend feature to make resources available on a short-term basis or for other situations in which you want to put a host on hold without powering it off.


NameTypeDescriptionRequired?Pipeline InputDefault Value
VMHostVMHost[]Specifies the hosts you want to suspend.trueTrue (ByValue)
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
EvacuateSwitchParameterIf the value is $true, vCenter Server automatically reregisters the virtual machines that are compatible for reregistration. If they are not compatible, they remain on the suspended host. If there are powered-on virtual machines that cannot be reregistered, the operation waits until they are powered off manually. The Evacuate parameter is valid only when connected to a vCenter Server system and the virtual machine host is part of a DRS-enabled cluster.falseFalse
RunAsyncSwitchParameterIndicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.falseFalse
ServerVIServer[]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.falseFalse
TimeoutSecondsInt32Specifies a time period in seconds to wait for the host to enter standby mode. If the host is not suspended for the specified time, the host is declared timed out, and the task is assumed failed. The default value is 300.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

Zero or more suspended VMHost objects


Works only against vCenter Server 4.1 and later. The host should be configured to support standby mode using Wake-on-Lan or the Intelligent Platform Management Interface Protocol (IPMI) protocol (vCenter Server 4.1). The Evacuate parameter is valid only when the host is a part of a DRS-enabled cluster.


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

Suspend-VMHost -TimeOutSeconds 60 -Confirm

Suspends the specified host after user confirmation. If the host is not suspended within 60 seconds, the task is reported failed.

Copyright © VMware, Inc. All rights reserved.