Skip to content

Remove-Win32ToolkitTestVM

SYNOPSIS

Tears down the Hyper-V test VM (stop, remove checkpoints + VM, optionally delete the VHDX).

SYNTAX

Remove-Win32ToolkitTestVM [[-Name] <String>] [-RemoveVhdx] [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

HOST-ONLY cleanup. Turns the VM off, removes all its checkpoints and the VM config, and - with -RemoveVhdx - deletes its virtual disks. Each step is best-effort so partial state still cleans.

EXAMPLES

Example 1

PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-Name

VM name (default: the stored HyperVVMName, else 'win32tk-golden').

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: (Get-Win32ToolkitConfigValue -Name 'HyperVVMName' -Default 'win32tk-golden')
Accept pipeline input: False
Accept wildcard characters: False

-RemoveVhdx

Also delete the VM's VHDX file(s).

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES