Stop-VSBJob (obsolete)

Short Description

Stops running SureBackup job.

Note

This cmdlet is obsolete. Run the Stop-VBRSureBackupJob cmdlet instead.

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 the Start-VSBJob cmdlet to start the job manually.

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

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Job

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

Accepts the CSbJob[] object. To get this object, run the Get-VSBJob cmdlet.

True

1

True (ByValue,
ByProperty
Name)

RunAsync

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

SwitchParameter

False

Named

False

WhatIf

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

SwitchParameter

False

Named

False

Confirm

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

SwitchParameter

False

Named

False

<CommonParameters>

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

Examples

Stop-VSBJob (obsolete)Example 1. Stopping Specific SureBackup Job [Using Pipeline]

This example shows how to stop the AD SureJob SureBackup job.

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

Perform the following steps:

  1. Run the Get-VSBJob cmdlet. Specify the Name parameter value.
  2. Pipe the cmdlet output to the Stop-VSBJob cmdlet.

Stop-VSBJob (obsolete)Example 2. Stopping Specific SureBackup Job [Using Variable]

This example shows how to stop the AD SureJob SureBackup job.

$ADSureJob = Get-VSBJob -Name "AD SureJob"

Stop-VSBJob -Job $ADSureJob

Perform the following steps:

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

Related Commands

Get-VSBJob