Get-VHDSnapshot

Module:
hyper-v
Gets information about a checkpoint in a VHD set.

Syntax 

Get-VHDSnapshot
   [-Path] <String[]>
   [-GetParentPaths]
   [-SnapshotId <Guid[]>]
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [<CommonParameters>]

Description

The Get-VHDSnapshot cmdlet gets information about a checkpoint in a virtual hard disk (VHD) set file.

Checkpoint replaces the previous term, snapshot.

Examples

Example 1: Get information about a checkpoint 

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

This command gets information about the checkpoint that has the specified ID from the VHD set file named Data01.vhds in the current working folder.

Required Parameters

-Path

Specifies an array of paths of VHD set files from which this cmdlet gets checkpoints. If you specify a file name or relative path, the cmdlet determines the full path relative to the current working folder.

Type: String[]
Aliases: FullName
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

Optional Parameters

-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[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ComputerName

Specifies one or more Hyper-V hosts that run this command. 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: None
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[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GetParentPaths

Gets the paths of all files on which this VHD checkpoint depends.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SnapshotId

Specifies an array of unique IDs of VHD checkpoints that this cmdlet gets from a VHD set file.

Type: Guid[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Outputs

Microsoft.Vhd.PowerShell.VHDSnapshotInfo

This cmdlet returns a VHDSnapshotInfo object.