The Cancel-Job command enables you to cancel the jobs that are in queued or in running state.
Cancel-Job-Server <Exchange_server_name>-JobID <numerical_job_id>-AllJobs <True|False>common parameters
If the job is in the queue, SnapManager removes the job from the queue. If the job is running, the cmdlet cancels the running job. This command also supports the following common parameters:
- -Debug (-db)
- -ErrorAction (-ea)
- -ErrorVariable (-ev)
- -OutBuffer (-ob)
- -OutVariable (-ov)
- -Verbose (-vb)
- -Confirm
To learn more about common parameters, see help about_ubiquitous_parameters.
Parameters
- -Server <Exchange_server_name>
- Short name: svr
- Specifies the name of the Exchange server.
- If you do not specify this parameter, the default host is the name of the server that runs this cmdlet. -Server is an optional parameter.
- -JobID <numerical_job_id>
- Short name: id
- Identifies a particular job that is handled by the SnapManager server.
- -JobID is a required parameter if you did not specify -AllJobs.
- -AllJobs <True|False
- Short name: all
- If this parameter is set to true, all the jobs including those in running and in queued states are cancelled.
- -AllJobs is a required parameter if you did not specify -JobID.
Example: Cancelling a job
This command cancels the job running in the Exchange server Exchange1 with Job ID 123.
Cancel-Job -Server Exchange1 -JobID 123
Example: Cancelling a job managed by a remote integrity verification server
This command cancels all the queued and running jobs managed by the remote integrity verification server.
Cancel-Job -Server VerificationServer1 -AllJobs