Stop-VMHost

This cmdlet powers off the specified hosts. When the cmdlet runs asynchronously (with the RunAsync parameter) and you are connected directly to the host, the returned task object contains no indicator of success.

Syntax

-VMHost  <VMHost[]>
[-Force]
[-RunAsync]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
VMHost
VMHost[] named
  • wildcards
  • pipeline
  • Specifies the hosts you want to power off.
    optional
    Force
    SwitchParameter named Indicates that you want to stop the hosts even if they are not in a maintenance mode.
    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.

    Output

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

    Examples


    Example 1

    Stop-VMHost 10.23.112.235 -Confirm

    Shutdowns the specified host after user confirmation.

    Related Commands

    Feedback

    Was this page helpful?