powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Suspend-VMHost



NAME
Suspend-VMHost

SYNOPSIS
Suspends hosts.

SYNTAX
Suspend-VMHost [-VMHost] [-TimeoutSeconds ] [-Evacuate] [-Server ] [-RunAsync] [-What
If] [-Confirm] []


DESCRIPTION
Powers down the specified host machines to standby mode. You can use the suspend feature to make resources availabl
e on a short-term basis or for other situations in which you want to put a host on hold without powering it down.


PARAMETERS
-VMHost
Specify the hosts you want to suspend.

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

-TimeoutSeconds
Specify a time period in seconds to wait for the host to enter a 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

-Evacuate
If the value is $true, vCenter automatically reregisters the virtual machines that are compatible for reregistr
ation. 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 clu
ster.

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

-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

-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

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


NOTES


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

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

C:\PS>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 re
ported failed.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Suspend-VMHost.html
Add-VMHost
Get-VMHost
Move-VMHost
Remove-VMHost
Restart-VMHost
Start-VMHost
Stop-VMHost