Edit

Stop-DedupJob

  • Reference
Module:
Deduplication

Cancels one or more specified data deduplication jobs.

Syntax

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

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

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

-Id

Identifies the job to be cancel. This can be obtained by running the Get-DedupJob cmdlet.

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

-InputObject

Specifies the CIM instance object that represents the instance to be changed. Enter a variable that contains the object, or type a cmdlet or expression that gets the object, such as the Get-DedupVolume cmdlet. A service object can be piped to the Set-DedupVolume cmdlet.

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

-PassThru

Returns an object representing data deduplication settings you want to stop and pushes it through the pipeline to the next cmdlet.

Type:SwitchParameter
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 of one or more types of data deduplication job schedules for which to return DeduplicationJobSchedule objects. The acceptable values for this parameter are: Optimization, GarbageCollection, Scrubbing, and Unoptimization.

Type:Type[]
Position:2
Default value:None
Required:False
Accept pipeline input:True
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 (such as D:), or volume GUID pathnames (using the form \\\\?\Volume{{GUID}}\\). Separate multiple volumes with a comma.

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

Inputs

String[]

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.

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.