diff --git a/docset/winserver2012-ps/adfs/Get-ADFSRelyingPartyTrust.md b/docset/winserver2012-ps/adfs/Get-ADFSRelyingPartyTrust.md index c7c52de02f..ebf6319706 100644 --- a/docset/winserver2012-ps/adfs/Get-ADFSRelyingPartyTrust.md +++ b/docset/winserver2012-ps/adfs/Get-ADFSRelyingPartyTrust.md @@ -46,14 +46,14 @@ Gets the current property settings for a relying party trust that is specified b ### -------------------------- EXAMPLE 2 -------------------------- ``` -C:\PS>Get-ADFSRelyingPartyTrust -Identifier https://SampleApp.SampleServer.org +C:\PS>Get-ADFSRelyingPartyTrust -Identifier https://www.fabrikam.com/ ``` Description ----------- -Gets the current property settings for a relying party trust that is specified by the identifier https://SampleApp.SampleServer.org. +Gets the current property settings for a relying party trust that is specified by the identifier `https://www.fabrikam.com`. ### -------------------------- EXAMPLE 3 -------------------------- ``` diff --git a/docset/winserver2016-ps/smbshare/Disable-SmbDelegation.md b/docset/winserver2016-ps/smbshare/Disable-SmbDelegation.md index 5578e052f7..039446c179 100644 --- a/docset/winserver2016-ps/smbshare/Disable-SmbDelegation.md +++ b/docset/winserver2016-ps/smbshare/Disable-SmbDelegation.md @@ -99,7 +99,7 @@ To check the functional level of the Active Directory forest, use the Get-ADFore ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) [Enable-SmbDelegation](./Enable-SmbDelegation.md) diff --git a/docset/winserver2016-ps/smbshare/Enable-SmbDelegation.md b/docset/winserver2016-ps/smbshare/Enable-SmbDelegation.md index 7f341f7cf4..2cd1d0e505 100644 --- a/docset/winserver2016-ps/smbshare/Enable-SmbDelegation.md +++ b/docset/winserver2016-ps/smbshare/Enable-SmbDelegation.md @@ -83,7 +83,7 @@ To check the functional level of the Active Directory forest, use the Get-ADFore ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) [Disable-SmbDelegation](./Disable-SmbDelegation.md) diff --git a/docset/winserver2016-ps/smbshare/Get-SmbBandwidthLimit.md b/docset/winserver2016-ps/smbshare/Get-SmbBandwidthLimit.md index bb1b4ed2bb..1123eee7e9 100644 --- a/docset/winserver2016-ps/smbshare/Get-SmbBandwidthLimit.md +++ b/docset/winserver2016-ps/smbshare/Get-SmbBandwidthLimit.md @@ -126,7 +126,7 @@ For more information, type `Get-Help Install-WindowsFeature`. When you enable th ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) [Set-SmbBandwidthLimit](./Set-SmbBandwidthLimit.md) diff --git a/docset/winserver2016-ps/smbshare/Get-SmbDelegation.md b/docset/winserver2016-ps/smbshare/Get-SmbDelegation.md index 68353c7d65..820f649625 100644 --- a/docset/winserver2016-ps/smbshare/Get-SmbDelegation.md +++ b/docset/winserver2016-ps/smbshare/Get-SmbDelegation.md @@ -67,7 +67,7 @@ To check the functional level of the Active Directory forest, use the **Get-ADFo ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) [Disable-SmbDelegation](./Disable-SmbDelegation.md) diff --git a/docset/winserver2016-ps/smbshare/Remove-SmbBandwidthLimit.md b/docset/winserver2016-ps/smbshare/Remove-SmbBandwidthLimit.md index 49a2f4f0f1..063c66c2a4 100644 --- a/docset/winserver2016-ps/smbshare/Remove-SmbBandwidthLimit.md +++ b/docset/winserver2016-ps/smbshare/Remove-SmbBandwidthLimit.md @@ -165,7 +165,7 @@ For more information, type `Get-Help Install-WindowsFeature`. When you enable th ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) [Get-SmbBandwidthLimit](./Get-SmbBandwidthLimit.md) diff --git a/docset/winserver2016-ps/smbshare/Set-SmbBandwidthLimit.md b/docset/winserver2016-ps/smbshare/Set-SmbBandwidthLimit.md index 072e4b7684..4a0ca28c90 100644 --- a/docset/winserver2016-ps/smbshare/Set-SmbBandwidthLimit.md +++ b/docset/winserver2016-ps/smbshare/Set-SmbBandwidthLimit.md @@ -175,7 +175,7 @@ For more information, type `Get-Help Install-WindowsFeature`. When you enable th ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) [Get-SmbBandwidthLimit](./Get-SmbBandwidthLimit.md) diff --git a/docset/winserver2016-ps/storage/Get-VirtualDisk.md b/docset/winserver2016-ps/storage/Get-VirtualDisk.md index 39545534f2..e0d94cccf9 100644 --- a/docset/winserver2016-ps/storage/Get-VirtualDisk.md +++ b/docset/winserver2016-ps/storage/Get-VirtualDisk.md @@ -624,7 +624,7 @@ You can use the pipeline operator to pass an MSFT_TargetVirtualDisk object to th ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk -This cmdlet outputs an object that represents the specified virtual disk. For more information about output object type, see [MSFT_VirtualDisk class](/previous-versions/windows/desktop/stormgmt/msft-virtualdisk). +This cmdlet outputs an object that represents the specified virtual disk. For more information about output object type, see [MSFT_VirtualDisk class](/windows-hardware/drivers/storage/msft-virtualdisk). ## NOTES diff --git a/docset/winserver2016-ps/tls/New-TlsSessionTicketKey.md b/docset/winserver2016-ps/tls/New-TlsSessionTicketKey.md index 8d70fbf266..2d3b3d707f 100644 --- a/docset/winserver2016-ps/tls/New-TlsSessionTicketKey.md +++ b/docset/winserver2016-ps/tls/New-TlsSessionTicketKey.md @@ -27,7 +27,7 @@ This mechanism helps to improve the performance of TLS. The TLS server uses this mechanism to create a key to encrypt a session ticket. The client can later use the encrypted session ticket to resume communication with the TLS server. Otherwise, the client must restart the communication by acquiring of new session ticket. -For more information, see [RFC 5077, Transport Layer Security (TLS) Session Resumption without Server-Side State](http://rfc5077.openrfc.org/). +For more information, see [RFC 5077, Transport Layer Security (TLS) Session Resumption without Server-Side State](https://datatracker.ietf.org/doc/html/rfc5077). ## EXAMPLES diff --git a/docset/winserver2019-ps/adfs/Remove-AdfsFarmNode.md b/docset/winserver2019-ps/adfs/Remove-AdfsFarmNode.md index b882661296..c76a64d5eb 100644 --- a/docset/winserver2019-ps/adfs/Remove-AdfsFarmNode.md +++ b/docset/winserver2019-ps/adfs/Remove-AdfsFarmNode.md @@ -87,5 +87,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Uninstall-WindowsFeature](/powershell/module/microsoft.windows.servermanager.migration/uninstall-windowsfeature) +[Uninstall-WindowsFeature](/powershell/module/servermanager/uninstall-windowsfeature) diff --git a/docset/winserver2019-ps/smbshare/Disable-SmbDelegation.md b/docset/winserver2019-ps/smbshare/Disable-SmbDelegation.md index 395583cf3d..bc2b8b9dcc 100644 --- a/docset/winserver2019-ps/smbshare/Disable-SmbDelegation.md +++ b/docset/winserver2019-ps/smbshare/Disable-SmbDelegation.md @@ -99,7 +99,7 @@ To check the functional level of the Active Directory forest, use the Get-ADFore ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) [Enable-SmbDelegation](./Enable-SmbDelegation.md) diff --git a/docset/winserver2019-ps/smbshare/Enable-SmbDelegation.md b/docset/winserver2019-ps/smbshare/Enable-SmbDelegation.md index 6e9db07530..22e1759636 100644 --- a/docset/winserver2019-ps/smbshare/Enable-SmbDelegation.md +++ b/docset/winserver2019-ps/smbshare/Enable-SmbDelegation.md @@ -83,7 +83,7 @@ To check the functional level of the Active Directory forest, use the Get-ADFore ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) [Disable-SmbDelegation](./Disable-SmbDelegation.md) diff --git a/docset/winserver2019-ps/smbshare/Get-SmbBandwidthLimit.md b/docset/winserver2019-ps/smbshare/Get-SmbBandwidthLimit.md index 3924822589..6309bd2b6a 100644 --- a/docset/winserver2019-ps/smbshare/Get-SmbBandwidthLimit.md +++ b/docset/winserver2019-ps/smbshare/Get-SmbBandwidthLimit.md @@ -126,7 +126,7 @@ For more information, type `Get-Help Install-WindowsFeature`. When you enable th ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) [Set-SmbBandwidthLimit](./Set-SmbBandwidthLimit.md) diff --git a/docset/winserver2019-ps/smbshare/Get-SmbDelegation.md b/docset/winserver2019-ps/smbshare/Get-SmbDelegation.md index 4d9e0f4aed..57a8fab0db 100644 --- a/docset/winserver2019-ps/smbshare/Get-SmbDelegation.md +++ b/docset/winserver2019-ps/smbshare/Get-SmbDelegation.md @@ -67,7 +67,7 @@ To check the functional level of the Active Directory forest, use the **Get-ADFo ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) [Disable-SmbDelegation](./Disable-SmbDelegation.md) diff --git a/docset/winserver2019-ps/smbshare/Remove-SmbBandwidthLimit.md b/docset/winserver2019-ps/smbshare/Remove-SmbBandwidthLimit.md index 795cbf3ce9..33ff0abc82 100644 --- a/docset/winserver2019-ps/smbshare/Remove-SmbBandwidthLimit.md +++ b/docset/winserver2019-ps/smbshare/Remove-SmbBandwidthLimit.md @@ -165,7 +165,7 @@ For more information, type `Get-Help Install-WindowsFeature`. When you enable th ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) [Get-SmbBandwidthLimit](./Get-SmbBandwidthLimit.md) diff --git a/docset/winserver2019-ps/smbshare/Set-SmbBandwidthLimit.md b/docset/winserver2019-ps/smbshare/Set-SmbBandwidthLimit.md index 560cda959f..2fc8f3409c 100644 --- a/docset/winserver2019-ps/smbshare/Set-SmbBandwidthLimit.md +++ b/docset/winserver2019-ps/smbshare/Set-SmbBandwidthLimit.md @@ -175,7 +175,7 @@ For more information, type `Get-Help Install-WindowsFeature`. When you enable th ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) [Get-SmbBandwidthLimit](./Get-SmbBandwidthLimit.md) diff --git a/docset/winserver2019-ps/storage/Get-VirtualDisk.md b/docset/winserver2019-ps/storage/Get-VirtualDisk.md index 59f1e8fb4f..eba081fddb 100644 --- a/docset/winserver2019-ps/storage/Get-VirtualDisk.md +++ b/docset/winserver2019-ps/storage/Get-VirtualDisk.md @@ -624,7 +624,7 @@ You can use the pipeline operator to pass an MSFT_TargetVirtualDisk object to th ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk -This cmdlet outputs an object that represents the specified virtual disk. For more information about output object type, see [MSFT_VirtualDisk class](/previous-versions/windows/desktop/stormgmt/msft-virtualdisk). +This cmdlet outputs an object that represents the specified virtual disk. For more information about output object type, see [MSFT_VirtualDisk class](/windows-hardware/drivers/storage/msft-virtualdisk). ## NOTES diff --git a/docset/winserver2019-ps/tls/New-TlsSessionTicketKey.md b/docset/winserver2019-ps/tls/New-TlsSessionTicketKey.md index fc003a547f..5978188214 100644 --- a/docset/winserver2019-ps/tls/New-TlsSessionTicketKey.md +++ b/docset/winserver2019-ps/tls/New-TlsSessionTicketKey.md @@ -27,7 +27,7 @@ This mechanism helps to improve the performance of TLS. The TLS server uses this mechanism to create a key to encrypt a session ticket. The client can later use the encrypted session ticket to resume communication with the TLS server. Otherwise, the client must restart the communication by acquiring of new session ticket. -For more information, see [RFC 5077, Transport Layer Security (TLS) Session Resumption without Server-Side State](http://rfc5077.openrfc.org/). +For more information, see [RFC 5077, Transport Layer Security (TLS) Session Resumption without Server-Side State](https://datatracker.ietf.org/doc/html/rfc5077). ## EXAMPLES diff --git a/docset/winserver2022-ps/smbshare/Get-SmbBandwidthLimit.md b/docset/winserver2022-ps/smbshare/Get-SmbBandwidthLimit.md index 35166e83a7..0bc11c0b76 100644 --- a/docset/winserver2022-ps/smbshare/Get-SmbBandwidthLimit.md +++ b/docset/winserver2022-ps/smbshare/Get-SmbBandwidthLimit.md @@ -126,7 +126,7 @@ For more information, type `Get-Help Install-WindowsFeature`. When you enable th ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) [Set-SmbBandwidthLimit](./Set-SmbBandwidthLimit.md) diff --git a/docset/winserver2022-ps/smbshare/Remove-SmbBandwidthLimit.md b/docset/winserver2022-ps/smbshare/Remove-SmbBandwidthLimit.md index e786707c9a..2409b89c95 100644 --- a/docset/winserver2022-ps/smbshare/Remove-SmbBandwidthLimit.md +++ b/docset/winserver2022-ps/smbshare/Remove-SmbBandwidthLimit.md @@ -165,7 +165,7 @@ For more information, type `Get-Help Install-WindowsFeature`. When you enable th ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) [Get-SmbBandwidthLimit](./Get-SmbBandwidthLimit.md) diff --git a/docset/winserver2022-ps/storage/Get-VirtualDisk.md b/docset/winserver2022-ps/storage/Get-VirtualDisk.md index 1eee5baa1b..7fc458b33c 100644 --- a/docset/winserver2022-ps/storage/Get-VirtualDisk.md +++ b/docset/winserver2022-ps/storage/Get-VirtualDisk.md @@ -624,7 +624,7 @@ You can use the pipeline operator to pass an MSFT_TargetVirtualDisk object to th ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk -This cmdlet outputs an object that represents the specified virtual disk. For more information about output object type, see [MSFT_VirtualDisk class](/previous-versions/windows/desktop/stormgmt/msft-virtualdisk). +This cmdlet outputs an object that represents the specified virtual disk. For more information about output object type, see [MSFT_VirtualDisk class](/windows-hardware/drivers/storage/msft-virtualdisk). ## NOTES diff --git a/docset/winserver2022-ps/tls/New-TlsSessionTicketKey.md b/docset/winserver2022-ps/tls/New-TlsSessionTicketKey.md index 7e4e5fdacd..06cb1a6320 100644 --- a/docset/winserver2022-ps/tls/New-TlsSessionTicketKey.md +++ b/docset/winserver2022-ps/tls/New-TlsSessionTicketKey.md @@ -29,7 +29,7 @@ mechanism. This mechanism helps to improve the performance of TLS. The TLS serve mechanism to create a key to encrypt a session ticket. The client can later use the encrypted session ticket to resume communication with the TLS server. Otherwise, the client must restart the communication by acquiring of new session ticket. For more information, see -[RFC 5077, Transport Layer Security (TLS) Session Resumption without Server-Side State](http://rfc5077.openrfc.org/). +[RFC 5077, Transport Layer Security (TLS) Session Resumption without Server-Side State](https://datatracker.ietf.org/doc/html/rfc5077). ## EXAMPLES diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Clear-ReFSDedupSchedule.md index 7048f16c5d..9f6edc79a2 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,30 @@ Clear-ReFSDedupSchedule [-Volume] [] ``` ## 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) 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..6ff14ef990 --- /dev/null +++ b/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] [] +``` + +## 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) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Disable-ReFSDedup.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Disable-ReFSDedup.md index 825c83389b..c814e8bba4 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,31 @@ 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. 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) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Enable-ReFSDedup.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Enable-ReFSDedup.md index 6c0a2085b4..c144e92ac3 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,40 @@ Enable-ReFSDedup [-Volume] [-Type] [ {{ 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) diff --git a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupSchedule.md index e09af3fe98..31eb400407 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,30 @@ Get-ReFSDedupSchedule [-Volume] [] ``` ## DESCRIPTION -{{ Fill in the Description }} + +The `Get-ReFSDedupSchedule` cmdlet retrieves the deduplication schedule for a specified ReFS +volume. ## 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. 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 + +[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..45b1c4e7d6 --- /dev/null +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Get-ReFSDedupScrubSchedule.md @@ -0,0 +1,77 @@ +--- +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. + +## 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. 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 + +[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..acba6b06ce 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,41 @@ Get-ReFSDedupStatus [-Volume] [] ``` ## DESCRIPTION -{{ Fill in the Description }} + +The `Get-ReFSDedupStatus` cmdlet retrieves the status of data deduplication on a specified ReFS +volume. ## EXAMPLES ### Example 1 + +```powershell +Get-ReFSDedupStatus -Volume "D:" +``` + +This example retrieves the deduplication status for the `D:` ReFS volume. + +### Example 2 + ```powershell -PS C:\> {{ Add example code here }} +$Volumes = "E:", "F:" +foreach ($Volume in $Volumes) { + Get-ReFSDedupStatus -Volume $Volume +} ``` -{{ Add example description here }} +This example retrieves the deduplication status for both the `E:` and `F:` ReFS volume. ## PARAMETERS ### -Volume -{{ Fill Volume Description }} + +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: System.String +Type: String Parameter Sets: (All) Aliases: @@ -48,7 +65,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 +78,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..8a1338ca44 100644 --- a/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Microsoft.ReFsDedup.Commands.md +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Microsoft.ReFsDedup.Commands.md @@ -4,42 +4,68 @@ 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 --- # 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 job and the schedule itself 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..2ba6626e0e 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,30 @@ Resume-ReFSDedupSchedule [-Volume] [] ``` ## DESCRIPTION -{{ Fill in the Description }} + +The `Resume-ReFSDedupSchedule` cmdlet resumes the deduplication schedule on a specified ReFS +volume 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. 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 + +[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..2bac750cd9 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,13 @@ Accept wildcard characters: False ``` ### -Volume -{{ Fill Volume Description }} + +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: System.String +Type: String Parameter Sets: (All) Aliases: @@ -264,7 +301,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 +314,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..606c945c12 --- /dev/null +++ b/docset/winserver2025-ps/Microsoft.ReFsDedup.Commands/Set-ReFSDedupScrubSchedule.md @@ -0,0 +1,160 @@ +--- +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. + +## 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. 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 +``` + +### -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..d36e0b3d7b 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,41 @@ 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 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 +56,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 +78,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 +94,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 +110,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 +126,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 +142,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 +158,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 +174,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 +190,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 +206,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 +224,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 +240,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 +256,13 @@ Accept wildcard characters: False ``` ### -Volume -{{ Fill Volume Description }} + +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: System.String +Type: String Parameter Sets: (All) Aliases: @@ -248,7 +274,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 +287,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..d54d61642a 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,30 @@ Stop-ReFSDedupJob [-Volume] [] ``` ## DESCRIPTION -{{ Fill in the Description }} + +The `Stop-ReFSDedupJob` cmdlet stops a running deduplication job on a specified ReFS volume 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. 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,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..2de6d6a0a1 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,31 @@ 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. 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,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..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/20/2016 +ms.date: 11/20/2024 title: Deduplication --- diff --git a/docset/winserver2025-ps/defender/Get-MpComputerStatus.md b/docset/winserver2025-ps/defender/Get-MpComputerStatus.md index 02c12b56f4..15e1de2f03 100644 --- a/docset/winserver2025-ps/defender/Get-MpComputerStatus.md +++ b/docset/winserver2025-ps/defender/Get-MpComputerStatus.md @@ -33,6 +33,7 @@ computer. PS C:\> Get-MpComputerStatus AMEngineVersion : 1.1.9700.0 AMProductVersion : 4.3.9463.0 +AMRunningMode : Normal AMServiceEnabled : True AMServiceVersion : 4.3.9463.0 AntispywareEnabled : True diff --git a/docset/winserver2025-ps/storage/Get-VirtualDisk.md b/docset/winserver2025-ps/storage/Get-VirtualDisk.md index 0477fdea43..0a5d4c7b1a 100644 --- a/docset/winserver2025-ps/storage/Get-VirtualDisk.md +++ b/docset/winserver2025-ps/storage/Get-VirtualDisk.md @@ -624,7 +624,7 @@ You can use the pipeline operator to pass an MSFT_TargetVirtualDisk object to th ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk -This cmdlet outputs an object that represents the specified virtual disk. For more information about output object type, see [MSFT_VirtualDisk class](/previous-versions/windows/desktop/stormgmt/msft-virtualdisk). +This cmdlet outputs an object that represents the specified virtual disk. For more information about output object type, see [MSFT_VirtualDisk class](/windows-hardware/drivers/storage/msft-virtualdisk). ## NOTES diff --git a/docset/winserver2025-ps/tls/New-TlsSessionTicketKey.md b/docset/winserver2025-ps/tls/New-TlsSessionTicketKey.md index a251810fa8..4608ca3a0d 100644 --- a/docset/winserver2025-ps/tls/New-TlsSessionTicketKey.md +++ b/docset/winserver2025-ps/tls/New-TlsSessionTicketKey.md @@ -29,7 +29,7 @@ mechanism. This mechanism helps to improve the performance of TLS. The TLS serve mechanism to create a key to encrypt a session ticket. The client can later use the encrypted session ticket to resume communication with the TLS server. Otherwise, the client must restart the communication by acquiring of new session ticket. For more information, see -[RFC 5077, Transport Layer Security (TLS) Session Resumption without Server-Side State](http://rfc5077.openrfc.org/). +[RFC 5077, Transport Layer Security (TLS) Session Resumption without Server-Side State](https://datatracker.ietf.org/doc/html/rfc5077). ## EXAMPLES