Disable-VBRComputerBackupJob

In this article

    Short Description

    Disables Veeam Agent backup jobs and Veeam Agent backup policies.

    Applies to

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

    Syntax

    Disable-VBRComputerBackupJob [-Job] <VBRComputerBackupJob[]> [-PassThru]  [<CommonParameters>]

    Detailed Description

    This cmdlet disables Veeam Agent backup jobs and Veeam Agent backup policies.

    Run the Enable-VBRComputerBackupJob cmdlet to enable Veeam Agent backup jobs and Veeam Agent backup policies.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Job

    Specifies a Veeam Agent backup job or a Veeam Agent backup policy that you want to disable.

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

    True

    0

    True (ByValue, ByPropertyName)

    PassThru

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

    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

    This cmdlet returns the VBRComputerBackupJob object that contains settings of disabled Veeam Agent backup jobs and Veeam Agent backup policies.

    Examples

    Disabling Veeam Agent backup Job

    This example shows how to disable the WinSrv2049 Veeam Agent Backup Job.

    $job = Get-VBRComputerBackupJob -Name "WinSrv2049"

    Disable-VBRComputerBackupJob -Job $job

    Perform the following steps:

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

    Related Commands

    Get-VBRComputerBackupJob

    I want to report a typo

    There is a misspelling right here:

     

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