Suspend-VMHost

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.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
VMHost
VMHost[] named
  • wildcards
  • pipeline
  • Specifies the hosts you want to suspend.
    optional
    Evacuate
    SwitchParameter named 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.
    optional
    RunAsync
    SwitchParameter named 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.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
    optional
    TimeoutSeconds
    Int32 named 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.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Inventory.VMHost

    Examples


    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 Commands

    Feedback

    Was this page helpful?