< Back
Stop-VM
Post
NAME Stop-VM
SYNOPSIS
This cmdlet powers off virtual machines.
SYNTAX
Stop-VM [-VM] <VirtualMachine[]> [-Kill] [-RunAsync] [-Server <VIServer[]>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet stops the virtual machines specified by the VM parameter.
PARAMETERS
-Kill [<SwitchParameter>]
Indicates 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.
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
-VM <VirtualMachine[]>
Specifies the virtual machines 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 VirtualMachine objects
NOTES
-------------------------- 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.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... op-VM.html
Get-VM
Move-VM
New-VM
Remove-VM
Set-VM
Start-VM
Suspend-VM
SYNOPSIS
This cmdlet powers off virtual machines.
SYNTAX
Stop-VM [-VM] <VirtualMachine[]> [-Kill] [-RunAsync] [-Server <VIServer[]>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet stops the virtual machines specified by the VM parameter.
PARAMETERS
-Kill [<SwitchParameter>]
Indicates 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.
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
-VM <VirtualMachine[]>
Specifies the virtual machines 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 VirtualMachine objects
NOTES
-------------------------- 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.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... op-VM.html
Get-VM
Move-VM
New-VM
Remove-VM
Set-VM
Start-VM
Suspend-VM