Stop-VBRSureBackupJob

Short Description

Stops SureBackup jobs.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Stop-VBRSureBackupJob -Job <VBRSureBackupJob> [-RunAsync] [-WhatIf] [-Confirm]  [<CommonParameters>]

Detailed Description

This cmdlet stops SureBackup jobs.

Run the Start-VBRSureBackupJob cmdlet to start SureBackup jobs.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Job

Specifies a SureBackup job. The cmdlet will stop that job.

Accepts the VBRSureBackupJob object. To create this object, run the Get-VBRSureBackupJob cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

RunAsync

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

SwitchParamter

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.

SwitchParamter

False

Named

False

Confirm

Defines that the cmdlet will display a prompt that asks if the user is sure that he wants to continue.

SwitchParamter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of 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:

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

Related Commands

Get-VBRSureBackupJob

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.