Remove-VBRCatalystCopyJob

In this article

    Short Description

    Removes backup copy jobs for HPE StoreOnce repositories.

    Applies to

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

    Syntax

    Remove-VBRCatalystCopyJob [-Job] <VBRCatalystCopyJob[]> [-WhatIf] [-Confirm]  [<CommonParameters>]

    Detailed Description

    This cmdlet removes 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 remove these jobs.

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

    True

    0

    True (ByValue, ByPropertyName)

    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

    None.

    Removing Backup Copy Job for HPE StoreOnce Repository

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

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

    Remove-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 Remove-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.