Remove-VBRNASBackupJob

In this article

    Short Description

    Removes file backup jobs from Veeam Backup & Replication infrastructure.

    Applies to

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

    Syntax

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

    Detailed Description

    This cmdlet removes file backup jobs from Veeam Backup & Replication infrastructure.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Job

    Specifies a file backup job. The cmdlet will remove this job from the Veeam Backup & Replication infrastructure.

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

    True

    Named

    True (ByValue, ByPropertyName)

     

    WhatIf

    Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.

    SwitchParameter

    False

    Named

    False

     

    Confirm

    Defines that the cmdlet will display a prompt that asks if the user is sure that he wants 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

    The cmdlet returns the VBRNASBackupJob object that contains settings of file backup jobs.

    Examples

    Remove-VBRNASBackupJobExample 1. Removing All File Backup Jobs

    This example shows how to remove all file backup jobs from the Veeam Backup & Replication infrastructure.

    $job = Get-VBRNASBackupJob

    Remove-VBRNASBackupJob -Job $job

    Perform the following steps:

    1. Run the Get-VBRNASBackupJob cmdlet. Save the result to the $job variable.
    2. Run the Remove-VBRNASBackupJob cmdlet. Set the $job variable as the Job parameter value.

    Remove-VBRNASBackupJobExample 2. Removing File Backup Jobs by Name

    This example shows how to remove the SMB Job file backup jobs.

    $job = Get-VBRNASBackupJob - "SMB Job"

    Remove-VBRNASBackupJob -Job $job

    Perform the following steps:

    1. Run the Get-VBRNASBackupJob cmdlet. Save the result to the $job variable.
    2. Run the Remove-VBRNASBackupJob cmdlet. Set the $job variable as the Job parameter value.

    Related Commands

    Get-VBRNASBackupJob

    I want to report a typo

    There is a misspelling right here:

     

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