Edit

Start-ReFSDedupJob

Starts a deduplication job on the specified ReFS volume.

Syntax

Default (Default)

Start-ReFSDedupJob
    [-Volume] <String>
    [-Duration <TimeSpan>]
    [-FullRun]
    [-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 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

Start-ReFSDedupJob -Volume "D:"

This example starts a deduplication job on the D: drive using the default settings.

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

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

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 concurrently during the job.

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 to use during the job.

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

-DecompressionTuning

Specifies the decompression tuning to use during the job.

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 of the job.

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

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

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

-FullRun

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.

Parameter properties

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

-Volume

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.

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