## PowerCLI Reference

# Stop-VMHost

## Synopsis

This cmdlet powers off the specified hosts.

Syntax

Stop-VMHost [-VMHost] <VMHost[]> [-Force] [-Server <VIServer[]>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Add-VMHost
Get-VMHost
Move-VMHost
Remove-VMHost
Restart-VMHost
Start-VMHost
Suspend-VMHost

Detailed Description

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.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
VMHost | VMHost[] | Specifies the hosts you want to power off. | true | true (ByValue)
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. | false | false
Force | SwitchParameter | Indicates that you want to stop the hosts even if they are not in a maintenance mode. | false | 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. | false | 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. | false | false
WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false

Return Type

Zero or more powered-off VMHost objects

Notes

Examples

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

    Stop-VMHost 10.23.112.235 -Confirm

Shutdowns the specified host after user confirmation.

Copyright © VMware, Inc. All rights reserved.