vSphere PowerCLI Reference

Stop-VM

Synopsis

This cmdlet powers off virtual machines.

Syntax

Stop-VM [-Kill] [-RunAsync] [-VM] <VirtualMachine[]> [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-VM
Move-VM
New-VM
Remove-VM
Set-VM
Start-VM
Suspend-VM

Detailed Description

This cmdlet stops the virtual machines specified by the VM parameter.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VMVirtualMachine[]Specifies the virtual machines 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$true
KillSwitchParameterIndicates that you want to stop the specified virtual machines by terminating their processes running on the ESX. You can use this parameter to stop a virtual machine that is not responding and cannot be stopped or restarted in other ways. To use the Kill parameter, you need to have a direct connection to ESX 4.1 or later.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 vSphere 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 VirtualMachine objects

Notes

Examples

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

Stop-VM -VM VM -Confirm

Stops the virtual machine named VM after confirmation by the user.

-------------- Example 2 --------------

Stop-VM -VM VM -Kill -Confirm:$false

Stops the virtual machine VM by terminating its process running on the ESX.


Copyright © 1998 - 2013 VMware, Inc. All rights reserved.