Disable-VBRCatalystCopyJob

Short Description

Disables backup copy jobs for HPE StoreOnce repositories.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Disable-VBRCatalystCopyJob [-Job] <VBRCatalystCopyJob[]> [-PassThru] [-WhatIf] [-Confirm]  [<CommonParameters>]

Detailed Description

This cmdlet disables backup copy jobs for HPE StoreOnce repositories.

Run the Enable-VBRCatalystCopyJob cmdlet to enable backup copy jobs for HPE StoreOnce repositories.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Job

Specifies an array of backup copy jobs for HPE StoreOnce repositories. The cmdlet will disable these jobs.

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

True

0

True (ByValue, ByPropertyName)

PassThru

Defines that the command returns the output object to the Windows PowerShell console.

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 the About CommonParameters section of Microsoft Docs.

Output Object

The cmdlet returns the VBRCatalystCopyJob object that contains settings of backup copy jobs for HPE StoreOnce repositories.

Examples

Disabling Backup Copy Job for HPE StoreOnce Repository

This example shows how to disable the StoreOnce copy job backup copy job for an HPE StoreOnce repository.

$job = Get-VBRCatalystCopyJob -Name "StoreOnce copy job"

Disable-VBRCatalystCopyJob -Job $job

Perform the following steps:

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

Related Commands

Get-VBRCatalystCopyJob

I want to report a typo

There is a misspelling right here:

 

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