Edit

Share via

Get-DedupSchedule

  • Reference
Module:
Deduplication

Returns the deduplication job schedule defined on the computer.

Syntax

Get-DedupSchedule
   [[-Name] <String[]>]
   [-Type <Type[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-DedupSchedule cmdlet returns the DeduplicationJobSchedule objects defined on the computer.

To run this cmdlet, you must start Windows PowerShell® with the Run as administrator option.

Examples

Example 1: Get active schedules

Get-DedupSchedule

This command returns the currently active data deduplication schedule objects created using the New-DedupSchedule cmdlet.

Example 2: Get schedules for optimization jobs

Get-DedupSchedule -Type Optimization

This command returns all data deduplication schedules for optimization jobs.

Example 3: Get a named schedule

Get-DedupSchedule -Name MySchedule

This command returns the data deduplication schedule named MySchedule.

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

-Name

Specifies the friendly name of one or more data deduplication job schedules for which to return DeduplicationJobSchedule objects.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
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 job schedules for which to return DeduplicationJobSchedule objects. The acceptable values for this parameter are:

  • Optimization
  • GarbageCollection
  • Scrubbing
  • Unoptimization
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

CimInstance

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.

CimInstance

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.