Skip to content

Commit 8727c92

Browse files
committed
Updated ReFSDedup command set
1 parent cb7bc58 commit 8727c92

15 files changed

+689
-152
lines changed
Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Microsoft.ReFsDedup.Commands.dll-Help.xml
33
Module Name: Microsoft.ReFsDedup.Commands
4-
ms.date: 02/21/2024
4+
ms.date: 11/20/2024
55
online version: https://learn.microsoft.com/powershell/module/microsoft.refsdedup.commands/clear-refsdedupschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: Clear-ReFSDedupSchedule
@@ -10,7 +10,7 @@ title: Clear-ReFSDedupSchedule
1010
# Clear-ReFSDedupSchedule
1111

1212
## SYNOPSIS
13-
{{ Fill in the Synopsis }}
13+
Clears the scheduled task for deduplication on a specified ReFS volume.
1414

1515
## SYNTAX
1616

@@ -19,24 +19,28 @@ Clear-ReFSDedupSchedule [-Volume] <String> [<CommonParameters>]
1919
```
2020

2121
## DESCRIPTION
22-
{{ Fill in the Description }}
22+
23+
The `Clear-ReFSDedupSchedule` cmdlet clears the scheduled task for deduplication on the specified
24+
ReFS volume.
2325

2426
## EXAMPLES
2527

2628
### Example 1
29+
2730
```powershell
28-
PS C:\> {{ Add example code here }}
31+
Clear-ReFSDedupSchedule -Volume "D:"
2932
```
3033

31-
{{ Add example description here }}
34+
This example clears the scheduled task for volume `D:`.
3235

3336
## PARAMETERS
3437

3538
### -Volume
36-
{{ Fill Volume Description }}
39+
40+
Specifies the volume or volumes to clear the scheduled optimization task.
3741

3842
```yaml
39-
Type: System.String
43+
Type: String
4044
Parameter Sets: (All)
4145
Aliases:
4246

@@ -48,7 +52,11 @@ Accept wildcard characters: False
4852
```
4953
5054
### CommonParameters
51-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
55+
56+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
57+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
58+
-WarningAction, and -WarningVariable. For more information, see
59+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
5260
5361
## INPUTS
5462
@@ -57,6 +65,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
5765
## OUTPUTS
5866
5967
### System.Object
68+
6069
## NOTES
6170
6271
## RELATED LINKS
72+
73+
[Get-ReFSDedupSchedule](Get-ReFSDedupSchedule.md)
74+
75+
[Resume-ReFSDedupSchedule](Resume-ReFSDedupSchedule.md)
76+
77+
[Set-ReFSDedupSchedule](Set-ReFSDedupSchedule.md)
78+
79+
[Suspend-ReFSDedupSchedule](Suspend-ReFSDedupSchedule.md)
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
external help file: Microsoft.ReFsDedup.Commands.dll-Help.xml
3+
Module Name: Microsoft.ReFsDedup.Commands
4+
ms.date: 11/20/2024
5+
online version: https://learn.microsoft.com/powershell/module/microsoft.refsdedup.commands/clear-refsdedupscrubschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
6+
schema: 2.0.0
7+
title: Clear-ReFSDedupScrubSchedule
8+
---
9+
10+
# Clear-ReFSDedupScrubSchedule
11+
12+
## SYNOPSIS
13+
Clears the deduplication scrub schedule on a specified ReFS volume.
14+
15+
## SYNTAX
16+
17+
```
18+
Clear-ReFSDedupScrubSchedule [-Volume] <String> [<CommonParameters>]
19+
```
20+
21+
## DESCRIPTION
22+
23+
The `Clear-ReFSDedupScrubSchedule` cmdlet clears the deduplication scrub schedule on a specified
24+
ReFS volume. When you clear the schedule, any pending scrub jobs will be cancelled and the schedule
25+
will be reset.
26+
27+
## EXAMPLES
28+
29+
### Example 1
30+
31+
```powershell
32+
Clear-ReFSDedupScrubSchedule -Volume "D:"
33+
```
34+
35+
This example clears the deduplication scrub schedule on the `D:` ReFS volume.
36+
37+
## PARAMETERS
38+
39+
### -Volume
40+
41+
Specifies the volume on which to clear the ReFS deduplication scrub schedule.
42+
43+
```yaml
44+
Type: String
45+
Parameter Sets: (All)
46+
Aliases:
47+
48+
Required: True
49+
Position: 0
50+
Default value: None
51+
Accept pipeline input: False
52+
Accept wildcard characters: False
53+
```
54+
55+
### CommonParameters
56+
57+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
58+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
59+
-WarningAction, and -WarningVariable. For more information, see
60+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
61+
62+
## INPUTS
63+
64+
### None
65+
66+
## OUTPUTS
67+
68+
### System.Object
69+
70+
## NOTES
71+
72+
## RELATED LINKS
73+
74+
[Get-ReFSDedupScrubSchedule](Get-ReFSDedupScrubSchedule.md)
75+
76+
[Set-ReFSDedupScrubSchedule](Set-ReFSDedupScrubSchedule.md)
Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Microsoft.ReFsDedup.Commands.dll-Help.xml
33
Module Name: Microsoft.ReFsDedup.Commands
4-
ms.date: 02/21/2024
4+
ms.date: 11/20/2024
55
online version: https://learn.microsoft.com/powershell/module/microsoft.refsdedup.commands/disable-refsdedup?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: Disable-ReFSDedup
@@ -10,7 +10,7 @@ title: Disable-ReFSDedup
1010
# Disable-ReFSDedup
1111

1212
## SYNOPSIS
13-
{{ Fill in the Synopsis }}
13+
Disables data deduplication on a specified ReFS volume.
1414

1515
## SYNTAX
1616

@@ -19,24 +19,29 @@ Disable-ReFSDedup [-Volume] <String> [<CommonParameters>]
1919
```
2020

2121
## DESCRIPTION
22-
{{ Fill in the Description }}
22+
23+
The `Disable-ReFSDedup` cmdlet disables data deduplication on a specified ReFS volume. This cmdlet
24+
does not affect existing deduplicated files or folders on the volume, but it prevents new files or
25+
folders from being deduplicated.
2326

2427
## EXAMPLES
2528

2629
### Example 1
30+
2731
```powershell
28-
PS C:\> {{ Add example code here }}
32+
Disable-ReFSDedup -Volume "D:"
2933
```
3034

31-
{{ Add example description here }}
35+
This example disables data deduplication on the `D:` ReFS volume.
3236

3337
## PARAMETERS
3438

3539
### -Volume
36-
{{ Fill Volume Description }}
40+
41+
Specifies the volume or volumes to disable ReFS data deduplication.
3742

3843
```yaml
39-
Type: System.String
44+
Type: String
4045
Parameter Sets: (All)
4146
Aliases:
4247

@@ -48,7 +53,11 @@ Accept wildcard characters: False
4853
```
4954
5055
### CommonParameters
51-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
56+
57+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
58+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
59+
-WarningAction, and -WarningVariable. For more information, see
60+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
5261
5362
## INPUTS
5463
@@ -57,6 +66,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
5766
## OUTPUTS
5867
5968
### System.Object
69+
6070
## NOTES
6171
6272
## RELATED LINKS
73+
74+
[Enable-ReFSDedup](Enable-ReFSDedup.md)

docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Enable-ReFSDedup.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Microsoft.ReFsDedup.Commands.dll-Help.xml
33
Module Name: Microsoft.ReFsDedup.Commands
4-
ms.date: 02/21/2024
4+
ms.date: 11/20/2024
55
online version: https://learn.microsoft.com/powershell/module/microsoft.refsdedup.commands/enable-refsdedup?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: Enable-ReFSDedup
@@ -10,7 +10,7 @@ title: Enable-ReFSDedup
1010
# Enable-ReFSDedup
1111

1212
## SYNOPSIS
13-
{{ Fill in the Synopsis }}
13+
Enables data deduplication on a specified ReFS volume.
1414

1515
## SYNTAX
1616

@@ -19,24 +19,33 @@ Enable-ReFSDedup [-Volume] <String> [-Type] <DedupVolumeType> [<CommonParameters
1919
```
2020

2121
## DESCRIPTION
22-
{{ Fill in the Description }}
22+
23+
The `Enable-ReFSDedup` cmdlet enables data deduplication on a specified ReFS volume. You can
24+
specify the type of deduplication to use with the `-Type` parameter.
2325

2426
## EXAMPLES
2527

2628
### Example 1
29+
2730
```powershell
28-
PS C:\> {{ Add example code here }}
31+
Enable-ReFSDedup -Volume "D:" -Type DedupAndCompress
32+
2933
```
3034

31-
{{ Add example description here }}
35+
This example enables data deduplication with compression on the `D:` ReFS volume.
3236

3337
## PARAMETERS
3438

3539
### -Type
36-
{{ Fill Type Description }}
40+
41+
Specifies the type of deduplication to use. Acceptable values are:
42+
43+
- `Compress`
44+
- `Dedup`
45+
- `DedupAndCompress`
3746

3847
```yaml
39-
Type: Microsoft.ReFS.DeDup.DedupVolumeType
48+
Type: DedupVolumeType
4049
Parameter Sets: (All)
4150
Aliases:
4251
Accepted values: Dedup, DedupAndCompress, Compress
@@ -49,10 +58,11 @@ Accept wildcard characters: False
4958
```
5059
5160
### -Volume
52-
{{ Fill Volume Description }}
61+
62+
Specifies the volume or volumes to enable ReFS data deduplication.
5363
5464
```yaml
55-
Type: System.String
65+
Type: String
5666
Parameter Sets: (All)
5767
Aliases:
5868

@@ -64,7 +74,11 @@ Accept wildcard characters: False
6474
```
6575
6676
### CommonParameters
67-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
77+
78+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
79+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
80+
-WarningAction, and -WarningVariable. For more information, see
81+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
6882
6983
## INPUTS
7084
@@ -73,6 +87,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
7387
## OUTPUTS
7488
7589
### System.Object
90+
7691
## NOTES
7792
7893
## RELATED LINKS
94+
95+
[Disable-ReFSDedup](Disable-ReFSDedup.md)

0 commit comments

Comments
 (0)