Disable-VBRJob

Short Description

Puts a selected job on hold.

Platform: VMware, Hyper-V

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

Syntax

Disable-VBRJob -Job <CBackupJob[]> [<CommonParameters>]

Detailed Description

This cmdlet disables an enabled job. The job and its settings are not deleted from Veeam Backup & Replication. You can run this cmdlet with backup, replication and tape jobs.

Run the Disable-VBRBackupCopyJob cmdlet to disable a backup copy job.

Run the Enable-VBRJob cmdlet to enable the job.

Run the Stop-VBRJob cmdlet to stop the job once without disabling it.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Job	Specifies the array of jobs you want to disable. Accepts the `CBackupJob` object. To get this object, run the `Get-VBRJob` or `Get-VBRTapeJob` cmdlet.	`CBackupJob[]`	True	Named	True (ByPropertyName, ByValue)

<CommonParameters>

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

Examples

Disable-VBRJob Example 1. Disabling Specific Jobs [Using Pipeline]

This example shows how to disable jobs named Backup Job 01 and Backup Job 02.

Get-VBRJob -Name "Backup Job 01", "Backup Job 02" | Disable-VBRJob

Perform the following steps:

Run the Get-VBRJob cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Disable-VBRJob cmdlet.

Disable-VBRJob Example 2. Disabling Specific Job [Using Variable]

This example shows how to disable the job represented by the $job variable.

$job = Get-VBRJob -Name "Backup Job"

Disable-VBRJob -Job $job

Perform the following steps:

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

Get-VBRJob