Disable-VBRPluginJob

Short Description

Stops plug-in backup jobs and plug-in backup copy jobs.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Disable-VBRPluginJob [-Job] <VBRPluginJob[]> [-Force] [-WhatIf] [-Confirm]  [<CommonParameters>]

Detailed Description

This cmdlet stops plug-in backup jobs and plug-in backup copy jobs.

Run the Enable-VBRPluginJob cmdlet to start plug-in backup jobs and plug-in backup copy jobs.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Job

Specifies an array of plug-in backup jobs and plug-in backup copy jobs. The cmdlet will stop these jobs.

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

True

0

True (ByValue)

WhatIf

Specifies a list of all jobs that will be disabled.

SwitchParameter

False

Named

False

Confirm

Defines that the cmdlet will display a prompt that asks if you want to continue running the command.

SwitchParameter

False

Named

False

Force

Defines that the cmdlet will return a notification that the backup files created by the plug-in backup copy job will be left in the inconsistent state after running this cmdlet.

SwitchParameter

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.

Example

Stopping All Plug-in Backup Jobs and Plug-in Backup Copy Jobs

This example shows how to stop plug-in backup jobs and plug-in backup copy jobs.

$job = Get-VBRPluginJob

Disable-VBRPluginJob -Job $job

Perform the following steps:

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

Related Commands

Get-VBRPluginJob

I want to report a typo

There is a misspelling right here:

 

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