Skip to content

Commit db4824d

Browse files
Merge pull request MicrosoftDocs#3452 from RobBiddle/Get-DedupVolume.md#3430
Quality: PowerShell Summit Get dedup volume.md#3430
2 parents 239b252 + b226762 commit db4824d

File tree

1 file changed

+64
-38
lines changed

1 file changed

+64
-38
lines changed

docset/winserver2022-ps/deduplication/Get-DedupVolume.md

Lines changed: 64 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -16,53 +16,63 @@ Returns deduplication volumes that have data deduplication metadata.
1616
## SYNTAX
1717

1818
### ByVolumeId (Default)
19+
1920
```
20-
Get-DedupVolume [-VolumeId <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
21-
[<CommonParameters>]
21+
Get-DedupVolume [-VolumeId <String[]>] [-CimSession <CimSession[]>]
22+
[-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
2223
```
2324

2425
### ByVolume
26+
2527
```
26-
Get-DedupVolume [[-Volume] <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
27-
[<CommonParameters>]
28+
Get-DedupVolume [[-Volume] <String[]>] [-CimSession <CimSession[]>]
29+
[-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
2830
```
2931

3032
## DESCRIPTION
31-
The **Get-DedupVolume** cmdlet returns a **DeduplicationVolume** object for each volume that has data deduplication metadata, in either the enabled or disabled state.
32-
In a cluster, this cmdlet returns a **DeduplicationVolume** object only for volumes currently mounted by the managed node, whether the volumes are local or clustered volumes.
33+
34+
The `Get-DedupVolume` cmdlet returns a **DeduplicationVolume** object for each volume that has data
35+
deduplication metadata, in either the enabled or disabled state. In a cluster, this cmdlet returns a
36+
**DeduplicationVolume** object only for volumes currently mounted by the managed node, whether the
37+
volumes are local or clustered volumes.
3338

3439
To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option.
3540

3641
## EXAMPLES
3742

3843
### Example 1: Get settings for a volume identified by letter
39-
```
40-
PS C:\> Get-DedupVolume -Volume "E:"
44+
45+
```powershell
46+
Get-DedupVolume -Volume "E:"
4147
```
4248

43-
This command returns the data deduplication settings for volume E:.
49+
This command returns the data deduplication settings for volume `E:`.
4450

4551
### Example 2: Get settings for a volume specified by ID
46-
```
47-
PS C:\> Get-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\"
52+
53+
```powershell
54+
Get-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\"
4855
```
4956

5057
This command returns the data deduplication settings for the volume that has the specified GUID.
5158

5259
## PARAMETERS
5360

5461
### -AsJob
55-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
5662

57-
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
58-
You can continue to work in the session while the job completes.
59-
To manage the job, use the `*-Job` cmdlets.
60-
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
63+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
64+
complete.
65+
66+
The cmdlet immediately returns an object that represents the job and then displays the command
67+
prompt. You can continue to work in the session while the job completes. To manage the job, use the
68+
`*-Job` cmdlets. To get the job results, use the
69+
[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
6170

62-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
71+
For more information about Windows PowerShell background jobs, see
72+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
6373

6474
```yaml
65-
Type: SwitchParameter
75+
Type: System.Management.Automation.SwitchParameter
6676
Parameter Sets: (All)
6777
Aliases:
6878

@@ -74,12 +84,14 @@ Accept wildcard characters: False
7484
```
7585
7686
### -CimSession
77-
Runs the cmdlet in a remote session or on a remote computer.
78-
Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
79-
The default is the current session on the local computer.
87+
88+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
89+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
90+
[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
91+
current session on the local computer.
8092
8193
```yaml
82-
Type: CimSession[]
94+
Type: Microsoft.Management.Infrastructure.CimSession[]
8395
Parameter Sets: (All)
8496
Aliases: Session
8597

@@ -91,9 +103,12 @@ Accept wildcard characters: False
91103
```
92104
93105
### -ThrottleLimit
94-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
95-
If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
96-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
106+
107+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
108+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
109+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
110+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
111+
computer.
97112

98113
```yaml
99114
Type: Int32
@@ -108,14 +123,15 @@ Accept wildcard characters: False
108123
```
109124

110125
### -Volume
111-
Specifies one or more file system volumes for which to return data deduplication metadata, or in the case of a cluster, volumes with data deduplication metadata currently mounted by the managed node.
112-
Enter one or more volume IDs, drive letters, or volume GUID paths.
113-
For drive letters, use the format D:.
114-
For volume GUID paths, use the format \\\\?\Volume{{GUID}}\.
115-
Separate multiple volumes with a comma.
126+
127+
Specifies one or more file system volumes for which to return data deduplication metadata, or in the
128+
case of a cluster, volumes with data deduplication metadata currently mounted by the managed node.
129+
Enter one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the format
130+
`D:`. For volume GUID paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with
131+
a comma.
116132

117133
```yaml
118-
Type: String[]
134+
Type: System.String[]
119135
Parameter Sets: ByVolume
120136
Aliases:
121137
@@ -127,10 +143,12 @@ Accept wildcard characters: False
127143
```
128144

129145
### -VolumeId
130-
Specifies a string that uniquely identifies the volume on which to return data deduplication metadata.
146+
147+
Specifies a string that uniquely identifies the volume on which to return data deduplication
148+
metadata.
131149

132150
```yaml
133-
Type: String[]
151+
Type: System.String[]
134152
Parameter Sets: ByVolumeId
135153
Aliases: DeviceId, Path, Id
136154
@@ -142,7 +160,11 @@ Accept wildcard characters: False
142160
```
143161

144162
### CommonParameters
145-
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).
163+
164+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
165+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
166+
-WarningAction, and -WarningVariable. For more information, see
167+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
146168

147169
## INPUTS
148170

@@ -151,12 +173,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
151173
## OUTPUTS
152174

153175
### Microsoft.Management.Infrastructure.CimInstance
154-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
155-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
176+
177+
The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
178+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
179+
namespace and class name for the underlying WMI object.
156180

157181
### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupVolume
158-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
159-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
182+
183+
The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
184+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
185+
namespace and class name for the underlying WMI object.
160186

161187
## NOTES
162188

0 commit comments

Comments
 (0)