Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Remove-VHDSnapshot

Brian Lich|Last Updated: 3/8/2017

SYNOPSIS

Removes a checkpoint from a VHD set file.

SYNTAX

Path (Default)

Remove-VHDSnapshot [-Path] <String[]> [-PersistReferencePoint] -SnapshotId <Guid[]> [-AsJob]
 [-CimSession <CimSession[]>] [-ComputerName <String[]>] [-Credential <PSCredential[]>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

VHDSnapshot

Remove-VHDSnapshot [-PersistReferencePoint] [-VHDSnapshot] <VHDSnapshotInfo[]> [-AsJob]
 [-CimSession <CimSession[]>] [-ComputerName <String[]>] [-Credential <PSCredential[]>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

The Remove-VHDSnapshot cmdlet removes a virtual hard disk (VHD) checkpoint from a VHD set file.

Checkpoint replaces the previous term, snapshot.

EXAMPLES

Example 1: Remove a checkpoint

PS C:\> Remove-VHDSnapshot -Path "Data01.vhds" -SnapshotId 6c87351a-a39a-4581-b231-6d693b26485d

This command removes the checkpoint that has the specified ID from the VHD set file named Data01.vhds.

PARAMETERS

-AsJob

Runs the cmdlet as a background job.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type: CimSession[]
Parameter Sets: (All)
Aliases: 

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

-ComputerName

Specifies one or more Hyper-V hosts that run this cmdlet. 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[]
Parameter Sets: (All)
Aliases: 

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: False
Accept pipeline input: False
Accept wildcard characters: False

-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type: PSCredential[]
Parameter Sets: (All)
Aliases: 

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

-Path

Specifies an array of paths of VHD set files. This cmdlet removes a checkpoint from the files that this parameter specifies. If you specify a file name or relative path, the cmdlet determines the full path relative to the current working folder.

Type: String[]
Parameter Sets: Path
Aliases: FullName

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-PersistReferencePoint

Indicates that this cmdlet persists an RCT-only reference point after it deletes the checkpoint.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-SnapshotId

Specifies an array of unique IDs of VHD checkpoint that this cmdlet removes from the VHD set file.

Type: Guid[]
Parameter Sets: Path
Aliases: 

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

-VHDSnapshot

Specifies an array of VHD checkpoints that this cmdlet removes from a VHD set file.

Type: VHDSnapshotInfo[]
Parameter Sets: VHDSnapshot
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
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: False
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

Microsoft.Vhd.PowerShell.VHDSnapshotInfo[]

NOTES

Get-VHDSnapshot

© 2017 Microsoft