Share via


Stop-DPMJob

Stops DPM jobs.

Syntax

CancelDpmJob (Default)

Stop-DPMJob
    [-Job] <Job[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CancelDpmTask

Stop-DPMJob
    [-Task] <Task[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Stop-DPMJob cmdlet stops jobs that are running in System Center - Data Protection Manager (DPM).

Examples

Example 1: Stop all DPM jobs

PS C:\>$PGroup = Get-DPMProtectionGroup -DPMServerName "Contoso-DPMServer"
PS C:\> $Jobs = Get-DPMJob -ProtectionGroup $PGroup -Status InProgress
PS C:\> Stop-DPMJob -Job $Jobs

The first command uses the Get-DPMProtectionGroup cmdlet to get the protection group for the server named Contoso-DPMServer. The command stores the group in the $PGroup variable.

The second command uses the Get-DPMJob cmdlet to get the jobs that are running for the protection group. The command stores the jobs in the $Jobs variable.

The third command stops the jobs stored in $Job.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Job

Specifies an array of jobs that this cmdlet stops. To obtain Job objects, use the Get-DPMJob cmdlet.

Parameter properties

Type:

Job[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CancelDpmJob
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Task

Specifies an array of task objects.

Parameter properties

Type:

Task[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CancelDpmTask
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.