Remove-VM

Remove-VM

Deletes a virtual machine.

Syntax

Parameter Set: Name
Remove-VM [-Name] <String[]> [-AsJob] [-ComputerName <String[]> ] [-Force] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMObject
Remove-VM [-VM] <VirtualMachine[]> [-AsJob] [-Force] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-VM cmdlet deletes a virtual machine. Running this cmdlet deletes the virtual machine’s configuration file, but does not delete any virtual hard drives. If the virtual machine has any snapshots, these are deleted and merged into the virtual hard disk files after the virtual machine is deleted.

Parameters

-AsJob

Specifies that this cmdlet is to be run as a background job.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ComputerName<String[]>

Specifies one or more Hyper-V hosts from which the virtual machine is to be deleted. 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.

Aliases	none
Required?	false
Position?	named
Default Value	.
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Force

Specifies that confirmation prompts are to be suppressed during deletion of the virtual machine.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name<String[]>

Specifies the name of the virtual machine to be deleted.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	true

-Passthru

Specifies that an object is to be passed through to the pipeline representing the virtual machine to be deleted.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VM<VirtualMachine[]>

Specifies the virtual machine to be deleted.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• None by default; Microsoft.Virtualization.Powershell.VirtualMachine if –PassThru is specified.

Examples

Example 1

Removes virtual machine new 1.

PS C:\> Remove-VM “new 1”

Example 2

Removes virtual machine new 2, suppressing the confirmation prompt.

PS C:\> Remove-VM –Name “new 2” -Force

Example 3

Removes with no confirmation prompt all virtual machines having names starting with New.

PS C:\> Get-VM –Name New* | Remove-VM -Force