Edit

Set-ReFSDedupScrubSchedule

Module:
Microsoft.ReFsDedup.Commands Module

Sets the deduplication scrub schedule on the specified ReFS volume.

Syntax

Default (Default) 

Set-ReFSDedupScrubSchedule
    [-Volume] <String>
    -Start <DateTime>
    -Days <DaysOfWeek>
    -WeeksInterval <UInt16>
    [-DedupDataOnly <Boolean>]
    [<CommonParameters>]

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

$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

Parameter properties

Type:DaysOfWeek
Default value:None
Accepted values:None, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, EveryDay
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DedupDataOnly

Specifies whether to include only deduplicated data in the scrub schedule.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Start

Specifies the date and time on which to start the scrub schedule.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WeeksInterval

Specifies the number of weeks between each run of the scrub schedule.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

Object