PowerCLI Reference

Stop-VMHost

Synopsis

This cmdlet powers off the specified hosts.

Syntax

Stop-VMHost [-VMHost] <VMHost[]> [-Force] [-RunAsync] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<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

NameTypeDescriptionRequired?Pipeline InputDefault Value
VMHostVMHost[]Specifies the hosts you want to power off.trueTrue (ByValue)
ConfirmSwitchParameterIf 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.falseFalse
ForceSwitchParameterIndicates that you want to stop the hosts even if they are not in a maintenance mode.falseFalse
RunAsyncSwitchParameterIndicates 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.falseFalse
ServerVIServer[]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.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

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.