Add-VBRNASBackupJob

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 repository as the short-term backup storage.

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

True

Named

False

LongTermBackupRepository

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

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

• Get-VBRBackupRepository: use this cmdlet to get backup repositories.
• Get-VBRObjectStorageRepository: use this cmdlet to get object storage repositories.

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 backup 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 backup repository. When this period is passed, Veeam Backup & Replication will move data to the long-term archive repository.

Int32

False

Named

False

LongTermRetentionType

Specifies a retention policy for the long-term archive 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 long-term archive repository. When this period is passed, Veeam Backup & Replication will delete this data from the archive repository.

Int32

False

Named

False

LongTermArchivalOptions

Specifies the retention policy for file versions that are located on the long-term archive 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 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