Stop-VBRSureBackupJob

Short Description

Stops the SureBackup job.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Stop-VBRSureBackupJob -Job <VBRSureBackupJobBase> [-RunAsync] [-WhatIf]

[-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet stops the SureBackup job.

Run the Start-VBRSureBackupJob cmdlet to start the SureBackup job.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Job	Specifies a SureBackup job. The cmdlet will stop that job. Accepts the `VBRSureBackupJobBase` object. To create this object, run the `Get-VBRSureBackupJob` cmdlet.	`VBRSureBackupJobBase`	True	Named	True (ByPropertyName, ByValue)
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	`SwitchParameter`	False	Named	False
Confirm	Defines that the cmdlet will display a prompt that asks if the user is sure that he wants to continue. Note: Microsoft PowerShell enables the `Confirm` parameter for this cmdlet by default. To disable this option, set the parameter value to `$false`. That is, `Confirm:$false`.	`SwitchParameter`	False	Named	False
WhatIf	Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Stopping SureBackup Job

This example shows how to stop a SureBackup Job.

$job = Get-VBRSureBackupJob -Name "SureJob 2"

Stop-VBRSureBackupJob -Job $job

Perform the following steps:

Run the Get-VBRSureBackupJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Stop-VBRSureBackupJob cmdlet. Set the $job variable as the Job parameter value.