From 8727c92c6aa03b6f738794e263380fe36a844acd Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Wed, 20 Nov 2024 20:30:23 -0500 Subject: [PATCH 01/11] Updated ReFSDedup command set --- .../Clear-ReFSDedupSchedule.md | 33 +++- .../Clear-ReFSDedupScrubSchedule.md | 76 +++++++++ .../Disable-ReFSDedup.md | 28 ++- .../Enable-ReFSDedup.md | 37 ++-- .../Get-ReFSDedupSchedule.md | 34 +++- .../Get-ReFSDedupScrubSchedule.md | 76 +++++++++ .../Get-ReFSDedupStatus.md | 26 ++- .../Microsoft.ReFsDedup.Commands.md | 48 ++++-- .../Resume-ReFSDedupSchedule.md | 33 +++- .../Set-ReFSDedupSchedule.md | 120 +++++++++---- .../Set-ReFSDedupScrubSchedule.md | 159 ++++++++++++++++++ .../Start-ReFSDedupJob.md | 108 +++++++----- .../Stop-ReFSDedupJob.md | 27 ++- .../Suspend-ReFSDedupSchedule.md | 34 +++- .../deduplication/Deduplication.md | 2 +- 15 files changed, 689 insertions(+), 152 deletions(-) create mode 100644 docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupScrubSchedule.md create mode 100644 docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md create mode 100644 docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupScrubSchedule.md diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md index 7048f16c5d..74f07164d5 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md +++ b/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,28 @@ Clear-ReFSDedupSchedule [-Volume] [] ``` ## DESCRIPTION -{{ Fill in the Description }} + +The `Clear-ReFSDedupSchedule` cmdlet clears the scheduled task 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. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -48,7 +52,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 +65,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) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupScrubSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupScrubSchedule.md new file mode 100644 index 0000000000..521d38aa0c --- /dev/null +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupScrubSchedule.md @@ -0,0 +1,76 @@ +--- +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] [] +``` + +## 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. + +```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) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Disable-ReFSDedup.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Disable-ReFSDedup.md index 825c83389b..3f1659cc55 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Disable-ReFSDedup.md +++ b/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,29 @@ Disable-ReFSDedup [-Volume] [] ``` ## 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. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -48,7 +53,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 +66,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS + +[Enable-ReFSDedup](Enable-ReFSDedup.md) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Enable-ReFSDedup.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Enable-ReFSDedup.md index 6c0a2085b4..5a44e5032c 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Enable-ReFSDedup.md +++ b/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,33 @@ Enable-ReFSDedup [-Volume] [-Type] [ {{ Add example code here }} +Enable-ReFSDedup -Volume "D:" -Type DedupAndCompress + ``` -{{ Add example description here }} +This example enables data deduplication with compression on the `D:` ReFS volume. ## 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 +58,11 @@ Accept wildcard characters: False ``` ### -Volume -{{ Fill Volume Description }} + +Specifies the volume or volumes to enable ReFS data deduplication. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -64,7 +74,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 +87,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS + +[Disable-ReFSDedup](Disable-ReFSDedup.md) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md index e09af3fe98..db0e93bfc8 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-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/get-refsdedupschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ReFSDedupSchedule @@ -10,7 +10,7 @@ title: Get-ReFSDedupSchedule # Get-ReFSDedupSchedule ## SYNOPSIS -{{ Fill in the Synopsis }} +Retrieves the deduplication schedule on a specified ReFS volume. ## SYNTAX @@ -19,24 +19,29 @@ Get-ReFSDedupSchedule [-Volume] [] ``` ## DESCRIPTION -{{ Fill in the Description }} + +The `Get-ReFSDedupSchedule` cmdlet retrieves the deduplication schedule for a specified ReFS +volume. The cmdlet returns information about the last time deduplication was run, the next time it +is scheduled to run, and the frequency with which it runs. ## EXAMPLES ### Example 1 + ```powershell -PS C:\> {{ Add example code here }} +Get-ReFSDedupSchedule -Volume "D:" ``` -{{ Add example description here }} +This example retrieves the deduplication schedule for the `D:` ReFS volume. ## PARAMETERS ### -Volume -{{ Fill Volume Description }} + +Specifies the ReFS volume for which to retrieve the deduplication schedule. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -48,7 +53,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 +66,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS + +[Clear-ReFSDedupSchedule](Clear-ReFSDedupSchedule.md) + +[Resume-ReFSDedupSchedule](Resume-ReFSDedupSchedule.md) + +[Set-ReFSDedupSchedule](Set-ReFSDedupSchedule.md) + +[Suspend-ReFSDedupSchedule](Suspend-ReFSDedupSchedule.md) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md new file mode 100644 index 0000000000..a54bc3aaf6 --- /dev/null +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md @@ -0,0 +1,76 @@ +--- +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/get-refsdedupscrubschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-ReFSDedupScrubSchedule +--- + +# Get-ReFSDedupScrubSchedule + +## SYNOPSIS +Retrieves the deduplication scrub schedule on the specified ReFS volume. + +## SYNTAX + +``` +Get-ReFSDedupScrubSchedule [-Volume] [] +``` + +## DESCRIPTION + +The `Get-ReFSDedupScrubSchedule` cmdlet retrieves the deduplication scrub schedule on the specified +ReFS volume. The scrub schedule specifies when and how often scrub jobs are run on the volume to +check for and repair any data corruption. + +## EXAMPLES + +### Example 1 + +```powershell +Get-ReFSDedupScrubSchedule -Volume "D:" +``` + +This example gets the deduplication scrub schedule on the `D:` ReFS volume. + +## PARAMETERS + +### -Volume + +Specifies the volume on which to retrieve the ReFS deduplication scrub schedule. + +```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 + +[Clear-ReFSDedupScrubSchedule](Clear-ReFSDedupScrubSchedule.md) + +[Set-ReFSDedupScrubSchedule](Set-ReFSDedupScrubSchedule.md) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md index ef5039614f..cb6e59c512 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.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/get-refsdedupstatus?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ReFSDedupStatus @@ -10,7 +10,7 @@ title: Get-ReFSDedupStatus # Get-ReFSDedupStatus ## SYNOPSIS -{{ Fill in the Synopsis }} +Retrieves the status of data deduplication on a specified ReFS volume. ## SYNTAX @@ -19,24 +19,29 @@ Get-ReFSDedupStatus [-Volume] [] ``` ## DESCRIPTION -{{ Fill in the Description }} + +The `Get-ReFSDedupStatus` cmdlet retrieves the status of data deduplication on a specified ReFS volume. +The cmdlet returns information about the amount of space saved by deduplication, the percentage of +data that is deduplicated, and the status of the deduplication job. ## EXAMPLES ### Example 1 + ```powershell -PS C:\> {{ Add example code here }} +Get-ReFSDedupStatus -Volume "D:" ``` -{{ Add example description here }} +This example retrieves the deduplication status for the `D:` ReFS volume. ## PARAMETERS ### -Volume -{{ Fill Volume Description }} + +Specifies the ReFS volume for which to retrieve the deduplication status. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -48,7 +53,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 +66,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Microsoft.ReFsDedup.Commands.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Microsoft.ReFsDedup.Commands.md index 97f159f3b3..704c5ce7c1 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Microsoft.ReFsDedup.Commands.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Microsoft.ReFsDedup.Commands.md @@ -9,37 +9,63 @@ title: Microsoft.ReFsDedup.Commands module --- # Microsoft.ReFsDedup.Commands Module + ## Description -{{ Fill in the Description }} + +This reference provides cmdlet descriptions and syntax for all Windows Server ReFS +Deduplication-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the +beginning of the cmdlet. ## Microsoft.ReFsDedup.Commands Cmdlets + ### [Clear-ReFSDedupSchedule](Clear-ReFSDedupSchedule.md) -{{ Fill in the Description }} + +Clears the scheduled task for deduplication on a specified ReFS volume. + +### [Clear-ReFSDedupScrubSchedule.md](Clear-ReFSDedupScrubSchedule.md) + +Clears the deduplication scrub schedule on a specified ReFS volume. ### [Disable-ReFSDedup](Disable-ReFSDedup.md) -{{ Fill in the Description }} + +Disables data deduplication on a specified ReFS volume. ### [Enable-ReFSDedup](Enable-ReFSDedup.md) -{{ Fill in the Description }} + +Enables data deduplication on a specified ReFS volume. ### [Get-ReFSDedupSchedule](Get-ReFSDedupSchedule.md) -{{ Fill in the Description }} + +Retrieves the deduplication schedule for a specified ReFS volume. + +### [Get-ReFSDedupScrubSchedule](Get-ReFSDedupScrubSchedule.md) + +Retrieves the deduplication scrub schedule on the specified ReFS volume. ### [Get-ReFSDedupStatus](Get-ReFSDedupStatus.md) -{{ Fill in the Description }} + +Retrieves the status of data deduplication on a specified ReFS volume. ### [Resume-ReFSDedupSchedule](Resume-ReFSDedupSchedule.md) -{{ Fill in the Description }} + +Resumes the deduplication schedule on a specified ReFS volume. ### [Set-ReFSDedupSchedule](Set-ReFSDedupSchedule.md) -{{ Fill in the Description }} + +Sets the deduplication schedule on a specified ReFS volume. + +### [Set-ReFSDedupScrubSchedule](Set-ReFSDedupScrubSchedule.md) + +Sets the deduplication scrub schedule on the specified ReFS volume. ### [Start-ReFSDedupJob](Start-ReFSDedupJob.md) -{{ Fill in the Description }} + +Starts a deduplication job on the specified ReFS volume. ### [Stop-ReFSDedupJob](Stop-ReFSDedupJob.md) -{{ Fill in the Description }} + +Stops a running deduplication job on a specified ReFS volume. ### [Suspend-ReFSDedupSchedule](Suspend-ReFSDedupSchedule.md) -{{ Fill in the Description }} +Suspends the deduplication schedule on a specified ReFS volume. diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Resume-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Resume-ReFSDedupSchedule.md index 377ff6915d..7b7889ec61 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Resume-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Resume-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/resume-refsdedupschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Resume-ReFSDedupSchedule @@ -10,7 +10,7 @@ title: Resume-ReFSDedupSchedule # Resume-ReFSDedupSchedule ## SYNOPSIS -{{ Fill in the Synopsis }} +Resumes the deduplication schedule on a specified ReFS volume. ## SYNTAX @@ -19,24 +19,28 @@ Resume-ReFSDedupSchedule [-Volume] [] ``` ## DESCRIPTION -{{ Fill in the Description }} + +The `Resume-ReFSDedupSchedule` cmdlet resumes the deduplication schedule on a specified ReFS +volume. This cmdlet is used to resume a deduplication job that has been paused or stopped. ## EXAMPLES ### Example 1 + ```powershell -PS C:\> {{ Add example code here }} +Resume-ReFSDedupSchedule -Volume "D:" ``` -{{ Add example description here }} +This example resumes the deduplication schedule for the `D:` ReFS volume. ## PARAMETERS ### -Volume -{{ Fill Volume Description }} + +Specifies the ReFS volume for which to resume the deduplication schedule. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -48,7 +52,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 +65,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS + +[Clear-ReFSDedupSchedule](Clear-ReFSDedupSchedule.md) + +[Get-ReFSDedupSchedule](Get-ReFSDedupSchedule.md) + +[Set-ReFSDedupSchedule](Set-ReFSDedupSchedule.md) + +[Suspend-ReFSDedupSchedule](Suspend-ReFSDedupSchedule.md) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupSchedule.md index d0a826ee5e..72266d6b35 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-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/set-refsdedupschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-ReFSDedupSchedule @@ -10,7 +10,7 @@ title: Set-ReFSDedupSchedule # Set-ReFSDedupSchedule ## SYNOPSIS -{{ Fill in the Synopsis }} +Sets the deduplication schedule on a specified ReFS volume. ## SYNTAX @@ -23,24 +23,29 @@ Set-ReFSDedupSchedule [-Volume] -Start [-Duration ``` ## DESCRIPTION -{{ Fill in the Description }} + +The `Set-ReFSDedupSchedule` cmdlet sets the deduplication schedule for a specified ReFS volume. You +can use this cmdlet to specify when and how often deduplication should run on the volume. ## EXAMPLES ### Example 1 + ```powershell -PS C:\> {{ Add example code here }} +Set-ReFSDedupSchedule -Volume "D:" -Start "10:00 PM" -Days Monday,Wednesday,Friday -Duration 4:00:00 ``` -{{ Add example description here }} +This example sets the deduplication schedule for the `D:` ReFS volume to run on `Monday`, `Wednesday`, +and `Friday` at `10:00 PM` for `4` hours. ## PARAMETERS ### -CompressionChunkSize -{{ Fill CompressionChunkSize Description }} + +Specifies the chunk size to use during compression. ```yaml -Type: System.UInt32 +Type: UInt32 Parameter Sets: (All) Aliases: @@ -52,10 +57,16 @@ Accept wildcard characters: False ``` ### -CompressionFormat -{{ Fill CompressionFormat Description }} + +Specifies the compression format to use during deduplication. Acceptable values are: + +- `LZ4` +- `Uncompressed` +- `Unknown` +- `ZSTD` ```yaml -Type: Microsoft.ReFS.DeDup.Format +Type: Format Parameter Sets: (All) Aliases: Accepted values: Unknown, Uncompressed, LZ4, ZSTD @@ -68,10 +79,11 @@ Accept wildcard characters: False ``` ### -CompressionLevel -{{ Fill CompressionLevel Description }} + +Specifies the compression level to use during deduplication. ```yaml -Type: System.UInt16 +Type: UInt16 Parameter Sets: (All) Aliases: @@ -83,10 +95,11 @@ Accept wildcard characters: False ``` ### -CompressionTuning -{{ Fill CompressionTuning Description }} + +Specifies the compression tuning to use during deduplication. ```yaml -Type: System.UInt32 +Type: UInt32 Parameter Sets: (All) Aliases: @@ -98,10 +111,11 @@ Accept wildcard characters: False ``` ### -ConcurrentOpenFiles -{{ Fill ConcurrentOpenFiles Description }} + +Specifies the maximum number of files that can be open at the same time during deduplication. ```yaml -Type: System.UInt32 +Type: UInt32 Parameter Sets: (All) Aliases: @@ -113,10 +127,11 @@ Accept wildcard characters: False ``` ### -CpuPercentage -{{ Fill CpuPercentage Description }} + +Specifies the maximum percentage of CPU usage that deduplication should consume. ```yaml -Type: System.UInt32 +Type: UInt32 Parameter Sets: (All) Aliases: @@ -128,10 +143,22 @@ Accept wildcard characters: False ``` ### -Days -{{ Fill Days Description }} + +Specifies the days of the week on which deduplication should run on the volume. Acceptable values +are: + +- `None` +- `EveryDay` +- `Monday` +- `Tuesday` +- `Wednesday` +- `Thursday` +- `Friday` +- `Saturday` +- `Sunday` ```yaml -Type: Microsoft.ReFS.DeDup.DaysOfWeek +Type: DaysOfWeek Parameter Sets: (All) Aliases: Accepted values: None, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, EveryDay @@ -144,10 +171,11 @@ Accept wildcard characters: False ``` ### -DecompressionTuning -{{ Fill DecompressionTuning Description }} + +Specifies the decompression tuning to use during deduplication. ```yaml -Type: System.UInt32 +Type: UInt32 Parameter Sets: (All) Aliases: @@ -159,10 +187,11 @@ Accept wildcard characters: False ``` ### -Duration -{{ Fill Duration Description }} + +Specifies the duration for which deduplication should run on the volume. ```yaml -Type: System.TimeSpan +Type: TimeSpan Parameter Sets: (All) Aliases: @@ -174,10 +203,11 @@ Accept wildcard characters: False ``` ### -ExcludeFileExtension -{{ Fill ExcludeFileExtension Description }} + +Specifies one or more file extensions to exclude from deduplication. ```yaml -Type: System.String[] +Type: String[] Parameter Sets: (All) Aliases: @@ -189,10 +219,11 @@ Accept wildcard characters: False ``` ### -ExcludeFolder -{{ Fill ExcludeFolder Description }} + +Specifies one or more folders to exclude from deduplication. ```yaml -Type: System.String[] +Type: String[] Parameter Sets: (All) Aliases: @@ -204,10 +235,11 @@ Accept wildcard characters: False ``` ### -MinimumLastModifiedTimeHours -{{ Fill MinimumLastModifiedTimeHours Description }} + +Specifies the minimum number of hours that must elapse before a file can be deduplicated. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -219,10 +251,11 @@ Accept wildcard characters: False ``` ### -RecompressionTuning -{{ Fill RecompressionTuning Description }} + +Specifies the recompression tuning to use during deduplication. ```yaml -Type: System.UInt32 +Type: UInt32 Parameter Sets: (All) Aliases: @@ -234,10 +267,11 @@ Accept wildcard characters: False ``` ### -Start -{{ Fill Start Description }} + +Specifies the date and time when deduplication should start running on the volume. ```yaml -Type: System.DateTime +Type: DateTime Parameter Sets: (All) Aliases: @@ -249,10 +283,11 @@ Accept wildcard characters: False ``` ### -Volume -{{ Fill Volume Description }} + +Specifies the ReFS volume for which to set the deduplication schedule. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -264,7 +299,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 @@ -273,6 +312,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS + +[Clear-ReFSDedupSchedule](Clear-ReFSDedupSchedule.md) + +[Get-ReFSDedupSchedule](Get-ReFSDedupSchedule.md) + +[Resume-ReFSDedupSchedule](Resume-ReFSDedupSchedule.md) + +[Suspend-ReFSDedupSchedule](Suspend-ReFSDedupSchedule.md) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupScrubSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupScrubSchedule.md new file mode 100644 index 0000000000..698ab09390 --- /dev/null +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupScrubSchedule.md @@ -0,0 +1,159 @@ +--- +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/set-refsdedupscrubschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Set-ReFSDedupScrubSchedule +--- + +# Set-ReFSDedupScrubSchedule + +## SYNOPSIS +Sets the deduplication scrub schedule on the specified ReFS volume. + +## SYNTAX + +``` +Set-ReFSDedupScrubSchedule [-Volume] -Start -Days + -WeeksInterval [-DedupDataOnly ] [] +``` + +## DESCRIPTION + +The `Set-ReFSDedupScrubSchedule` cmdlet sets the deduplication scrub schedule on the specified ReFS +volume. The scrub schedule specifies when and how often scrub jobs are run on the volume to check +for and repair any data corruption. + +## EXAMPLES + +### Example 1 + +```powershell +$params = @{ + Volume = "D:" + Start = "12/01/2024 8:00 AM" + Days = "Monday,Thursday" + WeeksInterval = 2 +} +Set-ReFSDedupScrubSchedule @params +``` + +This example sets the deduplication scrub schedule on the `D:` ReFS volume to run every `Monday` and +`Thursday` at `8:00 AM`, starting on December 1st, 2024, and running every `2` weeks. + +## PARAMETERS + +### -Days + +Specifies the days of the week on which to run the scrub schedule. Acceptable values are: + +- `None` +- `EveryDay` +- `Monday` +- `Tuesday` +- `Wednesday` +- `Thursday` +- `Friday` +- `Saturday` +- `Sunday` + +```yaml +Type: DaysOfWeek +Parameter Sets: (All) +Aliases: +Accepted values: None, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, EveryDay + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DedupDataOnly + +Specifies whether to include only deduplicated data in the scrub schedule. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Start + +Specifies the date and time on which to start the scrub schedule. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Volume + +Specifies the ReFS volume on which to set the deduplication scrub schedule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeeksInterval + +Specifies the number of weeks between each run of the scrub schedule. + +```yaml +Type: UInt16 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +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 + +[Clear-ReFSDedupScrubSchedule](Clear-ReFSDedupScrubSchedule.md) + +[Get-ReFSDedupScrubSchedule](Get-ReFSDedupScrubSchedule.md) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md index 0d672d1cdf..1c17514fbd 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.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/start-refsdedupjob?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Start-ReFSDedupJob @@ -10,37 +10,42 @@ title: Start-ReFSDedupJob # Start-ReFSDedupJob ## SYNOPSIS -{{ Fill in the Synopsis }} +Starts a deduplication job on the specified ReFS volume. ## SYNTAX ``` Start-ReFSDedupJob [-Volume] [-Duration ] [-FullRun] [-CpuPercentage ] - [-ConcurrentOpenFiles ] [-MinimumLastModifiedTimeHours ] [-ExcludeFileExtension ] - [-ExcludeFolder ] [-CompressionFormat ] [-CompressionLevel ] - [-CompressionChunkSize ] [-CompressionTuning ] [-RecompressionTuning ] - [-DecompressionTuning ] [] + [-ConcurrentOpenFiles ] [-MinimumLastModifiedTimeHours ] + [-ExcludeFileExtension ] [-ExcludeFolder ] [-CompressionFormat ] + [-CompressionLevel ] [-CompressionChunkSize ] [-CompressionTuning ] + [-RecompressionTuning ] [-DecompressionTuning ] [] ``` ## DESCRIPTION -{{ Fill in the Description }} + +The `Start-ReFSDedupJob` cmdlet starts a deduplication job on the specified ReFS volume. This +cmdlet can be used to start a new deduplication job or to resume an existing job that was +previously paused or stopped. ## EXAMPLES ### Example 1 + ```powershell -PS C:\> {{ Add example code here }} +Start-ReFSDedupJob -Volume "D:" ``` -{{ Add example description here }} +This example starts a deduplication job on the `D:` drive using the default settings. ## PARAMETERS ### -CompressionChunkSize -{{ Fill CompressionChunkSize Description }} + +Specifies the chunk size to use during compression. ```yaml -Type: System.UInt32 +Type: UInt32 Parameter Sets: (All) Aliases: @@ -52,10 +57,16 @@ Accept wildcard characters: False ``` ### -CompressionFormat -{{ Fill CompressionFormat Description }} + +Specifies the compression format to use during the job. Acceptable values are: + +- `LZ4` +- `Uncompressed` +- `Unknown` +- `ZSTD` ```yaml -Type: Microsoft.ReFS.DeDup.Format +Type: Format Parameter Sets: (All) Aliases: Accepted values: Unknown, Uncompressed, LZ4, ZSTD @@ -68,10 +79,11 @@ Accept wildcard characters: False ``` ### -CompressionLevel -{{ Fill CompressionLevel Description }} + +Specifies the compression level to use during the job. ```yaml -Type: System.UInt16 +Type: UInt16 Parameter Sets: (All) Aliases: @@ -83,10 +95,11 @@ Accept wildcard characters: False ``` ### -CompressionTuning -{{ Fill CompressionTuning Description }} + +Specifies the compression tuning to use during the job. ```yaml -Type: System.UInt32 +Type: UInt32 Parameter Sets: (All) Aliases: @@ -98,10 +111,11 @@ Accept wildcard characters: False ``` ### -ConcurrentOpenFiles -{{ Fill ConcurrentOpenFiles Description }} + +Specifies the maximum number of files that can be open concurrently during the job. ```yaml -Type: System.UInt32 +Type: UInt32 Parameter Sets: (All) Aliases: @@ -113,10 +127,11 @@ Accept wildcard characters: False ``` ### -CpuPercentage -{{ Fill CpuPercentage Description }} + +Specifies the maximum percentage of CPU to use during the job. ```yaml -Type: System.UInt32 +Type: UInt32 Parameter Sets: (All) Aliases: @@ -128,10 +143,11 @@ Accept wildcard characters: False ``` ### -DecompressionTuning -{{ Fill DecompressionTuning Description }} + +Specifies the decompression tuning to use during the job. ```yaml -Type: System.UInt32 +Type: UInt32 Parameter Sets: (All) Aliases: @@ -143,10 +159,11 @@ Accept wildcard characters: False ``` ### -Duration -{{ Fill Duration Description }} + +Specifies the duration of the job. ```yaml -Type: System.TimeSpan +Type: TimeSpan Parameter Sets: (All) Aliases: @@ -158,10 +175,11 @@ Accept wildcard characters: False ``` ### -ExcludeFileExtension -{{ Fill ExcludeFileExtension Description }} + +Specifies one or more file extensions to exclude from the job. ```yaml -Type: System.String[] +Type: String[] Parameter Sets: (All) Aliases: @@ -173,10 +191,11 @@ Accept wildcard characters: False ``` ### -ExcludeFolder -{{ Fill ExcludeFolder Description }} + +Specifies one or more folders to exclude from the job. ```yaml -Type: System.String[] +Type: String[] Parameter Sets: (All) Aliases: @@ -188,10 +207,13 @@ Accept wildcard characters: False ``` ### -FullRun -{{ Fill FullRun Description }} + +Indicates whether to run a full deduplication job on the specified ReFS volume. If this parameter +isn't specified, the job will run in incremental mode where only new or changed files will be +processed. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -203,10 +225,11 @@ Accept wildcard characters: False ``` ### -MinimumLastModifiedTimeHours -{{ Fill MinimumLastModifiedTimeHours Description }} + +Specifies the minimum number of hours that must elapse before a file can be deduplicated. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -218,10 +241,11 @@ Accept wildcard characters: False ``` ### -RecompressionTuning -{{ Fill RecompressionTuning Description }} + +Specifies the recompression tuning to use during deduplication. ```yaml -Type: System.UInt32 +Type: UInt32 Parameter Sets: (All) Aliases: @@ -233,10 +257,11 @@ Accept wildcard characters: False ``` ### -Volume -{{ Fill Volume Description }} + +Specifies the ReFS volume on which to run the job. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -248,7 +273,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 @@ -257,6 +286,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS + +[Stop-ReFSDedupJob](Stop-ReFSDedupJob.md) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Stop-ReFSDedupJob.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Stop-ReFSDedupJob.md index f0c73491bc..8d3e46b2a1 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Stop-ReFSDedupJob.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Stop-ReFSDedupJob.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/stop-refsdedupjob?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Stop-ReFSDedupJob @@ -10,7 +10,7 @@ title: Stop-ReFSDedupJob # Stop-ReFSDedupJob ## SYNOPSIS -{{ Fill in the Synopsis }} +Stops a running deduplication job on a specified ReFS volume. ## SYNTAX @@ -19,24 +19,28 @@ Stop-ReFSDedupJob [-Volume] [] ``` ## DESCRIPTION -{{ Fill in the Description }} + +The `Stop-ReFSDedupJob` cmdlet stops a running deduplication job on a specified ReFS volume. This +cmdlet is used to stop a deduplication job that is currently running. ## EXAMPLES ### Example 1 + ```powershell -PS C:\> {{ Add example code here }} +Stop-ReFSDedupJob -Volume "D:" ``` -{{ Add example description here }} +This example stops the deduplication job for the `D:` ReFS volume. ## PARAMETERS ### -Volume -{{ Fill Volume Description }} + +Specifies the ReFS volume for which to stop the deduplication job. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -48,7 +52,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 +65,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS + +[Start-ReFSDedupJob](Start-ReFSDedupJob.md) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Suspend-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Suspend-ReFSDedupSchedule.md index b7cae887bf..d97af22e2e 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Suspend-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Suspend-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/suspend-refsdedupschedule?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Suspend-ReFSDedupSchedule @@ -10,7 +10,7 @@ title: Suspend-ReFSDedupSchedule # Suspend-ReFSDedupSchedule ## SYNOPSIS -{{ Fill in the Synopsis }} +Suspends the deduplication schedule on a specified ReFS volume. ## SYNTAX @@ -19,24 +19,29 @@ Suspend-ReFSDedupSchedule [-Volume] [] ``` ## DESCRIPTION -{{ Fill in the Description }} + +The `Suspend-ReFSDedupSchedule` cmdlet suspends the deduplication schedule on the specified ReFS +volume. When you suspend the schedule, no new deduplication jobs will be started until you resume +the schedule. ## EXAMPLES ### Example 1 + ```powershell -PS C:\> {{ Add example code here }} +Suspend-ReFSDedupSchedule -Volume "D:" ``` -{{ Add example description here }} +This example suspends the deduplication schedule on the `D:` ReFS volume. ## PARAMETERS ### -Volume -{{ Fill Volume Description }} + +Specifies the volume on which to suspend the ReFS Deduplication schedule. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -48,7 +53,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 +66,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS + +[Clear-ReFSDedupSchedule](Clear-ReFSDedupSchedule.md) + +[Get-ReFSDedupSchedule](Get-ReFSDedupSchedule.md) + +[Resume-ReFSDedupSchedule](Resume-ReFSDedupSchedule.md) + +[Set-ReFSDedupSchedule](Set-ReFSDedupSchedule.md) diff --git a/docset/winserver2025-ps/deduplication/Deduplication.md b/docset/winserver2025-ps/deduplication/Deduplication.md index c5d8901330..fe993a9670 100644 --- a/docset/winserver2025-ps/deduplication/Deduplication.md +++ b/docset/winserver2025-ps/deduplication/Deduplication.md @@ -5,7 +5,7 @@ Help Version: 5.0.5.1 Locale: en-US Module Guid: 1395eca7-7eaf-4958-a114-fb8ab76b86cc Module Name: Deduplication -ms.date: 12/20/2016 +ms.date: 12/2024 title: Deduplication --- From 40e1c8aa19413b5b1be36cfc6c7649aeac27f68e Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Wed, 20 Nov 2024 20:32:20 -0500 Subject: [PATCH 02/11] Minor edit --- .../Microsoft.ReFsDedup.Commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Microsoft.ReFsDedup.Commands.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Microsoft.ReFsDedup.Commands.md index 704c5ce7c1..26ebde1502 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Microsoft.ReFsDedup.Commands.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Microsoft.ReFsDedup.Commands.md @@ -4,7 +4,7 @@ Help Version: 5.1.0.2025 Locale: en-US Module Guid: 63145e13-3dcf-4fa5-acef-9a437f2d9871 Module Name: Microsoft.ReFsDedup.Commands -ms.date: 02/21/2024 +ms.date: 11/20/2024 title: Microsoft.ReFsDedup.Commands module --- From b053684fb15c0f5239d3511accbace21db4d8041 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Wed, 20 Nov 2024 21:34:59 -0500 Subject: [PATCH 03/11] Fix Warning --- docset/winserver2025-ps/deduplication/Deduplication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2025-ps/deduplication/Deduplication.md b/docset/winserver2025-ps/deduplication/Deduplication.md index fe993a9670..fcb9423f15 100644 --- a/docset/winserver2025-ps/deduplication/Deduplication.md +++ b/docset/winserver2025-ps/deduplication/Deduplication.md @@ -5,7 +5,7 @@ Help Version: 5.0.5.1 Locale: en-US Module Guid: 1395eca7-7eaf-4958-a114-fb8ab76b86cc Module Name: Deduplication -ms.date: 12/2024 +ms.date: 11/20/2024 title: Deduplication --- From 7d5f927ef8bc99df9b6af16af1451facdd5e5150 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Thu, 21 Nov 2024 18:22:28 -0500 Subject: [PATCH 04/11] Description updates --- .../Clear-ReFSDedupSchedule.md | 4 ++- .../Clear-ReFSDedupScrubSchedule.md | 4 ++- .../Disable-ReFSDedup.md | 4 ++- .../Enable-ReFSDedup.md | 13 ++++++++-- .../Get-ReFSDedupSchedule.md | 13 +++++++--- .../Get-ReFSDedupScrubSchedule.md | 13 +++++++--- .../Get-ReFSDedupStatus.md | 26 ++++++++++++++++--- .../Resume-ReFSDedupSchedule.md | 6 +++-- .../Set-ReFSDedupSchedule.md | 4 ++- .../Set-ReFSDedupScrubSchedule.md | 7 ++--- .../Start-ReFSDedupJob.md | 15 ++++++++--- .../Stop-ReFSDedupJob.md | 8 +++--- .../Suspend-ReFSDedupSchedule.md | 4 ++- 13 files changed, 92 insertions(+), 29 deletions(-) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md index 74f07164d5..f9d54c6a87 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md @@ -37,7 +37,9 @@ This example clears the scheduled task for volume `D:`. ### -Volume -Specifies the volume or volumes to clear the scheduled optimization task. +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: String diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupScrubSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupScrubSchedule.md index 521d38aa0c..6ff14ef990 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupScrubSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupScrubSchedule.md @@ -38,7 +38,9 @@ This example clears the deduplication scrub schedule on the `D:` ReFS volume. ### -Volume -Specifies the volume on which to clear the ReFS deduplication scrub schedule. +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 diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Disable-ReFSDedup.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Disable-ReFSDedup.md index 3f1659cc55..c814e8bba4 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Disable-ReFSDedup.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Disable-ReFSDedup.md @@ -38,7 +38,9 @@ This example disables data deduplication on the `D:` ReFS volume. ### -Volume -Specifies the volume or volumes to disable ReFS data deduplication. +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: String diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Enable-ReFSDedup.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Enable-ReFSDedup.md index 5a44e5032c..c144e92ac3 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Enable-ReFSDedup.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Enable-ReFSDedup.md @@ -29,11 +29,18 @@ specify the type of deduplication to use with the `-Type` parameter. ```powershell Enable-ReFSDedup -Volume "D:" -Type DedupAndCompress - ``` This example enables data deduplication with compression on the `D:` ReFS volume. +### Example 2 + +```powershell +Enable-ReFSDedup -Volume "E:, F:" -Type DedupAndCompress +``` + +This example enables data deduplication with compression on both `E:` and `F:` ReFS volumes. + ## PARAMETERS ### -Type @@ -59,7 +66,9 @@ Accept wildcard characters: False ### -Volume -Specifies the volume or volumes to enable ReFS data deduplication. +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: String diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md index db0e93bfc8..d227959d08 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md @@ -21,8 +21,7 @@ Get-ReFSDedupSchedule [-Volume] [] ## DESCRIPTION The `Get-ReFSDedupSchedule` cmdlet retrieves the deduplication schedule for a specified ReFS -volume. The cmdlet returns information about the last time deduplication was run, the next time it -is scheduled to run, and the frequency with which it runs. +volume. ## EXAMPLES @@ -32,13 +31,21 @@ is scheduled to run, and the frequency with which it runs. Get-ReFSDedupSchedule -Volume "D:" ``` +```output +Volume Enabled Type Days Start Duration Suspended CompressionFormat CompressionLevel CompressionChunkSize +------ ------- ---- ---- ----- -------- --------- ----------------- ---------------- -------------------- +D: True DedupAndCompress None N/A N/A False LZ4 0 0 B +``` + This example retrieves the deduplication schedule for the `D:` ReFS volume. ## PARAMETERS ### -Volume -Specifies the ReFS volume for which to retrieve the deduplication schedule. +Specifies the ReFS volume for which to retrieve the deduplication 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 diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md index a54bc3aaf6..a8371b4ca1 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md @@ -21,8 +21,7 @@ Get-ReFSDedupScrubSchedule [-Volume] [] ## DESCRIPTION The `Get-ReFSDedupScrubSchedule` cmdlet retrieves the deduplication scrub schedule on the specified -ReFS volume. The scrub schedule specifies when and how often scrub jobs are run on the volume to -check for and repair any data corruption. +ReFS volume. ## EXAMPLES @@ -32,13 +31,21 @@ check for and repair any data corruption. Get-ReFSDedupScrubSchedule -Volume "D:" ``` +```output +Volume Enabled Start Days WeeksInterval DedupDataOnly Suspended +------ ------- ----- ---- ------------- ------------- --------- +D: True N/A None 0 False False +``` + This example gets the deduplication scrub schedule on the `D:` ReFS volume. ## PARAMETERS ### -Volume -Specifies the volume on which to retrieve the ReFS deduplication scrub schedule. +Specifies the volume on which to retrieve 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 diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md index cb6e59c512..ee56faba61 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md @@ -20,9 +20,8 @@ Get-ReFSDedupStatus [-Volume] [] ## DESCRIPTION -The `Get-ReFSDedupStatus` cmdlet retrieves the status of data deduplication on a specified ReFS volume. -The cmdlet returns information about the amount of space saved by deduplication, the percentage of -data that is deduplicated, and the status of the deduplication job. +The `Get-ReFSDedupStatus` cmdlet retrieves the status of data deduplication on a specified ReFS +volume. ## EXAMPLES @@ -32,13 +31,32 @@ data that is deduplicated, and the status of the deduplication job. Get-ReFSDedupStatus -Volume "D:" ``` +```output +Volume Type Used Deduped Compressed Format Level ChunkSize Status +------ ---- ---- ------- ---------- ------ ----- --------- ------ +D: DedupAndCompress 1.02 GiB 0 B 0 B Uncompressed 0 0 B -- +``` + This example retrieves the deduplication status for the `D:` ReFS volume. +### Example 2 + +```powershell +$Volumes = "E:", "F:" +foreach ($Volume in $Volumes) { + Get-ReFSDedupStatus -Volume $Volume +} +``` + +This example retrieves the deduplication status for both the `E:` and `F:` ReFS volume. + ## PARAMETERS ### -Volume -Specifies the ReFS volume for which to retrieve the deduplication status. +Specifies the ReFS volume for which to retrieve the deduplication status. 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 diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Resume-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Resume-ReFSDedupSchedule.md index 7b7889ec61..2ba6626e0e 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Resume-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Resume-ReFSDedupSchedule.md @@ -21,7 +21,7 @@ Resume-ReFSDedupSchedule [-Volume] [] ## DESCRIPTION The `Resume-ReFSDedupSchedule` cmdlet resumes the deduplication schedule on a specified ReFS -volume. This cmdlet is used to resume a deduplication job that has been paused or stopped. +volume that has been paused or stopped. ## EXAMPLES @@ -37,7 +37,9 @@ This example resumes the deduplication schedule for the `D:` ReFS volume. ### -Volume -Specifies the ReFS volume for which to resume the deduplication schedule. +Specifies the ReFS volume for which to resume the deduplication 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 diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupSchedule.md index 72266d6b35..2bac750cd9 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupSchedule.md @@ -284,7 +284,9 @@ Accept wildcard characters: False ### -Volume -Specifies the ReFS volume for which to set the deduplication schedule. +Specifies the ReFS volume for which to set the deduplication 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 diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupScrubSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupScrubSchedule.md index 698ab09390..606c945c12 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupScrubSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupScrubSchedule.md @@ -22,8 +22,7 @@ Set-ReFSDedupScrubSchedule [-Volume] -Start -Days [-Duration ] [-FullRun] [-CpuPer ## DESCRIPTION -The `Start-ReFSDedupJob` cmdlet starts a deduplication job on the specified ReFS volume. This -cmdlet can be used to start a new deduplication job or to resume an existing job that was -previously paused or stopped. +The `Start-ReFSDedupJob` cmdlet starts a deduplication job on the specified ReFS volume or to +resume an existing job that was previously paused or stopped. ## EXAMPLES @@ -36,6 +35,12 @@ previously paused or stopped. Start-ReFSDedupJob -Volume "D:" ``` +```output +Id Name PSJobTypeName State HasMoreData Location Command +-- ---- ------------- ----- ----------- -------- ------- +1 Job1 NotStarted True Start-ReFSDedupJob +``` + This example starts a deduplication job on the `D:` drive using the default settings. ## PARAMETERS @@ -258,7 +263,9 @@ Accept wildcard characters: False ### -Volume -Specifies the ReFS volume on which to run the job. +Specifies the ReFS volume on which to run the job. 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 diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Stop-ReFSDedupJob.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Stop-ReFSDedupJob.md index 8d3e46b2a1..d54d61642a 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Stop-ReFSDedupJob.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Stop-ReFSDedupJob.md @@ -20,8 +20,8 @@ Stop-ReFSDedupJob [-Volume] [] ## DESCRIPTION -The `Stop-ReFSDedupJob` cmdlet stops a running deduplication job on a specified ReFS volume. This -cmdlet is used to stop a deduplication job that is currently running. +The `Stop-ReFSDedupJob` cmdlet stops a running deduplication job on a specified ReFS volume that is +currently running. ## EXAMPLES @@ -37,7 +37,9 @@ This example stops the deduplication job for the `D:` ReFS volume. ### -Volume -Specifies the ReFS volume for which to stop the deduplication job. +Specifies the ReFS volume for which to stop the deduplication job. 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 diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Suspend-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Suspend-ReFSDedupSchedule.md index d97af22e2e..2de6d6a0a1 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Suspend-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Suspend-ReFSDedupSchedule.md @@ -38,7 +38,9 @@ This example suspends the deduplication schedule on the `D:` ReFS volume. ### -Volume -Specifies the volume on which to suspend the ReFS Deduplication schedule. +Specifies the volume on which to suspend the ReFS Deduplication 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 From 9e3c10953ca171fac9fdc3b4b58c639b71c9c962 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Tue, 26 Nov 2024 14:46:32 -0500 Subject: [PATCH 05/11] Applied PM/Dev feedback --- .../Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md | 4 ++-- .../Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md | 6 +++--- .../Get-ReFSDedupScrubSchedule.md | 6 +++--- .../Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md | 6 +++--- .../Microsoft.ReFsDedup.Commands.md | 2 +- .../Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md | 6 +++--- 6 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md index f9d54c6a87..9f6edc79a2 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md @@ -20,8 +20,8 @@ Clear-ReFSDedupSchedule [-Volume] [] ## DESCRIPTION -The `Clear-ReFSDedupSchedule` cmdlet clears the scheduled task for deduplication on the specified -ReFS volume. +The `Clear-ReFSDedupSchedule` cmdlet clears the scheduled job, including the schedule itself, for +deduplication on the specified ReFS volume. ## EXAMPLES diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md index d227959d08..fd0e5e95f8 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md @@ -31,14 +31,14 @@ volume. Get-ReFSDedupSchedule -Volume "D:" ``` -```output +This example retrieves the deduplication schedule for the `D:` ReFS volume. + +``` Volume Enabled Type Days Start Duration Suspended CompressionFormat CompressionLevel CompressionChunkSize ------ ------- ---- ---- ----- -------- --------- ----------------- ---------------- -------------------- D: True DedupAndCompress None N/A N/A False LZ4 0 0 B ``` -This example retrieves the deduplication schedule for the `D:` ReFS volume. - ## PARAMETERS ### -Volume diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md index a8371b4ca1..02609edc1d 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md @@ -31,14 +31,14 @@ ReFS volume. Get-ReFSDedupScrubSchedule -Volume "D:" ``` -```output +This example gets the deduplication scrub schedule on the `D:` ReFS volume. + +``` Volume Enabled Start Days WeeksInterval DedupDataOnly Suspended ------ ------- ----- ---- ------------- ------------- --------- D: True N/A None 0 False False ``` -This example gets the deduplication scrub schedule on the `D:` ReFS volume. - ## PARAMETERS ### -Volume diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md index ee56faba61..b1b7a76b01 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md @@ -31,14 +31,14 @@ volume. Get-ReFSDedupStatus -Volume "D:" ``` -```output +This example retrieves the deduplication status for the `D:` ReFS volume. + +``` Volume Type Used Deduped Compressed Format Level ChunkSize Status ------ ---- ---- ------- ---------- ------ ----- --------- ------ D: DedupAndCompress 1.02 GiB 0 B 0 B Uncompressed 0 0 B -- ``` -This example retrieves the deduplication status for the `D:` ReFS volume. - ### Example 2 ```powershell diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Microsoft.ReFsDedup.Commands.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Microsoft.ReFsDedup.Commands.md index 26ebde1502..8a1338ca44 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Microsoft.ReFsDedup.Commands.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Microsoft.ReFsDedup.Commands.md @@ -20,7 +20,7 @@ beginning of the cmdlet. ### [Clear-ReFSDedupSchedule](Clear-ReFSDedupSchedule.md) -Clears the scheduled task for deduplication on a specified ReFS volume. +Clears the scheduled job and the schedule itself for deduplication on a specified ReFS volume. ### [Clear-ReFSDedupScrubSchedule.md](Clear-ReFSDedupScrubSchedule.md) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md index 8ef7d6028d..839227f72b 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md @@ -35,14 +35,14 @@ resume an existing job that was previously paused or stopped. Start-ReFSDedupJob -Volume "D:" ``` -```output +This example starts a deduplication job on the `D:` drive using the default settings. + +``` Id Name PSJobTypeName State HasMoreData Location Command -- ---- ------------- ----- ----------- -------- ------- 1 Job1 NotStarted True Start-ReFSDedupJob ``` -This example starts a deduplication job on the `D:` drive using the default settings. - ## PARAMETERS ### -CompressionChunkSize From 0a26333b77d01b15c4d4921ec0fc1acf59438ae1 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Tue, 26 Nov 2024 15:17:46 -0500 Subject: [PATCH 06/11] Fix validation errors --- .../Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md | 2 +- .../Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md | 2 +- .../Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md | 2 +- .../Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md index fd0e5e95f8..0348bacddb 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md @@ -33,7 +33,7 @@ Get-ReFSDedupSchedule -Volume "D:" This example retrieves the deduplication schedule for the `D:` ReFS volume. -``` +```output Volume Enabled Type Days Start Duration Suspended CompressionFormat CompressionLevel CompressionChunkSize ------ ------- ---- ---- ----- -------- --------- ----------------- ---------------- -------------------- D: True DedupAndCompress None N/A N/A False LZ4 0 0 B diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md index 02609edc1d..0ba48c7634 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md @@ -33,7 +33,7 @@ Get-ReFSDedupScrubSchedule -Volume "D:" This example gets the deduplication scrub schedule on the `D:` ReFS volume. -``` +```output Volume Enabled Start Days WeeksInterval DedupDataOnly Suspended ------ ------- ----- ---- ------------- ------------- --------- D: True N/A None 0 False False diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md index b1b7a76b01..2eacb4142e 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md @@ -33,7 +33,7 @@ Get-ReFSDedupStatus -Volume "D:" This example retrieves the deduplication status for the `D:` ReFS volume. -``` +```output Volume Type Used Deduped Compressed Format Level ChunkSize Status ------ ---- ---- ------- ---------- ------ ----- --------- ------ D: DedupAndCompress 1.02 GiB 0 B 0 B Uncompressed 0 0 B -- diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md index 839227f72b..c179aaf528 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md @@ -37,7 +37,7 @@ Start-ReFSDedupJob -Volume "D:" This example starts a deduplication job on the `D:` drive using the default settings. -``` +```output Id Name PSJobTypeName State HasMoreData Location Command -- ---- ------------- ----- ----------- -------- ------- 1 Job1 NotStarted True Start-ReFSDedupJob From 0f6d313cabd4fb90b815a5ea46b263ceac1763fe Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Tue, 26 Nov 2024 17:53:21 -0500 Subject: [PATCH 07/11] Fix validation errors --- .../Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md | 2 +- .../Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md | 2 +- .../Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md | 2 +- .../Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md index 0348bacddb..73eb52415b 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md @@ -33,7 +33,7 @@ Get-ReFSDedupSchedule -Volume "D:" This example retrieves the deduplication schedule for the `D:` ReFS volume. -```output +```powershell Volume Enabled Type Days Start Duration Suspended CompressionFormat CompressionLevel CompressionChunkSize ------ ------- ---- ---- ----- -------- --------- ----------------- ---------------- -------------------- D: True DedupAndCompress None N/A N/A False LZ4 0 0 B diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md index 0ba48c7634..cb6a5353b2 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md @@ -33,7 +33,7 @@ Get-ReFSDedupScrubSchedule -Volume "D:" This example gets the deduplication scrub schedule on the `D:` ReFS volume. -```output +```powershell Volume Enabled Start Days WeeksInterval DedupDataOnly Suspended ------ ------- ----- ---- ------------- ------------- --------- D: True N/A None 0 False False diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md index 2eacb4142e..ad2eac7754 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md @@ -33,7 +33,7 @@ Get-ReFSDedupStatus -Volume "D:" This example retrieves the deduplication status for the `D:` ReFS volume. -```output +```powershell Volume Type Used Deduped Compressed Format Level ChunkSize Status ------ ---- ---- ------- ---------- ------ ----- --------- ------ D: DedupAndCompress 1.02 GiB 0 B 0 B Uncompressed 0 0 B -- diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md index c179aaf528..49632e6fc7 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md @@ -37,7 +37,7 @@ Start-ReFSDedupJob -Volume "D:" This example starts a deduplication job on the `D:` drive using the default settings. -```output +```powershell Id Name PSJobTypeName State HasMoreData Location Command -- ---- ------------- ----- ----------- -------- ------- 1 Job1 NotStarted True Start-ReFSDedupJob From e7e3d93539bc15567d437a77b5b89d04d96753ef Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Tue, 26 Nov 2024 18:09:00 -0500 Subject: [PATCH 08/11] Fix validation errors --- .../Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md | 2 +- .../Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md | 2 +- .../Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md | 2 +- .../Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md index 73eb52415b..0348bacddb 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md @@ -33,7 +33,7 @@ Get-ReFSDedupSchedule -Volume "D:" This example retrieves the deduplication schedule for the `D:` ReFS volume. -```powershell +```output Volume Enabled Type Days Start Duration Suspended CompressionFormat CompressionLevel CompressionChunkSize ------ ------- ---- ---- ----- -------- --------- ----------------- ---------------- -------------------- D: True DedupAndCompress None N/A N/A False LZ4 0 0 B diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md index cb6a5353b2..0ba48c7634 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md @@ -33,7 +33,7 @@ Get-ReFSDedupScrubSchedule -Volume "D:" This example gets the deduplication scrub schedule on the `D:` ReFS volume. -```powershell +```output Volume Enabled Start Days WeeksInterval DedupDataOnly Suspended ------ ------- ----- ---- ------------- ------------- --------- D: True N/A None 0 False False diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md index ad2eac7754..2eacb4142e 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md @@ -33,7 +33,7 @@ Get-ReFSDedupStatus -Volume "D:" This example retrieves the deduplication status for the `D:` ReFS volume. -```powershell +```output Volume Type Used Deduped Compressed Format Level ChunkSize Status ------ ---- ---- ------- ---------- ------ ----- --------- ------ D: DedupAndCompress 1.02 GiB 0 B 0 B Uncompressed 0 0 B -- diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md index 49632e6fc7..c179aaf528 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md @@ -37,7 +37,7 @@ Start-ReFSDedupJob -Volume "D:" This example starts a deduplication job on the `D:` drive using the default settings. -```powershell +```output Id Name PSJobTypeName State HasMoreData Location Command -- ---- ------------- ----- ----------- -------- ------- 1 Job1 NotStarted True Start-ReFSDedupJob From 645df2213bdd9b6eb38fd9cc972f0797595dd963 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Tue, 26 Nov 2024 18:42:20 -0500 Subject: [PATCH 09/11] Platy schema test --- .../Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md index 0348bacddb..d227959d08 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md @@ -31,14 +31,14 @@ volume. Get-ReFSDedupSchedule -Volume "D:" ``` -This example retrieves the deduplication schedule for the `D:` ReFS volume. - ```output Volume Enabled Type Days Start Duration Suspended CompressionFormat CompressionLevel CompressionChunkSize ------ ------- ---- ---- ----- -------- --------- ----------------- ---------------- -------------------- D: True DedupAndCompress None N/A N/A False LZ4 0 0 B ``` +This example retrieves the deduplication schedule for the `D:` ReFS volume. + ## PARAMETERS ### -Volume From bdd3860f01659de49ec31975a3ede6ad9ba0c570 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Tue, 26 Nov 2024 19:01:22 -0500 Subject: [PATCH 10/11] Platy schema test --- .../Get-ReFSDedupScrubSchedule.md | 4 ++-- .../Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md | 4 ++-- .../Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md index 0ba48c7634..a8371b4ca1 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md @@ -31,14 +31,14 @@ ReFS volume. Get-ReFSDedupScrubSchedule -Volume "D:" ``` -This example gets the deduplication scrub schedule on the `D:` ReFS volume. - ```output Volume Enabled Start Days WeeksInterval DedupDataOnly Suspended ------ ------- ----- ---- ------------- ------------- --------- D: True N/A None 0 False False ``` +This example gets the deduplication scrub schedule on the `D:` ReFS volume. + ## PARAMETERS ### -Volume diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md index 2eacb4142e..ee56faba61 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md @@ -31,14 +31,14 @@ volume. Get-ReFSDedupStatus -Volume "D:" ``` -This example retrieves the deduplication status for the `D:` ReFS volume. - ```output Volume Type Used Deduped Compressed Format Level ChunkSize Status ------ ---- ---- ------- ---------- ------ ----- --------- ------ D: DedupAndCompress 1.02 GiB 0 B 0 B Uncompressed 0 0 B -- ``` +This example retrieves the deduplication status for the `D:` ReFS volume. + ### Example 2 ```powershell diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md index c179aaf528..8ef7d6028d 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md @@ -35,14 +35,14 @@ resume an existing job that was previously paused or stopped. Start-ReFSDedupJob -Volume "D:" ``` -This example starts a deduplication job on the `D:` drive using the default settings. - ```output Id Name PSJobTypeName State HasMoreData Location Command -- ---- ------------- ----- ----------- -------- ------- 1 Job1 NotStarted True Start-ReFSDedupJob ``` +This example starts a deduplication job on the `D:` drive using the default settings. + ## PARAMETERS ### -CompressionChunkSize From 869bd65741306914ae9881dfb16afb2c4fe36057 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Tue, 26 Nov 2024 19:53:55 -0500 Subject: [PATCH 11/11] Update examples --- .../Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md | 6 ------ .../Get-ReFSDedupScrubSchedule.md | 6 ------ .../Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md | 6 ------ .../Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md | 6 ------ 4 files changed, 24 deletions(-) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md index d227959d08..31eb400407 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md @@ -31,12 +31,6 @@ volume. Get-ReFSDedupSchedule -Volume "D:" ``` -```output -Volume Enabled Type Days Start Duration Suspended CompressionFormat CompressionLevel CompressionChunkSize ------- ------- ---- ---- ----- -------- --------- ----------------- ---------------- -------------------- -D: True DedupAndCompress None N/A N/A False LZ4 0 0 B -``` - This example retrieves the deduplication schedule for the `D:` ReFS volume. ## PARAMETERS diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md index a8371b4ca1..45b1c4e7d6 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md @@ -31,12 +31,6 @@ ReFS volume. Get-ReFSDedupScrubSchedule -Volume "D:" ``` -```output -Volume Enabled Start Days WeeksInterval DedupDataOnly Suspended ------- ------- ----- ---- ------------- ------------- --------- -D: True N/A None 0 False False -``` - This example gets the deduplication scrub schedule on the `D:` ReFS volume. ## PARAMETERS diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md index ee56faba61..acba6b06ce 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupStatus.md @@ -31,12 +31,6 @@ volume. Get-ReFSDedupStatus -Volume "D:" ``` -```output -Volume Type Used Deduped Compressed Format Level ChunkSize Status ------- ---- ---- ------- ---------- ------ ----- --------- ------ -D: DedupAndCompress 1.02 GiB 0 B 0 B Uncompressed 0 0 B -- -``` - This example retrieves the deduplication status for the `D:` ReFS volume. ### Example 2 diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md index 8ef7d6028d..d36e0b3d7b 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Start-ReFSDedupJob.md @@ -35,12 +35,6 @@ resume an existing job that was previously paused or stopped. Start-ReFSDedupJob -Volume "D:" ``` -```output -Id Name PSJobTypeName State HasMoreData Location Command --- ---- ------------- ----- ----------- -------- ------- -1 Job1 NotStarted True Start-ReFSDedupJob -``` - This example starts a deduplication job on the `D:` drive using the default settings. ## PARAMETERS