Edit

Set-ReFSDedupSchedule

Module:
Microsoft.ReFsDedup.Commands Module

Sets the deduplication schedule on a specified ReFS volume.

Syntax

Default (Default) 

Set-ReFSDedupSchedule
    [-Volume] <String>
    -Start <DateTime>
    [-Duration <TimeSpan>]
    -Days <DaysOfWeek>
    [-CpuPercentage <UInt32>]
    [-ConcurrentOpenFiles <UInt32>]
    [-MinimumLastModifiedTimeHours <Int32>]
    [-ExcludeFileExtension <String[]>]
    [-ExcludeFolder <String[]>]
    [-CompressionFormat <Format>]
    [-CompressionLevel <UInt16>]
    [-CompressionChunkSize <UInt32>]
    [-CompressionTuning <UInt32>]
    [-RecompressionTuning <UInt32>]
    [-DecompressionTuning <UInt32>]
    [<CommonParameters>]

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

Set-ReFSDedupSchedule -Volume "D:" -Start "10:00 PM" -Days Monday,Wednesday,Friday -Duration 4:00:00

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

Specifies the chunk size to use during compression.

Parameter properties

Type:UInt32
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

-CompressionFormat

Specifies the compression format to use during deduplication. Acceptable values are:

  • LZ4
  • Uncompressed
  • Unknown
  • ZSTD

Parameter properties

Type:Format
Default value:None
Accepted values:Unknown, Uncompressed, LZ4, ZSTD
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

-CompressionLevel

Specifies the compression level to use during deduplication.

Parameter properties

Type:UInt16
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

-CompressionTuning

Specifies the compression tuning to use during deduplication.

Parameter properties

Type:UInt32
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

-ConcurrentOpenFiles

Specifies the maximum number of files that can be open at the same time during deduplication.

Parameter properties

Type:UInt32
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

-CpuPercentage

Specifies the maximum percentage of CPU usage that deduplication should consume.

Parameter properties

Type:UInt32
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

-Days

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

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

-DecompressionTuning

Specifies the decompression tuning to use during deduplication.

Parameter properties

Type:UInt32
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

-Duration

Specifies the duration for which deduplication should run on the volume.

Parameter properties

Type:TimeSpan
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

-ExcludeFileExtension

Specifies one or more file extensions to exclude from deduplication.

Parameter properties

Type:

String[]

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

-ExcludeFolder

Specifies one or more folders to exclude from deduplication.

Parameter properties

Type:

String[]

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

-MinimumLastModifiedTimeHours

Specifies the minimum number of hours that must elapse before a file can be deduplicated.

Parameter properties

Type:Int32
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

-RecompressionTuning

Specifies the recompression tuning to use during deduplication.

Parameter properties

Type:UInt32
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 when deduplication should start running on the volume.

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 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.

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

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