Stop-VBRJob

In this article

    Short Description

    Stops a running backup, replication or copy job.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Stop-VBRJob [-Job] <CBackupJob[]> [-RunAsync] [-Gracefully] [-WhatIf] [-Confirm]  [<CommonParameters>]

    Detailed Description

    This cmdlet stops a running backup, replication or copy job. The job is stopped once, the scheduled job will start the next scheduled time.

    Run the Start-VBRJob cmdlet to start the job manually.

    Run the Disable-VBRJob cmdlet to temporarily disable a job.

    Run the Stop-VSBJob cmdlet to stop a SureBackup job.

    Run the Stop-VBRComputerBackupJob cmdlet to stop Veeam Agent backup jobs and Veeam Agent backup policies.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Job

    Specifies the array of jobs you want to stop.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    False

    RunAsync

    Indicates that the command returns immediately without waiting for the task to complete.

    False

    Named

    False

    False

    Gracefully

    Defines that the cmdlet will stop a job gracefully.

    False

    Named

    False

    False

    WhatIf

    Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

    False

    Named

    False

    False

    Confirm

    Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

    False

    Named

    False

    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 stops the copy job named "SharePoint File Copy Job". The needed job object is obtained with Get-VBRJob and piped down.

    Get-VBRJob -Name "SharePoint File Copy Job" | Stop-VBRJob

    Example 2

    This command stops the copy job represented by the $SharePointFileCopyJob variable. The needed session object is obtained with Get-VBRJob and assigned to the variable beforehand.

    Stop-VBRJob -Job $SharePointFileCopyJob

    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.