Add-VBRNASBackupJob

In this article

    Short Description

    Creates file backup jobs.

    Applies to

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

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Create file backup jobs.

    Add-VBRNASBackupJob -BackupObject <VBRNASBackupObject[]> -ShortTermBackupRepository <CBackupRepository> [-Name <String>] [-Description <String>] [-ShortTermRetentionType <VBRNASBackupShortTermRetentionType>][-ShortTermRetentionPeriod <Int32>] [-SecondaryTarget <VBRNASBackupSecondaryTarget[]>] [-VersionRetentionOptions <VBRNASBackupVersionRetentionOptions>] [-StorageOptions <VBRStorageOptions>] [-HealthCheckOptions <VBRFullBackupOptions>] [-NotificationOptions <VBRNotificationOptions>] [-ScriptOptions <VBRJobScriptOptions>] [-EnableFileACLChangeTracking <SwitchParameter>] [-ScheduleOptions <VBRServerScheduleOptions>] [-Force <SwitchParameter>] [-HighPriority] [<CommonParameters>]>]

    • Create file backup jobs with a long-term repository.

    Add-VBRNASBackupJob -BackupObject <VBRNASBackupObject[]> -ShortTermBackupRepository <CBackupRepository> -LongTermBackupRepository <IRepository> [-EnableFileACLChangeTracking <SwitchParameter>] [-ScriptOptions <VBRJobScriptOptions>] [-NotificationOptions <VBRNotificationOptions>] [-HealthCheckOptions <VBRFullBackupOptions>] [-StorageOptions <VBRStorageOptions>] [-VersionRetentionOptions <VBRNASBackupVersionRetentionOptions>] [-SecondaryTarget <VBRNASBackupSecondaryTarget[]>] [-LongTermArchivalOptions <VBRNASBackupArchivalOptions>] [-LongTermRetentionPeriod <Int32>] [-LongTermRetentionType <VBRNASBackupLongTermRetentionType>] [-ShortTermRetentionPeriod <Int32>] [-ShortTermRetentionType <VBRNASBackupShortTermRetentionType>] [-Description <String>] [-Name <String>] [-ScheduleOptions <VBRServerScheduleOptions>] [-Force <SwitchParameter>] [-HighPriority] [<CommonParameters>]

    Detailed Description

    This cmdlet creates file backup jobs.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    BackupObject

    Specifies folders and files. The cmdlet will add these folders and files to the file backup job.

    Accepts the VBRNASBackupJobObject[] object. To create this object, run the New-VBRNASBackupJobObject cmdlet.

    True

    Named

    False

    ShortTermBackupRepository

    Specifies the backup repository. The cmdlet will add this backup repository as the short-term repository.

    Accepts the CBackupRepository object. To create this object, run the Get-VBRBackupRepository cmdlet.

    True

    Named

    False

    LongTermBackupRepository

    Specifies the backup repository. The cmdlet will add this backup repository as the long-term repository.

    Accepts the CBackupRepository object. To get this object, run the following cmdlets:

    True

    Named

    False

    Name

    Specifies a name of the file backup job. The cmdlet will create the file backup job with the specified name.

    String

    False

    Named

    False

    Description

    Specifies a description of the file backup job. The cmdlet will create the file backup job with the specified description.

    String

    False

    Named

    False

    ShortTermRetentionType

    Specifies a retention policy for the short-term repository. You can set the retention policy to either of the following periods:

    • Daily: use this option if you want Veeam Backup & Replication to apply retention policy daily.
    • Monthly: use this option if you want Veeam Backup & Replication to apply retention policy monthly.

    Use the ShortTermRetentionPeriod to specify the number of days or months.

    VBRNASBackupShortTermRetentionType

    False

    Named

    False

    ShortTermRetentionPeriod

    For the ShortTermRetentionType option.

    Specifies the period of time to keep data on the short-term repository. When this period is passed, Veeam Backup & Replication will move data to the long-term repository.

    Int32

    False

    Named

    False

    LongTermRetentionType

    Specifies a retention policy for the long-term repository. You can set the retention policy to either of the following periods:

    • Daily: use this option if you want Veeam Backup & Replication to apply retention policy daily.
    • Monthly: use this option if you want Veeam Backup & Replication to apply retention policy monthly.

    Use the LongTermRetentionPeriod to specify the number of days or months.

    VBRNASBackupLongTermRetentionType

    False

    Named

    False

    LongTermRetentionPeriod

    For the LongTermRetentionType option.

    Specifies the period of time to keep data on the short-term repository. When this period is passed, Veeam Backup & Replication will delete this data from the long-term repository.

    Int32

    False

    Named

    False

    LongTermArchivalOptions

    Specifies the retention policy for file versions that are located on the long-term repository. The cmdlet will create file backup jobs with the specified retention policy.

    Accepts the VBRNASBackupArchivalOptions object. To create this object, run the New-VBRNASBackupArchivalOptions cmdlet.

    False

    Named

    False

    SecondaryTarget

    Specifies the backup repository. The cmdlet will add this backup repository as the secondary repository to a file backup job.

    Accepts the VBRNASBackupSecondaryTarget[] object. To create this object, run the New-VBRNASBackupSecondaryTarget cmdlet.

    False

    Named

    False

    VersionRetentionOptions

    Specifies the settings of version-based retention for backup and archive repositories. The cmdlet will apply these settings to the file backup job.

    Accepts the VBRNASBackupVersionRetentionOptions object. To create this object, run the New-VBRNASBackupVersionRetentionOptions cmdlet.

    False

    Named

    False

    StorageOptions

    Specifies storage optimization settings. The cmdlet will create a file backup job with these settings.

    Accepts the VBRStorageOptions object. To create this object, run the New-VBRStorageOptions cmdlet.

    False

    Named

    False

    HealthCheckOptions

    Specifies the healthcheck schedule. The cmdlet will create a file backup job with this healthcheck schedule.

    Accepts the VBRFullBackupOptions object. To create this object, run the New-VBRFullBackupOptions cmdlet.

    False

    Named

    False

    NotificationOptions

    Specifies notification options. The cmdlet will create file backup jobs with these notification options.

    Accepts the VBRNotificationOptions object. To create this object, run the New-VBRFullBackupOptions cmdlet.

    False

    Named

    False

    ScriptOptions

    Specifies pre-job and post-job script options. The cmdlet will create file backup jobs with these script options.

    Accepts the VBRJobScriptOptions object. To create this object, run the New-VBRJobScriptOptions cmdlet.

    False

    Named

    False

    EnableFileACLChangeTracking

    Defines that Veeam Backup & Replication will process attributes and permissions for folders. Files that are added to these folders will inherit permissions of the folders.

    If you enable this option, Veeam Backup & Replication will back up folder ACL attributes and permissions. Otherwise, they will not be backed up.

    SwitchParameter

    False

    Named

    False

    ScheduleOptions

    Specifies schedule options. The cmdlet will create file backup jobs with these schedule options.

    Accepts the VBRJobScriptOptions object. To create this object, run the New-VBRServerScheduleOptions cmdlet.

    False

    Named

    False

    Force

    Indicates that the cmdlet will add a file backup without showing warnings or errors in the PowerShell console.

    SwitchParameter

    False

    Named

    False

    HighPriority

    Note: This parameter is available starting from Veeam Backup & Replication 11a (build 11.0.1.1261).

    Defines that Veeam Backup & Replication will prioritize this job higher than other similar jobs and will allocate resources to it in the first place.

    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.

    Output Object

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

    Examples

    Add-VBRNASBackupJobExample 1. Creating File Backup Job

    This example shows how to create a file backup job with the following settings:

    • The file backup job will process files that are located on the \WinSRV2049 server in the \\WinSRV2049\Documents\January folder.
    • The backup files will be stored on the Repository05 short-term repository.

     

    $server = Get-VBRNASServer -Name "\\WinSRV2049\Documents"

    $object = New-VBRNASBackupJobObject -Server $server -Path "\\WinSRV2049\Documents\January"

    $repository = Get-VBRBackupRepository -Name "Repository05"

    Add-VBRNASBackupJob -BackupObject $object -ShortTermBackupRepository $repository

    Perform the following steps:

    1. Run the Get-VBRNASServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
    2. Run the New-VBRNASBackupJobObject cmdlet. Set the $server variable as the Server parameter value. Specify the Path parameter value.
    3. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
    4. Run the Add-VBRNASBackupJob cmdlet. Set the $object variable as the BackupObject parameter value. Set the $repository variable as the ShortTermBackupRepository parameter value.

    Add-VBRNASBackupJobExample 2. Creating File Backup Job with Long-Term Repository

    This example shows how to create a file backup job. The job will be created with the following settings:

    • The file backup job will process files that are located on the \WinSRV2027 server in the \\WinSRV2027\Documents\Reports folder.
    • The backup files will be stored on the Repository07 short-term repository until the retention period is passed.
    • After retention period is passed, the backup files will be moved to the Repository10 long-term repository.

     

    $server = Get-VBRNASServer -Name "\\WinSRV2049\Documents"

    $object = New-VBRNASBackupJobObject -Server $server -Path "\\WinSRV2027\Documents\Reports"

    $shortrepository = Get-VBRBackupRepository -Name "Repository07"

    $archiverepository = Get-VBRBackupRepository -Name "Repository10"

    Add-VBRNASBackupJob -BackupObject $object -ShortTermBackupRepository $repository -LongTermBackupRepository $archiverepository

    Perform the following steps:

    1. Run the Get-VBRNASServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
    2. Run the New-VBRNASBackupJobObject cmdlet. Set the $server variable as the Server parameter value. Specify the Path parameter value.
    3. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $shortrepository variable.
    4. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $archiverepository variable.
    5. Run the Add-VBRNASBackupJob cmdlet. Specify the following settings:
    • Set the $object variable as the BackupObject parameter value.
    • Set the $shortrepository variable as the ShortTermBackupRepository parameter value.
    • Set the $archiverepository variable as the LongTermBackupRepository parameter value.

    Related Commands