Skip to content

Commit 7daf2f8

Browse files
authored
Merge pull request MicrosoftDocs#3574 from MicrosoftDocs/main
Publish 07/28/2023, 3:30 PM
2 parents 1fe12a3 + 1f0022e commit 7daf2f8

File tree

2 files changed

+99
-68
lines changed

2 files changed

+99
-68
lines changed

docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md

Lines changed: 44 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml
44
Module Name: Hyper-V
5-
ms.date: 12/20/2016
5+
ms.date: 06/21/2023
66
online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vhdsnapshot?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-VHDSnapshot
@@ -16,35 +16,42 @@ Gets information about a checkpoint in a VHD set.
1616
## SYNTAX
1717

1818
```
19-
Get-VHDSnapshot [-Path] <String[]> [-GetParentPaths] [-SnapshotId <Guid[]>] [-CimSession <CimSession[]>]
20-
[-ComputerName <String[]>] [-Credential <PSCredential[]>] [<CommonParameters>]
19+
Get-VHDSnapshot [-Path] <String[]> [-GetParentPaths] [-SnapshotId <Guid[]>]
20+
[-CimSession <CimSession[]>] [-ComputerName <String[]>] [-Credential <PSCredential[]>]
21+
[<CommonParameters>]
2122
```
2223

2324
## DESCRIPTION
24-
The **Get-VHDSnapshot** cmdlet gets information about a checkpoint in a virtual hard disk (VHD) set file.
25+
26+
The `Get-VHDSnapshot` cmdlet gets information about a checkpoint in a virtual hard disk (VHD) set
27+
file.
2528

2629
Checkpoint replaces the previous term, snapshot.
2730

2831
## EXAMPLES
2932

3033
### Example 1: Get information about a checkpoint
31-
```
32-
PS C:\> Get-VHDSnapshot -Path "Data01.vhds" -SnapshotId 6c87351a-a39a-4581-b231-6d693b26485d
34+
35+
```powershell
36+
Get-VHDSnapshot -Path "Data01.vhds" -SnapshotId 6c87351a-a39a-4581-b231-6d693b26485d
3337
```
3438

35-
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.
39+
This command gets information about the checkpoint that has the specified ID from the VHD set file
40+
named `Data01.vhds` in the current working folder.
3641

3742
## PARAMETERS
3843

3944
### -CimSession
40-
Runs the cmdlet in a remote session or on a remote computer.
41-
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
42-
The default is the current session on the local computer.
45+
46+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
47+
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
48+
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
49+
current session on the local computer.
4350

4451
```yaml
4552
Type: CimSession[]
4653
Parameter Sets: (All)
47-
Aliases:
54+
Aliases:
4855

4956
Required: False
5057
Position: Named
@@ -54,15 +61,15 @@ Accept wildcard characters: False
5461
```
5562
5663
### -ComputerName
57-
Specifies one or more Hyper-V hosts that run this command.
58-
NetBIOS names, IP addresses, and fully qualified domain names are allowable.
59-
The default is the local computer.
60-
Use localhost or a dot (.) to specify the local computer explicitly.
64+
65+
Specifies one or more Hyper-V hosts that run this command. NetBIOS names, IP addresses, and fully
66+
qualified domain names are allowable. The default is the local computer. Use `localhost` or a dot
67+
(`.`) to specify the local computer explicitly.
6168

6269
```yaml
6370
Type: String[]
6471
Parameter Sets: (All)
65-
Aliases:
72+
Aliases:
6673
6774
Required: False
6875
Position: Named
@@ -72,13 +79,14 @@ Accept wildcard characters: False
7279
```
7380

7481
### -Credential
75-
Specifies one or more user accounts that have permission to perform this action.
76-
The default is the current user.
82+
83+
Specifies one or more user accounts that have permission to perform this action. The default is the
84+
current user.
7785

7886
```yaml
7987
Type: PSCredential[]
8088
Parameter Sets: (All)
81-
Aliases:
89+
Aliases:
8290
8391
Required: False
8492
Position: Named
@@ -88,12 +96,13 @@ Accept wildcard characters: False
8896
```
8997

9098
### -GetParentPaths
99+
91100
Gets the paths of all files on which this VHD checkpoint depends.
92101

93102
```yaml
94103
Type: SwitchParameter
95104
Parameter Sets: (All)
96-
Aliases:
105+
Aliases:
97106
98107
Required: False
99108
Position: Named
@@ -103,8 +112,10 @@ Accept wildcard characters: False
103112
```
104113

105114
### -Path
106-
Specifies an array of paths of VHD set files from which this cmdlet gets checkpoints.
107-
If you specify a file name or relative path, the cmdlet determines the full path relative to the current working folder.
115+
116+
Specifies an array of paths of VHD set files from which this cmdlet gets checkpoints. If you specify
117+
a file name or relative path, the cmdlet determines the full path relative to the current working
118+
folder.
108119

109120
```yaml
110121
Type: String[]
@@ -119,12 +130,13 @@ Accept wildcard characters: False
119130
```
120131

121132
### -SnapshotId
133+
122134
Specifies an array of unique IDs of VHD checkpoints that this cmdlet gets from a VHD set file.
123135

124136
```yaml
125137
Type: Guid[]
126138
Parameter Sets: (All)
127-
Aliases:
139+
Aliases:
128140
129141
Required: False
130142
Position: Named
@@ -134,26 +146,24 @@ Accept wildcard characters: False
134146
```
135147

136148
### CommonParameters
137-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
149+
150+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
151+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
152+
-WarningAction, and -WarningVariable. For more information, see
153+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
138154

139155
## INPUTS
140156

157+
### System.String[]
158+
141159
## OUTPUTS
142160

143161
### Microsoft.Vhd.PowerShell.VHDSnapshotInfo
162+
144163
This cmdlet returns a **VHDSnapshotInfo** object.
145164

146165
## NOTES
147166

148167
## RELATED LINKS
149168

150-
[Export-VMSnapshot](./Export-VMSnapshot.md)
151-
152-
[Get-VMSnapshot](./Get-VMSnapshot.md)
153-
154-
[Rename-VMSnapshot](./Rename-VMSnapshot.md)
155-
156-
[Restore-VMSnapshot](./Restore-VMSnapshot.md)
157-
158-
[Get-VHDSet](./Get-VHDSet.md)
159-
169+
- [Remove-VHDSnapshot](remove-vhdsnapshot.md)

0 commit comments

Comments
 (0)