Disable-VBRJobSchedule

In this article

    Short Description

    Disables job schedule.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

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

    Detailed Description

    This cmdlet disables job schedule. The schedule settings are not deleted.

    When you disable a job schedule, you can launch the job manually. Run Start-VBRJob to start the job once.

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

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Job

    Specifies the array of jobs. The cmdlet will disable schedule in these jobs.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Example 1

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

    Get-VBRJob -Name "Backup Job 01" | Disable-VBRJobSchedule

    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.

    Disable-VBRJobSchedule -Job $job

    Related Commands

    Get-VBRJob

    I want to report a typo

    There is a misspelling right here:

     

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