Stop-VSBJob

Short Description

Stops running SureBackup job.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Stop-VSBJob [-Job] <CSbJob[]> [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet stops a running SureBackup job. The job is stopped once, the scheduled SureBackup job will start the next scheduled time.

Run Start-VSBJob to start the job manually.

Run Stop-VBRJob to stop a backup, replication or copy job.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Job

Specifies the array of the SureBackup jobs. The cmdlet will stop these jobs.

True

1

True (ByValue,
ByProperty
Name)

False

RunAsync

Indicates that the command returns immediately without waiting for the task to complete.

False

Named

False

False

WhatIf

Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

False

Named

False

False

Confirm

Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Example 1

This command stops the SureBackup job named "AD SureJob". The needed job object is obtained with Get-VSBJob and piped down.

Get-VSBJob -Name "AD SureJob" | Stop-VSBJob

Example 2

This command stops the SureBackup job represented by the $ADSureJob variable. The needed job object is obtained with Get-VSBJob and assigned to the variable beforehand.

Stop-VSBJob -Job $ADSureJob

Related Commands

Get-VSBJob