Skip to content

Commit 56d7662

Browse files
Merge pull request MicrosoftDocs#3446 from RobBiddle/Disable-DedupVolume.md#3423
Quality: PowerShell Summit Disable dedup volume.md#3423
2 parents 8932929 + c6ddfcd commit 56d7662

File tree

1 file changed

+69
-46
lines changed

1 file changed

+69
-46
lines changed

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

Lines changed: 69 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -16,60 +16,72 @@ Disables data deduplication activity on one or more volumes.
1616
## SYNTAX
1717

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

2323
## DESCRIPTION
24-
The **Disable-DedupVolume** cmdlet disables further data deduplication activity on one or more volumes.
25-
After you disable data deduplication, the volume remains in a deduplicated state and the existing deduplicated data is accessible.
26-
The server stops running data deduplication jobs for the volume and new data is not deduplicated.
27-
To undo data deduplication on a volume, use the **Start-DedupJob** cmdlet and specify Unoptimization for the *Type* parameter.
2824

29-
After you disable data deduplication on a volume, you can perform all read-only deduplication cmdlet operations on the volume.
30-
For example, you can use the **Get-DedupStatus** cmdlet to get deduplication status for a volume that has data deduplication metadata.
31-
After you disable data deduplication on a volume, you cannot use the data deduplication job-related cmdlets and the **Update-DedupStatus** cmdlet to perform operations on the volume.
32-
For example, you cannot use **Start-DedupJob** to start a data deduplication job for a volume on which you have disabled data deduplication.
25+
The `Disable-DedupVolume` cmdlet disables further data deduplication activity on one or more
26+
volumes. After you disable data deduplication, the volume remains in a deduplicated state and the
27+
existing deduplicated data is accessible. The server stops running data deduplication jobs for the
28+
volume and new data is not deduplicated. To undo data deduplication on a volume, use the
29+
`Start-DedupJob` cmdlet and specify `Unoptimization` for the **Type** parameter.
30+
31+
After you disable data deduplication on a volume, you can perform all read-only deduplication cmdlet
32+
operations on the volume. For example, you can use the `Get-DedupStatus` cmdlet to get deduplication
33+
status for a volume that has data deduplication metadata. After you disable data deduplication on a
34+
volume, you cannot use the data deduplication job-related cmdlets and the `Update-DedupStatus`
35+
cmdlet to perform operations on the volume. For example, you cannot use `Start-DedupJob` to start a
36+
data deduplication job for a volume on which you have disabled data deduplication.
3337

3438
## EXAMPLES
3539

3640
### Example 1: Disable data deduplication on volumes
37-
```
38-
PS C:\> Disable-DedupVolume -Volume "D:","E:","F:","G:"
41+
42+
```powershell
43+
Disable-DedupVolume -Volume "D:","E:","F:","G:"
3944
```
4045

41-
This command disables data deduplication for volumes D:, E:, F:, and G:.
46+
This command disables data deduplication for volumes `D:`, `E:`, `F:`, and `G:`.
4247

4348
### Example 2: Disable data deduplication on a volume by using a GUID
44-
```
45-
PS C:\> Disable-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\"
49+
50+
```powershell
51+
Disable-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\"
4652
```
4753

48-
This command disables data deduplication for the volume that has the GUID 26a21bda-a627-11d7-9931-806e6f6e6963.
54+
This command disables data deduplication for the volume that has the GUID
55+
`26a21bda-a627-11d7-9931-806e6f6e6963`.
4956

5057
### Example 3: Suspend I/O activity for a specified volume
51-
```
52-
PS C:\> Disable-DedupVolume -Volume "X:" -DataAccess
58+
59+
```powershell
60+
Disable-DedupVolume -Volume "X:" -DataAccess
5361
```
5462

55-
This command suspends I/O activity for data deduplication on the specified volume.
56-
Effectively, this command causes the data deduplication file system mini-filter to detach from the specified volume.
57-
After this command completes, I/O to data deduplication files fails with an ERROR_INVALID_FUNCTION error until either the `Enable-DedupVolume -DataAccess` command runs, or the server restarts.
63+
This command suspends I/O activity for data deduplication on the specified volume. Effectively, this
64+
command causes the data deduplication file system mini-filter to detach from the specified volume.
65+
After this command completes, I/O to data deduplication files fails with an `ERROR_INVALID_FUNCTION`
66+
error until either the `Enable-DedupVolume -DataAccess` command runs, or the server restarts.
5867

5968
## PARAMETERS
6069

6170
### -AsJob
62-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
6371

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

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

7183
```yaml
72-
Type: SwitchParameter
84+
Type: System.Management.Automation.SwitchParameter
7385
Parameter Sets: (All)
7486
Aliases:
7587

@@ -81,12 +93,14 @@ Accept wildcard characters: False
8193
```
8294
8395
### -CimSession
84-
Runs the cmdlet in a remote session or on a remote computer.
85-
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.
86-
The default is the current session on the local computer.
96+
97+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
98+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
99+
[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
100+
current session on the local computer.
87101
88102
```yaml
89-
Type: CimSession[]
103+
Type: Microsoft.Management.Infrastructure.CimSession[]
90104
Parameter Sets: (All)
91105
Aliases: Session
92106

@@ -98,10 +112,11 @@ Accept wildcard characters: False
98112
```
99113
100114
### -DataAccess
115+
101116
Indicates that data access to deduplicated files on the volume is disabled.
102117
103118
```yaml
104-
Type: SwitchParameter
119+
Type: System.Management.Automation.SwitchParameter
105120
Parameter Sets: (All)
106121
Aliases:
107122

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

120138
```yaml
121-
Type: Int32
139+
Type: System.Int32
122140
Parameter Sets: (All)
123141
Aliases:
124142
@@ -130,14 +148,13 @@ Accept wildcard characters: False
130148
```
131149

132150
### -Volume
133-
Specifies an array of system volumes for which to disable data deduplication.
134-
Specify one or more volume IDs, drive letters, or volume GUID paths.
135-
For drive letters, use the format D:.
136-
For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`.
137-
Separate multiple volumes with a comma.
151+
152+
Specifies an array of system volumes for which to disable data deduplication. Specify one or more
153+
volume IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume
154+
GUID paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
138155

139156
```yaml
140-
Type: String[]
157+
Type: System.String[]
141158
Parameter Sets: (All)
142159
Aliases: DeviceId, Path, Name
143160
@@ -149,7 +166,11 @@ Accept wildcard characters: False
149166
```
150167

151168
### CommonParameters
152-
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).
169+
170+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
171+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
172+
-WarningAction, and -WarningVariable. For more information, see
173+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
153174

154175
## INPUTS
155176

@@ -158,8 +179,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
158179
## OUTPUTS
159180

160181
### Microsoft.Management.Infrastructure.CimInstance
161-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
162-
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.
163186

164187
## NOTES
165188

0 commit comments

Comments
 (0)