The New-DedupSchedule cmdlet creates a data deduplication schedule. This cmdlet returns a
DeduplicationSchedule object that you can use to customize the data deduplication schedule. This
cmdlet uses default settings to create a data deduplication schedule for the parameters that you do
not specify.
You can create a schedule to run the following types data deduplication jobs:
Optimization This job performs both deduplication and compression of files according data
deduplication policy for the volume. After initial optimization of a file, if that file is then
modified and again meets the data deduplication policy threshold for optimization, the file is
optimized again.
GarbageCollection This job processes deleted or modified data on the volume so that any data
chunks that are no longer referenced are cleaned up. Garbage collection jobs process previously
deleted or logically overwritten optimized content to create usable volume free space. When an
optimized file is deleted or overwritten by new data, the old data in the chunk store is not
immediately deleted. Garbage collection is scheduled to run weekly by default. Garbage collection
is a processing-intensive operation, so you should allow the deletion load to reach a threshold
and then manually run this job type, or schedule it for off hours.
Scrubbing This job processes data corruptions it finds during data integrity validation,
performs possible corruption repair, and generates a scrubbing report.
Unoptimization This job undoes data deduplication on all of the optimized files on the volume.
At the end of a successful unoptimization job, the server deletes all of the data deduplication
metadata from the volume.
Example 1: Create a data deduplication schedule for a garbage collection job
$params = @{
Days = 'Sunday'
DurationHours = 5
Name = 'OffHoursGC'
Priority = 'Normal'
Start = '08:00'
Type = 'GarbageCollection'
}
New-DedupSchedule @params
This command creates a data deduplication schedule with a Name of OffHoursGC. The
deduplication job Type is GarbageCollection. The job is scheduled to run every Sunday via
the Days Parameter. The job will Start at 08:00 and run at NormalPriority. The
command specifies DurationHours of 5 causing the server to cancel the job after 5 hours if the
process has not ended.
Example 2: Create a data deduplication schedule for a scrubbing job
This command creates a data deduplication schedule for a ScrubbingType job named
OffHoursScrub. The command starts the scrubbing job at 23:00 on each day Monday through Friday.
The StopWhenSystemBusy parameter specifies that the server stops the job when the system is busy
and retries later. The DurationHours parameter specifies that the server cancels the job after
6 hours if the process has not ended. The job will run at NormalPriority
Example 3: Create a data deduplication schedule for an optimization job
$params = @{
Days = @(
'Mon'
'Tues'
'Wed'
'Thurs'
'Fri'
)
DurationHours = 9
Name = 'MyWeekdayOptimization'
Start = '08:00'
Type = 'Optimization'
}
New-DedupSchedule @params
This command creates a data deduplication schedule for an OptimizationType job named
MyWeekdayOptimization. The optimization job runs at a normal Priority every weekday evening at
08:00. The DurationHours parameter specifies that the server cancels the job after 9 hours
if the process has not ended.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
complete.
The cmdlet immediately returns an object that represents the job and then displays the command
prompt. You can continue to work in the session while the job completes. To manage the job, use the
*-Job cmdlets. To get the job results, use the
Receive-Job cmdlet.
For more information about Windows PowerShell background jobs, see
about_Jobs.
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
object, such as the output of a New-CimSession or
Get-CimSession cmdlet. The default is the
current session on the local computer.
Indicates that the server disables the data deduplication schedule immediately after you create it.
The server does not run the data deduplication schedule at the time that you specify in the
Start parameter. After you disable a data deduplication schedule, you can use the
Set-DedupSchedule cmdlet to enable the schedule.
Specifies the number of hours that the server runs the task before canceling it. The value 0
indicates that the server runs the job to completion. This cmdlet safely stops a data deduplication
job and does not affect the files that the server is processing when it cancels the job.
Indicates that garbage collection jobs free up all deleted or unreferenced data on the volume, if
you specify the value GarbageCollection for the Type parameter. If you do not specify this
parameter, garbage collection jobs free up space after a system threshold of delete data is
exceeded. We recommend that you run garbage collection regularly without specifying this parameter,
and then once a month specify this parameter and run garbage collection again.
If you specify the value Scrubbing for the Type parameter, this parameter indicates that
scrubbing jobs validate the integrity of all data on the volume. If you do not specify this
parameter, the scrubbing job validates only critical metadata and data integrity issues that data
deduplication previously encountered. We recommend that you run scrubbing regularly without
specifying this parameter, and then once a month specify this parameter and run scrubbing again.
Specifies the amount of input/output throttling applied to the deduplication job. Throttling ensures
that deduplication does not interfere with other I/O intensive processes. The acceptable values for
this parameter are: integers from 0 to 100. If you specify this parameter and the
InputOutputThrottleLevel parameter, InputOutputThrottle takes precedence.
Specifies the amount of I/O throttling that the job provides to ensure that the job does not
interfere with other I/O intensive processes. The acceptable values for this parameter are:
None
Low
Medium
High
Parameter properties
Type:
InputOutputThrottleLevel
Default value:
None
Accepted values:
None, Low, Medium, High, Maximum
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
-Memory
Specifies the maximum percentage of physical computer memory that the data deduplication job can
use.
For optimization jobs, we recommend that you set a range from 15 to 50, and a higher memory
consumption for jobs that you schedule to run when you specify the StopWhenSystemBusy parameter.
For garbage collection and scrubbing jobs, which you typically schedule to run in off hours, you can
set a higher memory consumption, such as 50.
Sets the CPU and I/O priority for the optimization job that you run by using this cmdlet. For jobs
that you run when you specify the StopWhenSystemBusy parameter, we recommend that you set this
parameter to Low. For typical optimization jobs, we recommend that you set this parameter to
Normal.
Parameter properties
Type:
Priority
Default value:
None
Accepted values:
Low, Normal, High
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ReadOnly
Indicates that the scrubbing job processes and reports on corruptions that it finds but does not run
any repair actions.
Specifies a time to start this job. The default value is 1:45am.
Type the date in a format that is standard for the system locale, such as dd-MM-yyyy (German
[Germany]) or MM/dd/yyyy (English [United States]).
Indicates that the server stops the job when the system is busy and retries later. We recommend that
you specify this parameter when you set a low priority for the job.
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
computer.
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
-Type
Specifies the type of data deduplication job. The acceptable values for this parameter are:
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.
The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays
Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the
namespace and class name for the underlying WMI object.