This is an archive version of the document. To get the most up-to-date information, see the current version.

Disable-VBRJob

In this article

    Short Description

    Puts a selected job on hold.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus

    Syntax

    Disable-VBRJob -Job <CBackupJob[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Related Commands

    Get-VBRJob

    Detailed Description

    This cmdlet puts a selected job on hold. The job and its settings are not deleted from Veeam Backup & Replication. You can enable the job at any time by running Enable-VBRJob.

    You can run this cmdlet with backup, replication and copy jobs.

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

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Job

    Specifies the job you want to disable.

    You can assign multiple jobs to this object.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Example 1

    This command disables jobs named "Backup Job 01" and "Backup Job 02".The jobs object is obtained with Get-VBRJob and piped down.

    PS C:\PS> Get-VBRJob -Name "Backup Job 01", "Backup Job 02" | Disable-VBRJob

    Example 2

    This command disables the job represented by the $job variable. The job object is obtained with Get-VBRJob and assigned to the variable beforehand.

    PS C:\PS> Disable-VBRJob -Job $job