Backup Exec Management Command Line Interface Help
Stop-BEJob Cmdlet
Synopsis

Cancels active Backup Exec jobs.

Syntax
Stop-BEJob -InputObject [<BEJob[]>] [-TimeoutSeconds [<Int32>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Description

Cancels active Backup Exec jobs in progress.

Stop-BEJob returns the job histories associated with the jobs that were canceled.

If you do not specify the -TimeoutSeconds parameter, Stop-BEJob waits indefinitely for the specified jobs to reach a canceled state.

If you specify -TimeoutSeconds parameter and the time is exceeded before the job reaches a canceled state, the command returns even if the job is still running. No error message displays.

Parameters

-TimeoutSeconds <Int32>

Determines the maximum wait time for each job in seconds. If the time is exceeded before the job reaches a canceled state, the command returns even if the job is still running. No error message is displayed.


Required false
Position Named
Accepts pipeline input false
Accepts wildcard characters false


-InputObject <BEJob[]>

Specifies one or more job objects. Enter a variable that contains the objects, or type a command or expression that gets the objects.


Required true
Position Named
Accepts pipeline input true (ByValue)
Accepts wildcard characters false


-WhatIf <SwitchParameter>

Describes what happens if you execute the command without actually executing the command.


Required false
Position Named
Accepts pipeline input false
Accepts wildcard characters false


-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.


Required false
Position Named
Accepts pipeline input false
Accepts wildcard characters false


<CommonParameters>

For more information about common parameters, type "Get-Help about_commonparameters".

Input Type
BackupExec.Management.CLI.BEJob

You can pipe a Backup Exec job object to Stop-BEJob.

Return Value
BackupExec.Management.CLI.BEJobHistory

Stop-BEJob returns a Backup Exec job history object if the -TimeoutSeconds time is not exceeded, otherwise nothing is returned.

Example
C:\PS> Get-BEJob "Job 0001" | Stop-BEJob

These commands cancel a job named "Job 0001".

Related Link

Get-BEJob