Stop-DedupJob

Cancels one or more specified data deduplication jobs.

Syntax

Stop-DedupJob
    [-AsJob]
    [-CimSession <CimSession[]>]
    [-Id <String[]>]
    [-PassThru]
    [-ThrottleLimit <Int32>]
    [<CommonParameters>]
Stop-DedupJob
    [-AsJob]
    [-CimSession <CimSession[]>]
    -InputObject <CimInstance[]>
    [-PassThru]
    [-ThrottleLimit <Int32>]
    [<CommonParameters>]
Stop-DedupJob
    [-Volume] <String[]>
    [[-Type] <Type[]>]
    [-AsJob]
    [-CimSession <CimSession[]>]
    [-PassThru]
    [-ThrottleLimit <Int32>]
    [<CommonParameters>]

Description

The Stop-DedupJob cmdlet cancels one or more specified data deduplication jobs.

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

Examples

Example 1: Stop jobs on a specified volume

PS C:\> Stop-DedupJob -Volume "D:"

This command stops the deduplication jobs on the D: volume.

Required Parameters

-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
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Volume

Specifies one or more file system volumes on which to cancel one or more named data deduplication jobs. 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.

Type:String[]
Aliases:Path, Name, DeviceId
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional 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
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
Accept pipeline input:False
Accept wildcard characters:False
-Id

Identifies the job to cancel. To obtain this ID, run the Get-DedupJob cmdlet.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns an object representing data deduplication settings to stop.

Type:SwitchParameter
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-Type

Specifies an array of types of data deduplication jobs schedules for which to return DeduplicationJobSchedule objects. The acceptable values for this parameter are:

  • Optimization
  • GarbageCollection
  • Scrubbing
  • Unoptimization
Type:Type[]
Parameter Sets:Optimization, GarbageCollection, Scrubbing, Unoptimization
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Inputs

System.String[]

Inputs

Microsoft.Management.Infrastructure.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.

Inputs

Microsoft.PowerShell.Cmdletization.GeneratedTypes.DedupJob.Type[]

Outputs

Microsoft.Management.Infrastructure.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.

Outputs

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJob

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.