Skip to content

Commit 57e040e

Browse files
authored
Merge branch 'main' into broken-links-fix-JasonGerend-2
2 parents bd7289c + bb3bdbc commit 57e040e

15 files changed

+729
-153
lines changed
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)
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)
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

+36-10
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)

0 commit comments

Comments
 (0)