< Back
Stop-VMHost
Post
NAME Stop-VMHost
SYNOPSIS
This cmdlet powers off the specified hosts.
SYNTAX
Stop-VMHost [-VMHost] <VMHost[]> [-Force] [-RunAsync] [-Server <VIServer[]>] [-Confirm] [-WhatIf]
[<CommonParameters>]
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
-Force [<SwitchParameter>]
Indicates that you want to stop the hosts even if they are not in a maintenance mode.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VMHost <VMHost[]>
Specifies the hosts you want to power off.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more powered-off VMHost objects
NOTES
-------------------------- Example 1 --------------------------
Stop-VMHost 10.23.112.235 -Confirm
Shutdowns the specified host after user confirmation.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... MHost.html
Add-VMHost
Get-VMHost
Move-VMHost
Remove-VMHost
Restart-VMHost
Start-VMHost
Suspend-VMHost
SYNOPSIS
This cmdlet powers off the specified hosts.
SYNTAX
Stop-VMHost [-VMHost] <VMHost[]> [-Force] [-RunAsync] [-Server <VIServer[]>] [-Confirm] [-WhatIf]
[<CommonParameters>]
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
-Force [<SwitchParameter>]
Indicates that you want to stop the hosts even if they are not in a maintenance mode.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VMHost <VMHost[]>
Specifies the hosts you want to power off.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more powered-off VMHost objects
NOTES
-------------------------- Example 1 --------------------------
Stop-VMHost 10.23.112.235 -Confirm
Shutdowns the specified host after user confirmation.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... MHost.html
Add-VMHost
Get-VMHost
Move-VMHost
Remove-VMHost
Restart-VMHost
Start-VMHost
Suspend-VMHost