Skip to main content
SnapCenter 5.0 cmdlets

Cancel-SmJob

Contributors

Cancels backup, clone, and verification jobs, which are in queued state. This cmdlet also cancels the running SnapCenter Plug-in for SQL Server and SnapCenter Plug-in for Oracle backup jobs.

Syntax

Cancel-SmJob [-JobId]  <Int32>  [-Force]  <>

Detailed Description

Enables you to cancel the queued backup, clone, and verification jobs, as well as the running restore and clone jobs for all plug-ins. You can also cancel the running SnapCenter Plug-in for SQL Server and SnapCenter Plug-in for Oracle backup jobs.This cmdlet does not cancel running backup jobs for SnapCenter Plug-in for Exchange, SnapCenter Plug-in for VMware vSphere, SnapCenter Plug-in for SAP HANA, or SnapCenter Custom Plug-ins.This cmdlet replaces the Cancel-SmQueuedJob cmdlet that was available in earlier versions of SnapCenter.

Parameters

Name Description Required? Pipeline Input Default Value

JobId

Specifies the ID of the job you want to cancel.

true

false

Force

This optional parameter cancels a hung job that is running or queued.

false

false

Examples

Example 1: Canceling a Running/Queued job

 Cancel-SmJob -JobId 231

This example syntax cancels the backup job which is either running or queued.

Cancel-SmJob
Job 231 will be canceled. Do you want to continue?
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y

Example 2: Canceling a Running/Queued job with Force option

 Cancel-SmJob -JobId 231 -Force

This example syntax cancels the backup job which is hung during canceling or running state.

Cancel-SmJob
Job 231 will be canceled. Do you want to continue?
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y