Skip to content

Commit ac62e15

Browse files
Merge pull request MicrosoftDocs#3447 from RobBiddle/Enable-DedupVolume.md#3424
Quality: PowerShell Summit Enable dedup volume.md#3424
2 parents 56d7662 + aa1c4e3 commit ac62e15

File tree

1 file changed

+79
-59
lines changed

1 file changed

+79
-59
lines changed

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

Lines changed: 79 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -16,63 +16,73 @@ Enables data deduplication on one or more volumes.
1616
## SYNTAX
1717

1818
```
19-
Enable-DedupVolume [-Volume] <String[]> [-DataAccess] [-UsageType <UsageType>] [-CimSession <CimSession[]>]
20-
[-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
19+
Enable-DedupVolume [-Volume] <String[]> [-DataAccess] [-UsageType <UsageType>]
20+
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
24-
The **Enable-DedupVolume** cmdlet enables data deduplication on one or more volumes.
25-
You can use the **Set-DedupVolume** cmdlet to customize the data deduplication settings.
26-
Data deduplication is disabled by default.
27-
Data deduplication is not supported for certain volumes, such as any volume that is not a NTFS file system or any volume that is smaller than 2 GB.
24+
25+
The `Enable-DedupVolume` cmdlet enables data deduplication on one or more volumes. You can use the
26+
`Set-DedupVolume` cmdlet to customize the data deduplication settings. Data deduplication is
27+
disabled by default. Data deduplication is not supported for certain volumes, such as any volume
28+
that is not a NTFS file system or any volume that is smaller than 2 GB.
2829

2930
## EXAMPLES
3031

3132
### Example 1: Enable data deduplication on volumes
32-
```
33-
PS C:\> Enable-DedupVolume -Volume "D:","E:","F:"
33+
34+
```powershell
35+
Enable-DedupVolume -Volume "D:","E:","F:"
3436
```
3537

36-
This command enables data deduplication on volumes D:, E:, and F:.
37-
This command does not specify a value for the **UsageType** parameter, and, therefore, the cmdlet uses defaults for general purpose file server operations.
38+
This command enables data deduplication on volumes `D:`, `E:`, and `F:`. This command does not
39+
specify a value for the **UsageType** parameter, and, therefore, the cmdlet uses defaults for
40+
general purpose file server operations.
3841

3942
### Example 2: Enable data deduplication on a volume for Hyper-V storage
40-
```
41-
PS C:\> Enable-DedupVolume -Volume "D:" -UsageType HyperV
43+
44+
```powershell
45+
Enable-DedupVolume -Volume "D:" -UsageType HyperV
4246
```
4347

44-
This command enables data duplication on the D: volume.
45-
The command specifies Hyper-V storage as the usage type for this volume.
48+
This command enables data duplication on the D: volume. The command specifies Hyper-V storage as the
49+
usage type for this volume.
4650

4751
### Example 3: Enable data deduplication on a volume by using a GUID
48-
```
49-
PS C:\> Enable-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\"
52+
53+
```powershell
54+
Enable-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\"
5055
```
5156

52-
This command enables data deduplication for the volume that has the GUID 26a21bda-a627-11d7-9931-806e6f6e6963.
57+
This command enables data deduplication for the volume that has the GUID
58+
`26a21bda-a627-11d7-9931-806e6f6e6963`.
5359

5460
### Example 4: Resume I/O activity on a specified volume/
55-
```
56-
PS C:\> Enable-DedupVolume -Volume "X:" -DataAccess
61+
62+
```powershell
63+
Enable-DedupVolume -Volume "X:" -DataAccess
5764
```
5865

59-
This command resumes I/O activity for data deduplication on the specified volume.
60-
Effectively, this command causes the data deduplication file system mini-filter to attach to the specified volume
66+
This command resumes I/O activity for data deduplication on the specified volume. Effectively, this
67+
command causes the data deduplication file system mini-filter to attach to the specified volume
6168

6269
## PARAMETERS
6370

6471
### -AsJob
65-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
6672

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

72-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
76+
The cmdlet immediately returns an object that represents the job and then displays the command
77+
prompt. You can continue to work in the session while the job completes. To manage the job, use the
78+
`*-Job` cmdlets. To get the job results, use the
79+
[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
80+
81+
For more information about Windows PowerShell background jobs, see
82+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
7383

7484
```yaml
75-
Type: SwitchParameter
85+
Type: System.Management.Automation.SwitchParameter
7686
Parameter Sets: (All)
7787
Aliases:
7888

@@ -84,12 +94,14 @@ Accept wildcard characters: False
8494
```
8595
8696
### -CimSession
87-
Runs the cmdlet in a remote session or on a remote computer.
88-
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.
89-
The default is the current session on the local computer.
97+
98+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
99+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
100+
[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
101+
current session on the local computer.
90102
91103
```yaml
92-
Type: CimSession[]
104+
Type: Microsoft.Management.Infrastructure.CimSession[]
93105
Parameter Sets: (All)
94106
Aliases: Session
95107

@@ -101,10 +113,11 @@ Accept wildcard characters: False
101113
```
102114
103115
### -DataAccess
116+
104117
Indicates that data access to deduplicated files on the volume is enabled.
105118
106119
```yaml
107-
Type: SwitchParameter
120+
Type: System.Management.Automation.SwitchParameter
108121
Parameter Sets: (All)
109122
Aliases:
110123

@@ -116,12 +129,15 @@ Accept wildcard characters: False
116129
```
117130
118131
### -ThrottleLimit
119-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
120-
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.
121-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
132+
133+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
134+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
135+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
136+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
137+
computer.
122138

123139
```yaml
124-
Type: Int32
140+
Type: System.Int32
125141
Parameter Sets: (All)
126142
Aliases:
127143
@@ -133,22 +149,21 @@ Accept wildcard characters: False
133149
```
134150

135151
### -UsageType
136-
Specifies the expected type of workload for the volume.
137-
This cmdlet sets several low-level settings to default values that are appropriate to the usage type that you specify.
138-
If you specify this parameter for a volume that already has data deduplication enabled, the cmdlet modifies the settings to the appropriate default values.
139-
If you run this cmdlet on a volume that already has data deduplication enabled but do not specify this parameter, the cmdlet does not change the usage type.
152+
153+
Specifies the expected type of workload for the volume. This cmdlet sets several low-level settings
154+
to default values that are appropriate to the usage type that you specify. If you specify this
155+
parameter for a volume that already has data deduplication enabled, the cmdlet modifies the settings
156+
to the appropriate default values. If you run this cmdlet on a volume that already has data
157+
deduplication enabled but do not specify this parameter, the cmdlet does not change the usage type.
140158
The acceptable values for this parameter are:
141159

142-
- HyperV.
143-
A volume for Hyper-V storage.
144-
- Backup.
145-
A volume that is optimized for virtualized backup servers.
146-
- Default.
147-
A general purpose volume.
148-
If you do not specify a value for this parameter, the cmdlet uses a value of Default.
160+
- `HyperV` A volume for Hyper-V storage.
161+
- `Backup` A volume that is optimized for virtualized backup servers.
162+
- `Default` A general purpose volume. If you do not specify a value for this parameter, the cmdlet
163+
uses a value of Default.
149164

150-
If you specify a value of HyperV, the computer that has data deduplication enabled cannot be the same computer that runs Hyper-V.
151-
The two computers must communicate remotely.
165+
If you specify a value of HyperV, the computer that has data deduplication enabled cannot be the
166+
same computer that runs Hyper-V. The two computers must communicate remotely.
152167

153168
```yaml
154169
Type: UsageType
@@ -164,14 +179,13 @@ Accept wildcard characters: False
164179
```
165180

166181
### -Volume
167-
Specifies an array of system volumes.
168-
Specify one or more volume IDs, drive letters, or volume GUID paths.
169-
For drive letters, use the format D:.
170-
For volume GUID paths, use the format \\\\?\Volume{{GUID}}\.
171-
Separate multiple volumes with a comma.
182+
183+
Specifies an array of system volumes. Specify one or more volume IDs, drive letters, or volume GUID
184+
paths. For drive letters, use the format D:. For volume GUID paths, use the format
185+
`\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
172186
173187
```yaml
174-
Type: String[]
188+
Type: System.String[]
175189
Parameter Sets: (All)
176190
Aliases: DeviceId, Path, Name
177191

@@ -183,7 +197,11 @@ Accept wildcard characters: False
183197
```
184198
185199
### CommonParameters
186-
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).
200+
201+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
202+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
203+
-WarningAction, and -WarningVariable. For more information, see
204+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
187205
188206
## INPUTS
189207
@@ -192,8 +210,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
192210
## OUTPUTS
193211
194212
### Microsoft.Management.Infrastructure.CimInstance
195-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
196-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
213+
214+
The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
215+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
216+
namespace and class name for the underlying WMI object.
197217

198218
## NOTES
199219

0 commit comments

Comments
 (0)