Merge pull request #3909 from Xelu86/DedupUpdate

NEW ReFS Dedup command set for WS25

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

@@ -1,7 +1,7 @@
 ---
 external help file: Microsoft.ReFsDedup.Commands.dll-Help.xml
 Module Name: Microsoft.ReFsDedup.Commands
-ms.date: 02/21/2024
+ms.date: 11/20/2024
 online version: https://learn.microsoft.com/powershell/module/microsoft.refsdedup.commands/clear-refsdedupschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
 schema: 2.0.0
 title: Clear-ReFSDedupSchedule
@@ -10,7 +10,7 @@ title: Clear-ReFSDedupSchedule
 # Clear-ReFSDedupSchedule
 
 ## SYNOPSIS
-{{ Fill in the Synopsis }}
+Clears the scheduled task for deduplication on a specified ReFS volume.
 
 ## SYNTAX
 
@@ -19,24 +19,30 @@ Clear-ReFSDedupSchedule [-Volume] <String> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+
+The `Clear-ReFSDedupSchedule` cmdlet clears the scheduled job, including the schedule itself, for
+deduplication on the specified ReFS volume.
 
 ## EXAMPLES
 
 ### Example 1
+
 ```powershell
-PS C:\> {{ Add example code here }}
+Clear-ReFSDedupSchedule -Volume "D:"
 ```
 
-{{ Add example description here }}
+This example clears the scheduled task for volume `D:`.
 
 ## PARAMETERS
 
 ### -Volume
-{{ Fill Volume Description }}
+
+Specifies the volume or volumes to clear the scheduled optimization task. Enter one or more volume
+IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID
+paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
 
 ```yaml
-Type: System.String
+Type: String
 Parameter Sets: (All)
 Aliases:
 
@@ -48,7 +54,11 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
-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).
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
+-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
+-WarningAction, and -WarningVariable. For more information, see
+[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
 
 ## INPUTS
 
@@ -57,6 +67,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## OUTPUTS
 
 ### System.Object
+
 ## NOTES
 
 ## RELATED LINKS
+
+[Get-ReFSDedupSchedule](Get-ReFSDedupSchedule.md)
+
+[Resume-ReFSDedupSchedule](Resume-ReFSDedupSchedule.md)
+
+[Set-ReFSDedupSchedule](Set-ReFSDedupSchedule.md)
+
+[Suspend-ReFSDedupSchedule](Suspend-ReFSDedupSchedule.md)

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

@@ -0,0 +1,78 @@
+---
+external help file: Microsoft.ReFsDedup.Commands.dll-Help.xml
+Module Name: Microsoft.ReFsDedup.Commands
+ms.date: 11/20/2024
+online version: https://learn.microsoft.com/powershell/module/microsoft.refsdedup.commands/clear-refsdedupscrubschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
+schema: 2.0.0
+title: Clear-ReFSDedupScrubSchedule
+---
+
+# Clear-ReFSDedupScrubSchedule
+
+## SYNOPSIS
+Clears the deduplication scrub schedule on a specified ReFS volume.
+
+## SYNTAX
+
+```
+Clear-ReFSDedupScrubSchedule [-Volume] <String> [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+The `Clear-ReFSDedupScrubSchedule` cmdlet clears the deduplication scrub schedule on a specified
+ReFS volume. When you clear the schedule, any pending scrub jobs will be cancelled and the schedule
+will be reset.
+
+## EXAMPLES
+
+### Example 1
+
+```powershell
+Clear-ReFSDedupScrubSchedule -Volume "D:"
+```
+
+This example clears the deduplication scrub schedule on the `D:` ReFS volume.
+
+## PARAMETERS
+
+### -Volume
+
+Specifies the volume on which to clear the ReFS deduplication scrub schedule. Enter one or more
+volume IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume
+GUID paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 0
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
+-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
+-WarningAction, and -WarningVariable. For more information, see
+[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### System.Object
+
+## NOTES
+
+## RELATED LINKS
+
+[Get-ReFSDedupScrubSchedule](Get-ReFSDedupScrubSchedule.md)
+
+[Set-ReFSDedupScrubSchedule](Set-ReFSDedupScrubSchedule.md)

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

@@ -1,7 +1,7 @@
 ---
 external help file: Microsoft.ReFsDedup.Commands.dll-Help.xml
 Module Name: Microsoft.ReFsDedup.Commands
-ms.date: 02/21/2024
+ms.date: 11/20/2024
 online version: https://learn.microsoft.com/powershell/module/microsoft.refsdedup.commands/disable-refsdedup?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
 schema: 2.0.0
 title: Disable-ReFSDedup
@@ -10,7 +10,7 @@ title: Disable-ReFSDedup
 # Disable-ReFSDedup
 
 ## SYNOPSIS
-{{ Fill in the Synopsis }}
+Disables data deduplication on a specified ReFS volume.
 
 ## SYNTAX
 
@@ -19,24 +19,31 @@ Disable-ReFSDedup [-Volume] <String> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+
+The `Disable-ReFSDedup` cmdlet disables data deduplication on a specified ReFS volume. This cmdlet
+does not affect existing deduplicated files or folders on the volume, but it prevents new files or
+folders from being deduplicated.
 
 ## EXAMPLES
 
 ### Example 1
+
 ```powershell
-PS C:\> {{ Add example code here }}
+Disable-ReFSDedup -Volume "D:"
 ```
 
-{{ Add example description here }}
+This example disables data deduplication on the `D:` ReFS volume.
 
 ## PARAMETERS
 
 ### -Volume
-{{ Fill Volume Description }}
+
+Specifies the volume or volumes to disable ReFS data deduplication. Enter one or more volume IDs,
+drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID paths,
+use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
 
 ```yaml
-Type: System.String
+Type: String
 Parameter Sets: (All)
 Aliases:
 
@@ -48,7 +55,11 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
-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).
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
+-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
+-WarningAction, and -WarningVariable. For more information, see
+[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
 
 ## INPUTS
 
@@ -57,6 +68,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## OUTPUTS
 
 ### System.Object
+
 ## NOTES
 
 ## RELATED LINKS
+
+[Enable-ReFSDedup](Enable-ReFSDedup.md)

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

@@ -1,7 +1,7 @@
 ---
 external help file: Microsoft.ReFsDedup.Commands.dll-Help.xml
 Module Name: Microsoft.ReFsDedup.Commands
-ms.date: 02/21/2024
+ms.date: 11/20/2024
 online version: https://learn.microsoft.com/powershell/module/microsoft.refsdedup.commands/enable-refsdedup?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
 schema: 2.0.0
 title: Enable-ReFSDedup
@@ -10,7 +10,7 @@ title: Enable-ReFSDedup
 # Enable-ReFSDedup
 
 ## SYNOPSIS
-{{ Fill in the Synopsis }}
+Enables data deduplication on a specified ReFS volume.
 
 ## SYNTAX
 
@@ -19,24 +19,40 @@ Enable-ReFSDedup [-Volume] <String> [-Type] <DedupVolumeType> [<CommonParameters
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+
+The `Enable-ReFSDedup` cmdlet enables data deduplication on a specified ReFS volume. You can
+specify the type of deduplication to use with the `-Type` parameter.
 
 ## EXAMPLES
 
 ### Example 1
+
+```powershell
+Enable-ReFSDedup -Volume "D:" -Type DedupAndCompress
+```
+
+This example enables data deduplication with compression on the `D:` ReFS volume.
+
+### Example 2
+
 ```powershell
-PS C:\> {{ Add example code here }}
+Enable-ReFSDedup -Volume "E:, F:" -Type DedupAndCompress
 ```
 
-{{ Add example description here }}
+This example enables data deduplication with compression on both `E:` and `F:` ReFS volumes.
 
 ## PARAMETERS
 
 ### -Type
-{{ Fill Type Description }}
+
+Specifies the type of deduplication to use. Acceptable values are:
+
+- `Compress`
+- `Dedup`
+- `DedupAndCompress`
 
 ```yaml
-Type: Microsoft.ReFS.DeDup.DedupVolumeType
+Type: DedupVolumeType
 Parameter Sets: (All)
 Aliases:
 Accepted values: Dedup, DedupAndCompress, Compress
@@ -49,10 +65,13 @@ Accept wildcard characters: False
 ```
 
 ### -Volume
-{{ Fill Volume Description }}
+
+Specifies the volume or volumes to enable ReFS data deduplication. Enter one or more volume IDs,
+drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID paths,
+use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma.
 
 ```yaml
-Type: System.String
+Type: String
 Parameter Sets: (All)
 Aliases:
 
@@ -64,7 +83,11 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
-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).
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
+-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
+-WarningAction, and -WarningVariable. For more information, see
+[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
 
 ## INPUTS
 
@@ -73,6 +96,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## OUTPUTS
 
 ### System.Object
+
 ## NOTES
 
 ## RELATED LINKS
+
+[Disable-ReFSDedup](Disable-ReFSDedup.md)