Edit

Get-DedupJob

  • Reference
Module:
Deduplication

Returns status and information for currently running or queued deduplication jobs.

Syntax

Get-DedupJob
   [[-Type] <Type[]>]
   [[-Volume] <String[]>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]

Description

The Get-DedupJob returns status and information for currently running or queued deduplication jobs.

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

Examples

1:

PS C:\>

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

Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet.

Type:CimSession[]
Aliases:Session
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 the names the type of data deduplication jobs for which to return the job state. The acceptable values for this parameter are: Optimization, GarbageCollection, Scrubbing, Unoptimization.

Type:Type[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Volume

Specifies one or more file system volumes for which to return DeduplicationJob objects. Enter one or more volume IDs, drive letters (such as D:), or volume GUID pathnames (using the form \\\\?\Volume{{GUID}}\\). Separate multiple volumes with a comma.

Returns a DeduplicationJob object for every currently active data deduplication job regardless of current job state.

Type:String[]
Aliases:Path, Name
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String[]

Microsoft.PowerShell.Cmdletization.GeneratedTypes.DedupJob.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.