Skip to content

Commit 57e040e

Browse files
Albertyang0Albertyang0
authoredNov 28, 2024··
Merge branch 'main' into broken-links-fix-JasonGerend-2
2 parents bd7289c + bb3bdbc commit 57e040e

15 files changed

+729
-153
lines changed
 

‎docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md

Lines changed: 27 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,30 @@ Clear-ReFSDedupSchedule [-Volume] <String> [<CommonParameters>]
1919
```
2020

2121
## DESCRIPTION
22-
{{ Fill in the Description }}
22+
23+
The `Clear-ReFSDedupSchedule` cmdlet clears the scheduled job, including the schedule itself, for
24+
deduplication on the specified 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. Enter one or more volume
41+
IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID
42+
paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
3743

3844
```yaml
39-
Type: System.String
45+
Type: String
4046
Parameter Sets: (All)
4147
Aliases:
4248

@@ -48,7 +54,11 @@ Accept wildcard characters: False
4854
```
4955
5056
### 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).
57+
58+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
59+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
60+
-WarningAction, and -WarningVariable. For more information, see
61+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
5262
5363
## INPUTS
5464
@@ -57,6 +67,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
5767
## OUTPUTS
5868
5969
### System.Object
70+
6071
## NOTES
6172
6273
## RELATED LINKS
74+
75+
[Get-ReFSDedupSchedule](Get-ReFSDedupSchedule.md)
76+
77+
[Resume-ReFSDedupSchedule](Resume-ReFSDedupSchedule.md)
78+
79+
[Set-ReFSDedupSchedule](Set-ReFSDedupSchedule.md)
80+
81+
[Suspend-ReFSDedupSchedule](Suspend-ReFSDedupSchedule.md)

‎docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupScrubSchedule.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
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. Enter one or more
42+
volume IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume
43+
GUID paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
44+
45+
```yaml
46+
Type: String
47+
Parameter Sets: (All)
48+
Aliases:
49+
50+
Required: True
51+
Position: 0
52+
Default value: None
53+
Accept pipeline input: False
54+
Accept wildcard characters: False
55+
```
56+
57+
### CommonParameters
58+
59+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
60+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
61+
-WarningAction, and -WarningVariable. For more information, see
62+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
63+
64+
## INPUTS
65+
66+
### None
67+
68+
## OUTPUTS
69+
70+
### System.Object
71+
72+
## NOTES
73+
74+
## RELATED LINKS
75+
76+
[Get-ReFSDedupScrubSchedule](Get-ReFSDedupScrubSchedule.md)
77+
78+
[Set-ReFSDedupScrubSchedule](Set-ReFSDedupScrubSchedule.md)

‎docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Disable-ReFSDedup.md

Lines changed: 22 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,31 @@ 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. Enter one or more volume IDs,
42+
drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID paths,
43+
use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
3744

3845
```yaml
39-
Type: System.String
46+
Type: String
4047
Parameter Sets: (All)
4148
Aliases:
4249

@@ -48,7 +55,11 @@ Accept wildcard characters: False
4855
```
4956
5057
### 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).
58+
59+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
60+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
61+
-WarningAction, and -WarningVariable. For more information, see
62+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
5263
5364
## INPUTS
5465
@@ -57,6 +68,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
5768
## OUTPUTS
5869
5970
### System.Object
71+
6072
## NOTES
6173
6274
## RELATED LINKS
75+
76+
[Enable-ReFSDedup](Enable-ReFSDedup.md)

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

Lines changed: 36 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,40 @@ 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+
30+
```powershell
31+
Enable-ReFSDedup -Volume "D:" -Type DedupAndCompress
32+
```
33+
34+
This example enables data deduplication with compression on the `D:` ReFS volume.
35+
36+
### Example 2
37+
2738
```powershell
28-
PS C:\> {{ Add example code here }}
39+
Enable-ReFSDedup -Volume "E:, F:" -Type DedupAndCompress
2940
```
3041

31-
{{ Add example description here }}
42+
This example enables data deduplication with compression on both `E:` and `F:` ReFS volumes.
3243

3344
## PARAMETERS
3445

3546
### -Type
36-
{{ Fill Type Description }}
47+
48+
Specifies the type of deduplication to use. Acceptable values are:
49+
50+
- `Compress`
51+
- `Dedup`
52+
- `DedupAndCompress`
3753

3854
```yaml
39-
Type: Microsoft.ReFS.DeDup.DedupVolumeType
55+
Type: DedupVolumeType
4056
Parameter Sets: (All)
4157
Aliases:
4258
Accepted values: Dedup, DedupAndCompress, Compress
@@ -49,10 +65,13 @@ Accept wildcard characters: False
4965
```
5066
5167
### -Volume
52-
{{ Fill Volume Description }}
68+
69+
Specifies the volume or volumes to enable ReFS data deduplication. Enter one or more volume IDs,
70+
drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID paths,
71+
use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
5372

5473
```yaml
55-
Type: System.String
74+
Type: String
5675
Parameter Sets: (All)
5776
Aliases:
5877
@@ -64,7 +83,11 @@ Accept wildcard characters: False
6483
```
6584

6685
### 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).
86+
87+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
88+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
89+
-WarningAction, and -WarningVariable. For more information, see
90+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
6891

6992
## INPUTS
7093

@@ -73,6 +96,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
7396
## OUTPUTS
7497

7598
### System.Object
99+
76100
## NOTES
77101

78102
## RELATED LINKS
103+
104+
[Disable-ReFSDedup](Disable-ReFSDedup.md)

‎docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md

Lines changed: 27 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/get-refsdedupschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: Get-ReFSDedupSchedule
@@ -10,7 +10,7 @@ title: Get-ReFSDedupSchedule
1010
# Get-ReFSDedupSchedule
1111

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

1515
## SYNTAX
1616

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

2121
## DESCRIPTION
22-
{{ Fill in the Description }}
22+
23+
The `Get-ReFSDedupSchedule` cmdlet retrieves the deduplication schedule for a specified ReFS
24+
volume.
2325

2426
## EXAMPLES
2527

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

31-
{{ Add example description here }}
34+
This example retrieves the deduplication schedule for the `D:` ReFS volume.
3235

3336
## PARAMETERS
3437

3538
### -Volume
36-
{{ Fill Volume Description }}
39+
40+
Specifies the ReFS volume for which to retrieve the deduplication schedule. Enter one or more volume
41+
IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID
42+
paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
3743

3844
```yaml
39-
Type: System.String
45+
Type: String
4046
Parameter Sets: (All)
4147
Aliases:
4248

@@ -48,7 +54,11 @@ Accept wildcard characters: False
4854
```
4955
5056
### 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).
57+
58+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
59+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
60+
-WarningAction, and -WarningVariable. For more information, see
61+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
5262
5363
## INPUTS
5464
@@ -57,6 +67,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
5767
## OUTPUTS
5868
5969
### System.Object
70+
6071
## NOTES
6172
6273
## RELATED LINKS
74+
75+
[Clear-ReFSDedupSchedule](Clear-ReFSDedupSchedule.md)
76+
77+
[Resume-ReFSDedupSchedule](Resume-ReFSDedupSchedule.md)
78+
79+
[Set-ReFSDedupSchedule](Set-ReFSDedupSchedule.md)
80+
81+
[Suspend-ReFSDedupSchedule](Suspend-ReFSDedupSchedule.md)

‎docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
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/get-refsdedupscrubschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
6+
schema: 2.0.0
7+
title: Get-ReFSDedupScrubSchedule
8+
---
9+
10+
# Get-ReFSDedupScrubSchedule
11+
12+
## SYNOPSIS
13+
Retrieves the deduplication scrub schedule on the specified ReFS volume.
14+
15+
## SYNTAX
16+
17+
```
18+
Get-ReFSDedupScrubSchedule [-Volume] <String> [<CommonParameters>]
19+
```
20+
21+
## DESCRIPTION
22+
23+
The `Get-ReFSDedupScrubSchedule` cmdlet retrieves the deduplication scrub schedule on the specified
24+
ReFS volume.
25+
26+
## EXAMPLES
27+
28+
### Example 1
29+
30+
```powershell
31+
Get-ReFSDedupScrubSchedule -Volume "D:"
32+
```
33+
34+
This example gets the deduplication scrub schedule on the `D:` ReFS volume.
35+
36+
## PARAMETERS
37+
38+
### -Volume
39+
40+
Specifies the volume on which to retrieve the ReFS deduplication scrub schedule. Enter one or more
41+
volume IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume
42+
GUID paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
43+
44+
```yaml
45+
Type: String
46+
Parameter Sets: (All)
47+
Aliases:
48+
49+
Required: True
50+
Position: 0
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
56+
### CommonParameters
57+
58+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
59+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
60+
-WarningAction, and -WarningVariable. For more information, see
61+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
62+
63+
## INPUTS
64+
65+
### None
66+
67+
## OUTPUTS
68+
69+
### System.Object
70+
71+
## NOTES
72+
73+
## RELATED LINKS
74+
75+
[Clear-ReFSDedupScrubSchedule](Clear-ReFSDedupScrubSchedule.md)
76+
77+
[Set-ReFSDedupScrubSchedule](Set-ReFSDedupScrubSchedule.md)

‎docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md

Lines changed: 30 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/get-refsdedupstatus?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: Get-ReFSDedupStatus
@@ -10,7 +10,7 @@ title: Get-ReFSDedupStatus
1010
# Get-ReFSDedupStatus
1111

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

1515
## SYNTAX
1616

@@ -19,24 +19,41 @@ Get-ReFSDedupStatus [-Volume] <String> [<CommonParameters>]
1919
```
2020

2121
## DESCRIPTION
22-
{{ Fill in the Description }}
22+
23+
The `Get-ReFSDedupStatus` cmdlet retrieves the status of data deduplication on a specified ReFS
24+
volume.
2325

2426
## EXAMPLES
2527

2628
### Example 1
29+
30+
```powershell
31+
Get-ReFSDedupStatus -Volume "D:"
32+
```
33+
34+
This example retrieves the deduplication status for the `D:` ReFS volume.
35+
36+
### Example 2
37+
2738
```powershell
28-
PS C:\> {{ Add example code here }}
39+
$Volumes = "E:", "F:"
40+
foreach ($Volume in $Volumes) {
41+
Get-ReFSDedupStatus -Volume $Volume
42+
}
2943
```
3044

31-
{{ Add example description here }}
45+
This example retrieves the deduplication status for both the `E:` and `F:` ReFS volume.
3246

3347
## PARAMETERS
3448

3549
### -Volume
36-
{{ Fill Volume Description }}
50+
51+
Specifies the ReFS volume for which to retrieve the deduplication status. Enter one or more volume
52+
IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID
53+
paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
3754

3855
```yaml
39-
Type: System.String
56+
Type: String
4057
Parameter Sets: (All)
4158
Aliases:
4259

@@ -48,7 +65,11 @@ Accept wildcard characters: False
4865
```
4966
5067
### 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).
68+
69+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
70+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
71+
-WarningAction, and -WarningVariable. For more information, see
72+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
5273
5374
## INPUTS
5475
@@ -57,6 +78,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
5778
## OUTPUTS
5879
5980
### System.Object
81+
6082
## NOTES
6183
6284
## RELATED LINKS

‎docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Microsoft.ReFsDedup.Commands.md

Lines changed: 38 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,68 @@ Help Version: 5.1.0.2025
44
Locale: en-US
55
Module Guid: 63145e13-3dcf-4fa5-acef-9a437f2d9871
66
Module Name: Microsoft.ReFsDedup.Commands
7-
ms.date: 02/21/2024
7+
ms.date: 11/20/2024
88
title: Microsoft.ReFsDedup.Commands module
99
---
1010

1111
# Microsoft.ReFsDedup.Commands Module
12+
1213
## Description
13-
{{ Fill in the Description }}
14+
15+
This reference provides cmdlet descriptions and syntax for all Windows Server ReFS
16+
Deduplication-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the
17+
beginning of the cmdlet.
1418

1519
## Microsoft.ReFsDedup.Commands Cmdlets
20+
1621
### [Clear-ReFSDedupSchedule](Clear-ReFSDedupSchedule.md)
17-
{{ Fill in the Description }}
22+
23+
Clears the scheduled job and the schedule itself for deduplication on a specified ReFS volume.
24+
25+
### [Clear-ReFSDedupScrubSchedule.md](Clear-ReFSDedupScrubSchedule.md)
26+
27+
Clears the deduplication scrub schedule on a specified ReFS volume.
1828

1929
### [Disable-ReFSDedup](Disable-ReFSDedup.md)
20-
{{ Fill in the Description }}
30+
31+
Disables data deduplication on a specified ReFS volume.
2132

2233
### [Enable-ReFSDedup](Enable-ReFSDedup.md)
23-
{{ Fill in the Description }}
34+
35+
Enables data deduplication on a specified ReFS volume.
2436

2537
### [Get-ReFSDedupSchedule](Get-ReFSDedupSchedule.md)
26-
{{ Fill in the Description }}
38+
39+
Retrieves the deduplication schedule for a specified ReFS volume.
40+
41+
### [Get-ReFSDedupScrubSchedule](Get-ReFSDedupScrubSchedule.md)
42+
43+
Retrieves the deduplication scrub schedule on the specified ReFS volume.
2744

2845
### [Get-ReFSDedupStatus](Get-ReFSDedupStatus.md)
29-
{{ Fill in the Description }}
46+
47+
Retrieves the status of data deduplication on a specified ReFS volume.
3048

3149
### [Resume-ReFSDedupSchedule](Resume-ReFSDedupSchedule.md)
32-
{{ Fill in the Description }}
50+
51+
Resumes the deduplication schedule on a specified ReFS volume.
3352

3453
### [Set-ReFSDedupSchedule](Set-ReFSDedupSchedule.md)
35-
{{ Fill in the Description }}
54+
55+
Sets the deduplication schedule on a specified ReFS volume.
56+
57+
### [Set-ReFSDedupScrubSchedule](Set-ReFSDedupScrubSchedule.md)
58+
59+
Sets the deduplication scrub schedule on the specified ReFS volume.
3660

3761
### [Start-ReFSDedupJob](Start-ReFSDedupJob.md)
38-
{{ Fill in the Description }}
62+
63+
Starts a deduplication job on the specified ReFS volume.
3964

4065
### [Stop-ReFSDedupJob](Stop-ReFSDedupJob.md)
41-
{{ Fill in the Description }}
66+
67+
Stops a running deduplication job on a specified ReFS volume.
4268

4369
### [Suspend-ReFSDedupSchedule](Suspend-ReFSDedupSchedule.md)
44-
{{ Fill in the Description }}
4570

71+
Suspends the deduplication schedule on a specified ReFS volume.

‎docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Resume-ReFSDedupSchedule.md

Lines changed: 27 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/resume-refsdedupschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: Resume-ReFSDedupSchedule
@@ -10,7 +10,7 @@ title: Resume-ReFSDedupSchedule
1010
# Resume-ReFSDedupSchedule
1111

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

1515
## SYNTAX
1616

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

2121
## DESCRIPTION
22-
{{ Fill in the Description }}
22+
23+
The `Resume-ReFSDedupSchedule` cmdlet resumes the deduplication schedule on a specified ReFS
24+
volume that has been paused or stopped.
2325

2426
## EXAMPLES
2527

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

31-
{{ Add example description here }}
34+
This example resumes the deduplication schedule for the `D:` ReFS volume.
3235

3336
## PARAMETERS
3437

3538
### -Volume
36-
{{ Fill Volume Description }}
39+
40+
Specifies the ReFS volume for which to resume the deduplication schedule. Enter one or more volume
41+
IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID
42+
paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
3743

3844
```yaml
39-
Type: System.String
45+
Type: String
4046
Parameter Sets: (All)
4147
Aliases:
4248

@@ -48,7 +54,11 @@ Accept wildcard characters: False
4854
```
4955
5056
### 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).
57+
58+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
59+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
60+
-WarningAction, and -WarningVariable. For more information, see
61+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
5262
5363
## INPUTS
5464
@@ -57,6 +67,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
5767
## OUTPUTS
5868
5969
### System.Object
70+
6071
## NOTES
6172
6273
## RELATED LINKS
74+
75+
[Clear-ReFSDedupSchedule](Clear-ReFSDedupSchedule.md)
76+
77+
[Get-ReFSDedupSchedule](Get-ReFSDedupSchedule.md)
78+
79+
[Set-ReFSDedupSchedule](Set-ReFSDedupSchedule.md)
80+
81+
[Suspend-ReFSDedupSchedule](Suspend-ReFSDedupSchedule.md)

‎docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupSchedule.md

Lines changed: 86 additions & 36 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/set-refsdedupschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: Set-ReFSDedupSchedule
@@ -10,7 +10,7 @@ title: Set-ReFSDedupSchedule
1010
# Set-ReFSDedupSchedule
1111

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

1515
## SYNTAX
1616

@@ -23,24 +23,29 @@ Set-ReFSDedupSchedule [-Volume] <String> -Start <DateTime> [-Duration <TimeSpan>
2323
```
2424

2525
## DESCRIPTION
26-
{{ Fill in the Description }}
26+
27+
The `Set-ReFSDedupSchedule` cmdlet sets the deduplication schedule for a specified ReFS volume. You
28+
can use this cmdlet to specify when and how often deduplication should run on the volume.
2729

2830
## EXAMPLES
2931

3032
### Example 1
33+
3134
```powershell
32-
PS C:\> {{ Add example code here }}
35+
Set-ReFSDedupSchedule -Volume "D:" -Start "10:00 PM" -Days Monday,Wednesday,Friday -Duration 4:00:00
3336
```
3437

35-
{{ Add example description here }}
38+
This example sets the deduplication schedule for the `D:` ReFS volume to run on `Monday`, `Wednesday`,
39+
and `Friday` at `10:00 PM` for `4` hours.
3640

3741
## PARAMETERS
3842

3943
### -CompressionChunkSize
40-
{{ Fill CompressionChunkSize Description }}
44+
45+
Specifies the chunk size to use during compression.
4146

4247
```yaml
43-
Type: System.UInt32
48+
Type: UInt32
4449
Parameter Sets: (All)
4550
Aliases:
4651

@@ -52,10 +57,16 @@ Accept wildcard characters: False
5257
```
5358
5459
### -CompressionFormat
55-
{{ Fill CompressionFormat Description }}
60+
61+
Specifies the compression format to use during deduplication. Acceptable values are:
62+
63+
- `LZ4`
64+
- `Uncompressed`
65+
- `Unknown`
66+
- `ZSTD`
5667

5768
```yaml
58-
Type: Microsoft.ReFS.DeDup.Format
69+
Type: Format
5970
Parameter Sets: (All)
6071
Aliases:
6172
Accepted values: Unknown, Uncompressed, LZ4, ZSTD
@@ -68,10 +79,11 @@ Accept wildcard characters: False
6879
```
6980

7081
### -CompressionLevel
71-
{{ Fill CompressionLevel Description }}
82+
83+
Specifies the compression level to use during deduplication.
7284

7385
```yaml
74-
Type: System.UInt16
86+
Type: UInt16
7587
Parameter Sets: (All)
7688
Aliases:
7789
@@ -83,10 +95,11 @@ Accept wildcard characters: False
8395
```
8496

8597
### -CompressionTuning
86-
{{ Fill CompressionTuning Description }}
98+
99+
Specifies the compression tuning to use during deduplication.
87100

88101
```yaml
89-
Type: System.UInt32
102+
Type: UInt32
90103
Parameter Sets: (All)
91104
Aliases:
92105
@@ -98,10 +111,11 @@ Accept wildcard characters: False
98111
```
99112

100113
### -ConcurrentOpenFiles
101-
{{ Fill ConcurrentOpenFiles Description }}
114+
115+
Specifies the maximum number of files that can be open at the same time during deduplication.
102116

103117
```yaml
104-
Type: System.UInt32
118+
Type: UInt32
105119
Parameter Sets: (All)
106120
Aliases:
107121
@@ -113,10 +127,11 @@ Accept wildcard characters: False
113127
```
114128

115129
### -CpuPercentage
116-
{{ Fill CpuPercentage Description }}
130+
131+
Specifies the maximum percentage of CPU usage that deduplication should consume.
117132

118133
```yaml
119-
Type: System.UInt32
134+
Type: UInt32
120135
Parameter Sets: (All)
121136
Aliases:
122137
@@ -128,10 +143,22 @@ Accept wildcard characters: False
128143
```
129144

130145
### -Days
131-
{{ Fill Days Description }}
146+
147+
Specifies the days of the week on which deduplication should run on the volume. Acceptable values
148+
are:
149+
150+
- `None`
151+
- `EveryDay`
152+
- `Monday`
153+
- `Tuesday`
154+
- `Wednesday`
155+
- `Thursday`
156+
- `Friday`
157+
- `Saturday`
158+
- `Sunday`
132159

133160
```yaml
134-
Type: Microsoft.ReFS.DeDup.DaysOfWeek
161+
Type: DaysOfWeek
135162
Parameter Sets: (All)
136163
Aliases:
137164
Accepted values: None, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, EveryDay
@@ -144,10 +171,11 @@ Accept wildcard characters: False
144171
```
145172

146173
### -DecompressionTuning
147-
{{ Fill DecompressionTuning Description }}
174+
175+
Specifies the decompression tuning to use during deduplication.
148176

149177
```yaml
150-
Type: System.UInt32
178+
Type: UInt32
151179
Parameter Sets: (All)
152180
Aliases:
153181
@@ -159,10 +187,11 @@ Accept wildcard characters: False
159187
```
160188

161189
### -Duration
162-
{{ Fill Duration Description }}
190+
191+
Specifies the duration for which deduplication should run on the volume.
163192

164193
```yaml
165-
Type: System.TimeSpan
194+
Type: TimeSpan
166195
Parameter Sets: (All)
167196
Aliases:
168197
@@ -174,10 +203,11 @@ Accept wildcard characters: False
174203
```
175204

176205
### -ExcludeFileExtension
177-
{{ Fill ExcludeFileExtension Description }}
206+
207+
Specifies one or more file extensions to exclude from deduplication.
178208

179209
```yaml
180-
Type: System.String[]
210+
Type: String[]
181211
Parameter Sets: (All)
182212
Aliases:
183213
@@ -189,10 +219,11 @@ Accept wildcard characters: False
189219
```
190220

191221
### -ExcludeFolder
192-
{{ Fill ExcludeFolder Description }}
222+
223+
Specifies one or more folders to exclude from deduplication.
193224

194225
```yaml
195-
Type: System.String[]
226+
Type: String[]
196227
Parameter Sets: (All)
197228
Aliases:
198229
@@ -204,10 +235,11 @@ Accept wildcard characters: False
204235
```
205236

206237
### -MinimumLastModifiedTimeHours
207-
{{ Fill MinimumLastModifiedTimeHours Description }}
238+
239+
Specifies the minimum number of hours that must elapse before a file can be deduplicated.
208240

209241
```yaml
210-
Type: System.Int32
242+
Type: Int32
211243
Parameter Sets: (All)
212244
Aliases:
213245
@@ -219,10 +251,11 @@ Accept wildcard characters: False
219251
```
220252

221253
### -RecompressionTuning
222-
{{ Fill RecompressionTuning Description }}
254+
255+
Specifies the recompression tuning to use during deduplication.
223256

224257
```yaml
225-
Type: System.UInt32
258+
Type: UInt32
226259
Parameter Sets: (All)
227260
Aliases:
228261
@@ -234,10 +267,11 @@ Accept wildcard characters: False
234267
```
235268

236269
### -Start
237-
{{ Fill Start Description }}
270+
271+
Specifies the date and time when deduplication should start running on the volume.
238272

239273
```yaml
240-
Type: System.DateTime
274+
Type: DateTime
241275
Parameter Sets: (All)
242276
Aliases:
243277
@@ -249,10 +283,13 @@ Accept wildcard characters: False
249283
```
250284

251285
### -Volume
252-
{{ Fill Volume Description }}
286+
287+
Specifies the ReFS volume for which to set the deduplication schedule. Enter one or more volume
288+
IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID
289+
paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
253290

254291
```yaml
255-
Type: System.String
292+
Type: String
256293
Parameter Sets: (All)
257294
Aliases:
258295
@@ -264,7 +301,11 @@ Accept wildcard characters: False
264301
```
265302

266303
### CommonParameters
267-
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).
304+
305+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
306+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
307+
-WarningAction, and -WarningVariable. For more information, see
308+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
268309

269310
## INPUTS
270311

@@ -273,6 +314,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
273314
## OUTPUTS
274315

275316
### System.Object
317+
276318
## NOTES
277319

278320
## RELATED LINKS
321+
322+
[Clear-ReFSDedupSchedule](Clear-ReFSDedupSchedule.md)
323+
324+
[Get-ReFSDedupSchedule](Get-ReFSDedupSchedule.md)
325+
326+
[Resume-ReFSDedupSchedule](Resume-ReFSDedupSchedule.md)
327+
328+
[Suspend-ReFSDedupSchedule](Suspend-ReFSDedupSchedule.md)

‎docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupScrubSchedule.md

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
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/set-refsdedupscrubschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
6+
schema: 2.0.0
7+
title: Set-ReFSDedupScrubSchedule
8+
---
9+
10+
# Set-ReFSDedupScrubSchedule
11+
12+
## SYNOPSIS
13+
Sets the deduplication scrub schedule on the specified ReFS volume.
14+
15+
## SYNTAX
16+
17+
```
18+
Set-ReFSDedupScrubSchedule [-Volume] <String> -Start <DateTime> -Days <DaysOfWeek>
19+
-WeeksInterval <UInt16> [-DedupDataOnly <Boolean>] [<CommonParameters>]
20+
```
21+
22+
## DESCRIPTION
23+
24+
The `Set-ReFSDedupScrubSchedule` cmdlet sets the deduplication scrub schedule on the specified ReFS
25+
volume. The scrub schedule specifies when and how often scrub jobs are run on the volume.
26+
27+
## EXAMPLES
28+
29+
### Example 1
30+
31+
```powershell
32+
$params = @{
33+
Volume = "D:"
34+
Start = "12/01/2024 8:00 AM"
35+
Days = "Monday,Thursday"
36+
WeeksInterval = 2
37+
}
38+
Set-ReFSDedupScrubSchedule @params
39+
```
40+
41+
This example sets the deduplication scrub schedule on the `D:` ReFS volume to run every `Monday` and
42+
`Thursday` at `8:00 AM`, starting on December 1st, 2024, and running every `2` weeks.
43+
44+
## PARAMETERS
45+
46+
### -Days
47+
48+
Specifies the days of the week on which to run the scrub schedule. Acceptable values are:
49+
50+
- `None`
51+
- `EveryDay`
52+
- `Monday`
53+
- `Tuesday`
54+
- `Wednesday`
55+
- `Thursday`
56+
- `Friday`
57+
- `Saturday`
58+
- `Sunday`
59+
60+
```yaml
61+
Type: DaysOfWeek
62+
Parameter Sets: (All)
63+
Aliases:
64+
Accepted values: None, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, EveryDay
65+
66+
Required: True
67+
Position: Named
68+
Default value: None
69+
Accept pipeline input: False
70+
Accept wildcard characters: False
71+
```
72+
73+
### -DedupDataOnly
74+
75+
Specifies whether to include only deduplicated data in the scrub schedule.
76+
77+
```yaml
78+
Type: Boolean
79+
Parameter Sets: (All)
80+
Aliases:
81+
82+
Required: False
83+
Position: Named
84+
Default value: None
85+
Accept pipeline input: False
86+
Accept wildcard characters: False
87+
```
88+
89+
### -Start
90+
91+
Specifies the date and time on which to start the scrub schedule.
92+
93+
```yaml
94+
Type: DateTime
95+
Parameter Sets: (All)
96+
Aliases:
97+
98+
Required: True
99+
Position: Named
100+
Default value: None
101+
Accept pipeline input: False
102+
Accept wildcard characters: False
103+
```
104+
105+
### -Volume
106+
107+
Specifies the ReFS volume on which to set the deduplication scrub schedule. Enter one or more volume
108+
IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID
109+
paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
110+
111+
```yaml
112+
Type: String
113+
Parameter Sets: (All)
114+
Aliases:
115+
116+
Required: True
117+
Position: 0
118+
Default value: None
119+
Accept pipeline input: False
120+
Accept wildcard characters: False
121+
```
122+
123+
### -WeeksInterval
124+
125+
Specifies the number of weeks between each run of the scrub schedule.
126+
127+
```yaml
128+
Type: UInt16
129+
Parameter Sets: (All)
130+
Aliases:
131+
132+
Required: True
133+
Position: Named
134+
Default value: None
135+
Accept pipeline input: False
136+
Accept wildcard characters: False
137+
```
138+
139+
### CommonParameters
140+
141+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
142+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
143+
-WarningAction, and -WarningVariable. For more information, see
144+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
145+
146+
## INPUTS
147+
148+
### None
149+
150+
## OUTPUTS
151+
152+
### System.Object
153+
154+
## NOTES
155+
156+
## RELATED LINKS
157+
158+
[Clear-ReFSDedupScrubSchedule](Clear-ReFSDedupScrubSchedule.md)
159+
160+
[Get-ReFSDedupScrubSchedule](Get-ReFSDedupScrubSchedule.md)

‎docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md

Lines changed: 71 additions & 38 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/start-refsdedupjob?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: Start-ReFSDedupJob
@@ -10,37 +10,41 @@ title: Start-ReFSDedupJob
1010
# Start-ReFSDedupJob
1111

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

1515
## SYNTAX
1616

1717
```
1818
Start-ReFSDedupJob [-Volume] <String> [-Duration <TimeSpan>] [-FullRun] [-CpuPercentage <UInt32>]
19-
[-ConcurrentOpenFiles <UInt32>] [-MinimumLastModifiedTimeHours <Int32>] [-ExcludeFileExtension <String[]>]
20-
[-ExcludeFolder <String[]>] [-CompressionFormat <Format>] [-CompressionLevel <UInt16>]
21-
[-CompressionChunkSize <UInt32>] [-CompressionTuning <UInt32>] [-RecompressionTuning <UInt32>]
22-
[-DecompressionTuning <UInt32>] [<CommonParameters>]
19+
[-ConcurrentOpenFiles <UInt32>] [-MinimumLastModifiedTimeHours <Int32>]
20+
[-ExcludeFileExtension <String[]>] [-ExcludeFolder <String[]>] [-CompressionFormat <Format>]
21+
[-CompressionLevel <UInt16>] [-CompressionChunkSize <UInt32>] [-CompressionTuning <UInt32>]
22+
[-RecompressionTuning <UInt32>] [-DecompressionTuning <UInt32>] [<CommonParameters>]
2323
```
2424

2525
## DESCRIPTION
26-
{{ Fill in the Description }}
26+
27+
The `Start-ReFSDedupJob` cmdlet starts a deduplication job on the specified ReFS volume or to
28+
resume an existing job that was previously paused or stopped.
2729

2830
## EXAMPLES
2931

3032
### Example 1
33+
3134
```powershell
32-
PS C:\> {{ Add example code here }}
35+
Start-ReFSDedupJob -Volume "D:"
3336
```
3437

35-
{{ Add example description here }}
38+
This example starts a deduplication job on the `D:` drive using the default settings.
3639

3740
## PARAMETERS
3841

3942
### -CompressionChunkSize
40-
{{ Fill CompressionChunkSize Description }}
43+
44+
Specifies the chunk size to use during compression.
4145

4246
```yaml
43-
Type: System.UInt32
47+
Type: UInt32
4448
Parameter Sets: (All)
4549
Aliases:
4650

@@ -52,10 +56,16 @@ Accept wildcard characters: False
5256
```
5357
5458
### -CompressionFormat
55-
{{ Fill CompressionFormat Description }}
59+
60+
Specifies the compression format to use during the job. Acceptable values are:
61+
62+
- `LZ4`
63+
- `Uncompressed`
64+
- `Unknown`
65+
- `ZSTD`
5666

5767
```yaml
58-
Type: Microsoft.ReFS.DeDup.Format
68+
Type: Format
5969
Parameter Sets: (All)
6070
Aliases:
6171
Accepted values: Unknown, Uncompressed, LZ4, ZSTD
@@ -68,10 +78,11 @@ Accept wildcard characters: False
6878
```
6979

7080
### -CompressionLevel
71-
{{ Fill CompressionLevel Description }}
81+
82+
Specifies the compression level to use during the job.
7283

7384
```yaml
74-
Type: System.UInt16
85+
Type: UInt16
7586
Parameter Sets: (All)
7687
Aliases:
7788
@@ -83,10 +94,11 @@ Accept wildcard characters: False
8394
```
8495

8596
### -CompressionTuning
86-
{{ Fill CompressionTuning Description }}
97+
98+
Specifies the compression tuning to use during the job.
8799

88100
```yaml
89-
Type: System.UInt32
101+
Type: UInt32
90102
Parameter Sets: (All)
91103
Aliases:
92104
@@ -98,10 +110,11 @@ Accept wildcard characters: False
98110
```
99111

100112
### -ConcurrentOpenFiles
101-
{{ Fill ConcurrentOpenFiles Description }}
113+
114+
Specifies the maximum number of files that can be open concurrently during the job.
102115

103116
```yaml
104-
Type: System.UInt32
117+
Type: UInt32
105118
Parameter Sets: (All)
106119
Aliases:
107120
@@ -113,10 +126,11 @@ Accept wildcard characters: False
113126
```
114127

115128
### -CpuPercentage
116-
{{ Fill CpuPercentage Description }}
129+
130+
Specifies the maximum percentage of CPU to use during the job.
117131

118132
```yaml
119-
Type: System.UInt32
133+
Type: UInt32
120134
Parameter Sets: (All)
121135
Aliases:
122136
@@ -128,10 +142,11 @@ Accept wildcard characters: False
128142
```
129143

130144
### -DecompressionTuning
131-
{{ Fill DecompressionTuning Description }}
145+
146+
Specifies the decompression tuning to use during the job.
132147

133148
```yaml
134-
Type: System.UInt32
149+
Type: UInt32
135150
Parameter Sets: (All)
136151
Aliases:
137152
@@ -143,10 +158,11 @@ Accept wildcard characters: False
143158
```
144159

145160
### -Duration
146-
{{ Fill Duration Description }}
161+
162+
Specifies the duration of the job.
147163

148164
```yaml
149-
Type: System.TimeSpan
165+
Type: TimeSpan
150166
Parameter Sets: (All)
151167
Aliases:
152168
@@ -158,10 +174,11 @@ Accept wildcard characters: False
158174
```
159175

160176
### -ExcludeFileExtension
161-
{{ Fill ExcludeFileExtension Description }}
177+
178+
Specifies one or more file extensions to exclude from the job.
162179

163180
```yaml
164-
Type: System.String[]
181+
Type: String[]
165182
Parameter Sets: (All)
166183
Aliases:
167184
@@ -173,10 +190,11 @@ Accept wildcard characters: False
173190
```
174191

175192
### -ExcludeFolder
176-
{{ Fill ExcludeFolder Description }}
193+
194+
Specifies one or more folders to exclude from the job.
177195

178196
```yaml
179-
Type: System.String[]
197+
Type: String[]
180198
Parameter Sets: (All)
181199
Aliases:
182200
@@ -188,10 +206,13 @@ Accept wildcard characters: False
188206
```
189207

190208
### -FullRun
191-
{{ Fill FullRun Description }}
209+
210+
Indicates whether to run a full deduplication job on the specified ReFS volume. If this parameter
211+
isn't specified, the job will run in incremental mode where only new or changed files will be
212+
processed.
192213

193214
```yaml
194-
Type: System.Management.Automation.SwitchParameter
215+
Type: SwitchParameter
195216
Parameter Sets: (All)
196217
Aliases:
197218
@@ -203,10 +224,11 @@ Accept wildcard characters: False
203224
```
204225

205226
### -MinimumLastModifiedTimeHours
206-
{{ Fill MinimumLastModifiedTimeHours Description }}
227+
228+
Specifies the minimum number of hours that must elapse before a file can be deduplicated.
207229

208230
```yaml
209-
Type: System.Int32
231+
Type: Int32
210232
Parameter Sets: (All)
211233
Aliases:
212234
@@ -218,10 +240,11 @@ Accept wildcard characters: False
218240
```
219241

220242
### -RecompressionTuning
221-
{{ Fill RecompressionTuning Description }}
243+
244+
Specifies the recompression tuning to use during deduplication.
222245

223246
```yaml
224-
Type: System.UInt32
247+
Type: UInt32
225248
Parameter Sets: (All)
226249
Aliases:
227250
@@ -233,10 +256,13 @@ Accept wildcard characters: False
233256
```
234257

235258
### -Volume
236-
{{ Fill Volume Description }}
259+
260+
Specifies the ReFS volume on which to run the job. Enter one or more volume IDs, drive letters, or
261+
volume GUID paths. For drive letters, use the format `D:`. For volume GUID paths, use the format
262+
`\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
237263
238264
```yaml
239-
Type: System.String
265+
Type: String
240266
Parameter Sets: (All)
241267
Aliases:
242268

@@ -248,7 +274,11 @@ Accept wildcard characters: False
248274
```
249275
250276
### CommonParameters
251-
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).
277+
278+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
279+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
280+
-WarningAction, and -WarningVariable. For more information, see
281+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
252282
253283
## INPUTS
254284
@@ -257,6 +287,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
257287
## OUTPUTS
258288
259289
### System.Object
290+
260291
## NOTES
261292
262293
## RELATED LINKS
294+
295+
[Stop-ReFSDedupJob](Stop-ReFSDedupJob.md)

‎docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Stop-ReFSDedupJob.md

Lines changed: 21 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/stop-refsdedupjob?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: Stop-ReFSDedupJob
@@ -10,7 +10,7 @@ title: Stop-ReFSDedupJob
1010
# Stop-ReFSDedupJob
1111

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

1515
## SYNTAX
1616

@@ -19,24 +19,30 @@ Stop-ReFSDedupJob [-Volume] <String> [<CommonParameters>]
1919
```
2020

2121
## DESCRIPTION
22-
{{ Fill in the Description }}
22+
23+
The `Stop-ReFSDedupJob` cmdlet stops a running deduplication job on a specified ReFS volume that is
24+
currently running.
2325

2426
## EXAMPLES
2527

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

31-
{{ Add example description here }}
34+
This example stops the deduplication job for the `D:` ReFS volume.
3235

3336
## PARAMETERS
3437

3538
### -Volume
36-
{{ Fill Volume Description }}
39+
40+
Specifies the ReFS volume for which to stop the deduplication job. Enter one or more volume IDs,
41+
drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID paths,
42+
use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
3743

3844
```yaml
39-
Type: System.String
45+
Type: String
4046
Parameter Sets: (All)
4147
Aliases:
4248

@@ -48,7 +54,11 @@ Accept wildcard characters: False
4854
```
4955
5056
### 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).
57+
58+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
59+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
60+
-WarningAction, and -WarningVariable. For more information, see
61+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
5262
5363
## INPUTS
5464
@@ -57,6 +67,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
5767
## OUTPUTS
5868
5969
### System.Object
70+
6071
## NOTES
6172
6273
## RELATED LINKS
74+
75+
[Start-ReFSDedupJob](Start-ReFSDedupJob.md)

‎docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Suspend-ReFSDedupSchedule.md

Lines changed: 28 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/suspend-refsdedupschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: Suspend-ReFSDedupSchedule
@@ -10,7 +10,7 @@ title: Suspend-ReFSDedupSchedule
1010
# Suspend-ReFSDedupSchedule
1111

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

1515
## SYNTAX
1616

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

2121
## DESCRIPTION
22-
{{ Fill in the Description }}
22+
23+
The `Suspend-ReFSDedupSchedule` cmdlet suspends the deduplication schedule on the specified ReFS
24+
volume. When you suspend the schedule, no new deduplication jobs will be started until you resume
25+
the schedule.
2326

2427
## EXAMPLES
2528

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

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

3337
## PARAMETERS
3438

3539
### -Volume
36-
{{ Fill Volume Description }}
40+
41+
Specifies the volume on which to suspend the ReFS Deduplication schedule. Enter one or more volume
42+
IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID
43+
paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
3744

3845
```yaml
39-
Type: System.String
46+
Type: String
4047
Parameter Sets: (All)
4148
Aliases:
4249

@@ -48,7 +55,11 @@ Accept wildcard characters: False
4855
```
4956
5057
### 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).
58+
59+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
60+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
61+
-WarningAction, and -WarningVariable. For more information, see
62+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
5263
5364
## INPUTS
5465
@@ -57,6 +68,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
5768
## OUTPUTS
5869
5970
### System.Object
71+
6072
## NOTES
6173
6274
## RELATED LINKS
75+
76+
[Clear-ReFSDedupSchedule](Clear-ReFSDedupSchedule.md)
77+
78+
[Get-ReFSDedupSchedule](Get-ReFSDedupSchedule.md)
79+
80+
[Resume-ReFSDedupSchedule](Resume-ReFSDedupSchedule.md)
81+
82+
[Set-ReFSDedupSchedule](Set-ReFSDedupSchedule.md)

‎docset/winserver2025-ps/deduplication/Deduplication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Help Version: 5.0.5.1
55
Locale: en-US
66
Module Guid: 1395eca7-7eaf-4958-a114-fb8ab76b86cc
77
Module Name: Deduplication
8-
ms.date: 12/20/2016
8+
ms.date: 11/20/2024
99
title: Deduplication
1010
---
1111

0 commit comments

Comments
 (0)
Please sign in to comment.