< Back
Suspend-VMHost
Post
NAME Suspend-VMHost
SYNOPSIS
This cmdlet suspends hosts.
SYNTAX
Suspend-VMHost [-VMHost] <VMHost[]> [-Evacuate] [-RunAsync] [-Server <VIServer[]>] [-TimeoutSeconds <Int32>]
[-Confirm] [-WhatIf] [<CommonParameters>]
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.
PARAMETERS
-Evacuate [<SwitchParameter>]
If 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-RunAsync [<SwitchParameter>]
Indicates 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
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? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-TimeoutSeconds <Int32>
Specifies 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.
Required? false
Position? named
Default value 300
Accept pipeline input? False
Accept wildcard characters? false
-VMHost <VMHost[]>
Specifies the hosts you want to suspend.
Required? true
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 VMHost objects
NOTES
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 10.23.112.54 -TimeOutSeconds 60 -Confirm
Suspends the specified host after user confirmation. If the host is not suspended within 60 seconds, the task is
reported failed.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... MHost.html
Add-VMHost
Get-VMHost
Move-VMHost
Remove-VMHost
Restart-VMHost
Start-VMHost
Stop-VMHost
SYNOPSIS
This cmdlet suspends hosts.
SYNTAX
Suspend-VMHost [-VMHost] <VMHost[]> [-Evacuate] [-RunAsync] [-Server <VIServer[]>] [-TimeoutSeconds <Int32>]
[-Confirm] [-WhatIf] [<CommonParameters>]
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.
PARAMETERS
-Evacuate [<SwitchParameter>]
If 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-RunAsync [<SwitchParameter>]
Indicates 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
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? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-TimeoutSeconds <Int32>
Specifies 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.
Required? false
Position? named
Default value 300
Accept pipeline input? False
Accept wildcard characters? false
-VMHost <VMHost[]>
Specifies the hosts you want to suspend.
Required? true
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 VMHost objects
NOTES
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 10.23.112.54 -TimeOutSeconds 60 -Confirm
Suspends the specified host after user confirmation. If the host is not suspended within 60 seconds, the task is
reported failed.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... MHost.html
Add-VMHost
Get-VMHost
Move-VMHost
Remove-VMHost
Restart-VMHost
Start-VMHost
Stop-VMHost