Stop-VM
Shuts down, turns off, or saves a virtual machine.
Syntax
Stop-VM
[-ComputerName <String[]>]
[-Name] <String[]>
[-Force]
[-Save]
[-TurnOff]
[-AsJob]
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Stop-VM
[-Force]
[-Save]
[-TurnOff]
[-AsJob]
[-Passthru]
[-VM] <VirtualMachine[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Stop-VM cmdlet shuts down, turns off, or saves a virtual machine.
Examples
Example 1
PS C:\>Stop-VM -Name TestVM
Shuts down virtual machine TestVM through the guest operating system.
Example 2
PS C:\>Stop-VM -Name VM1 -Force
Shuts down virtual machine TestVM through the guest operating system, regardless of any unsaved application data. Hyper-V gives the guest five minutes to save data, then forces a shutdown. This shutdown can result in loss of unsaved data.
Example 3
PS C:\>Stop-VM -Name TestVM -TurnOff
Turns off virtual machine TestVM. This operation is equivalent to disconnecting the power from the virtual machine, and can result in loss of unsaved data.
Parameters
-AsJob
Specifies that the cmdlet is to be run as a background job.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ComputerName
Specifies one or more Hyper-V hosts on which a virtual machine is to be shut down. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly.
Type: | String[] |
Position: | Named |
Default value: | . |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Specifies that the shutdown of the virtual machine is to be forced. If the virtual machine has applications with unsaved data, the virtual machine has five minutes to save data and shut down. If the virtual machine is locked, it is shut down immediately.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifies the name of the virtual machine to be shut down.
Type: | String[] |
Aliases: | VMName |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Passthru
Specifies that a Microsoft.HyperV.PowerShell.VirtualMachine object is to be passed through to the pipeline representing the virtual machine to be shut down.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Save
Specifies that the virtual machine is to be saved.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TurnOff
Specifies that the virtual machine is to be turned off.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VM
Specifies the virtual machine to be shut down.
Type: | VirtualMachine[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
None by default; Microsoft.HyperV.PowerShell.VirtualMachine if -PassThru is specified.