powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Stop-VMHost



NAME
Stop-VMHost

SYNOPSIS
Powers off the specified hosts.

SYNTAX
Stop-VMHost [-VMHost] [-Force] [-Server ] [-RunAsync] [-WhatIf] [-Confirm] [ s>]


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


PARAMETERS
-VMHost
Specify the hosts you want to power off.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Force
Indicate that you want to stop the hosts even if they are not in a maintenance mode.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-RunAsync
Indicate that the command returns immediately without waiting for the task to complete. In this mode, the outpu
t of the cmdlet is a Task object. For more information about the -RunAsync parameter run " help About_RunAsync"
in the vSphere PowerCLI console.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm
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


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
VMHost


NOTES




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

C:\PS>Stop-VMHost 10.23.112.235 -Confirm


Shutdowns the specified host after user confirmation.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Stop-VMHost.html
Add-VMHost
Get-VMHost
Move-VMHost
Remove-VMHost
Restart-VMHost
Start-VMHost
Suspend-VMHost