Set-DedupSchedule
Changes configuration settings for data deduplication schedules.
Syntax
Set-DedupSchedule
[-Name] <String[]>
[-Type <Type[]>]
[-DurationHours <UInt32>]
[-Enabled <Boolean>]
[-StopWhenSystemBusy <Boolean>]
[-Memory <UInt32>]
[-Cores <UInt32>]
[-Priority <Priority>]
[-InputOutputThrottle <UInt32>]
[-InputOutputThrottleLevel <InputOutputThrottleLevel>]
[-Start <DateTime>]
[-Days <DayOfWeek[]>]
[-Full <Boolean>]
[-ReadOnly <Boolean>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[<CommonParameters>] Set-DedupSchedule
-InputObject <CimInstance[]>
[-DurationHours <UInt32>]
[-Enabled <Boolean>]
[-StopWhenSystemBusy <Boolean>]
[-Memory <UInt32>]
[-Cores <UInt32>]
[-Priority <Priority>]
[-InputOutputThrottle <UInt32>]
[-InputOutputThrottleLevel <InputOutputThrottleLevel>]
[-Start <DateTime>]
[-Days <DayOfWeek[]>]
[-Full <Boolean>]
[-ReadOnly <Boolean>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[<CommonParameters>] Description
The Set-DedupSchedule cmdlet changes configuration settings for one or more data deduplication
schedules.
Examples
Example 1: Change settings of a data deduplication schedule for a garbage collection job
$params = @{
Days = 'Sunday'
DurationHours = 5
Name = 'OffHoursGC'
Priority = 'Normal'
Start = '08:00'
Type = 'GarbageCollection'
}
Set-DedupSchedule @paramsThis command changes the settings of a data deduplication schedule for a garbage collection job
named OffHoursGC. The job is scheduled to run every Sunday at 08:00 with Normal
Priority. The command specifies that the server cancels the job after 5 hours if the process
has not ended.
Example 2: Change settings of a data deduplication schedule for a scrubbing job
$params = @{
Days = Monday,Tuesday,Wednesday,Thursday,Friday
DurationHours = 6
Name = "OffHoursScrub"
Priority = Normal
Start = 23:00
StopWhenSystemBusy = $true
Type = Scrubbing
}
Set-DedupSchedule @paramsThis command changes the settings of a data deduplication schedule for a Scrubbing Type job
with a Name of OffHoursScrub. The command starts the scrubbing job at 23:00 every day Monday
through Friday at normal priority. 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.
Example 3: Change settings of a data deduplication schedule for an optimization job
$params = @{
Days = @(
'Monday'
'Tuesday'
'Wednesday'
'Thursday'
'Friday'
)
DurationHours = 9
Name = 'MyWeekendOptimization'
Start = '08:00'
Type = 'Optimization'
}
Set-DedupSchedule @paramsThis command changes the settings of a data deduplication schedule for an optimization job named
MyWeekdayOptimization. The optimization job runs at a Normal Priority every weekday evening
at 08:00. DurationHours 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CimSession
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.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Cores
Specifies the maximum percentage of physical cores that a job uses.
| Type: | UInt32 |
| Aliases: | MaximumCoresPercentage |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Days
Specifies an array of days of the week on which the server runs the data deduplication job. The acceptable values for this parameter are:
MondayTuesdayWednesdayThursdayFridaySaturdaySunday
| Type: | DayOfWeek[] |
| Accepted values: | Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DurationHours
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.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Enabled
Indicates whether a data deduplication schedule is enabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Full
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.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
| Type: | CimInstance[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputOutputThrottle
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.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputOutputThrottleLevel
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:
NoneLowMediumHigh
| Type: | InputOutputThrottleLevel |
| Accepted values: | None, Low, Medium, High, Maximum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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 higher memory consumption, such as 50.
| Type: | UInt32 |
| Aliases: | MaximumMemoryPercentage |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of a data deduplication job schedule.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Priority
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.
| Type: | Priority |
| Accepted values: | Low, Normal, High |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReadOnly
Indicates whether the scrubbing job processes and reports on corruptions that it finds but does not run any repair actions.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Start
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]).
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StopWhenSystemBusy
Indicates whether 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.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ThrottleLimit
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.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Type
Specifies an array of types of data deduplication jobs. The acceptable values for this parameter are:
OptimizationGarbageCollectionScrubbingUnoptimization
| Type: | Type[] |
| Accepted values: | Optimization, GarbageCollection, Scrubbing, Unoptimization |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
String[]
Microsoft.PowerShell.Cmdletization.GeneratedTypes.DedupSchedule.Type[]
Outputs
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.
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.