New-VBRUnstructuredBackupSecondaryTarget

Short Description

Creates secondary backup repositories for file backup jobs and object storage backup jobs.

Applies to

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

Syntax

New-VBRUnstructuredBackupSecondaryTarget -BackupRepository <CBackupRepository> [-CustomRetentionType <VBRUnstructuredBackupShortTermRetentionType> {Daily | Monthly}] [-CustomRetentionPeriod <int>] [-CustomEncryptionKey <VBREncryptionKey>] [-BackupWindow <VBRBackupWindowOptions>]  [<CommonParameters>]

Detailed Description

This cmdlet creates secondary backup repositories. These repositories will keep copies of backup files that were created by file backup jobs and object storage backup jobs.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

BackupRepository

Specifies the backup repository that you want to add as a secondary backup repository to a file backup job or an object storage job.

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

True

Named

False

CustomRetentionType

Specifies a retention policy for the secondary repository. You can set 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.

Note: If you do not specify this parameter, Veeam Backup & Replication will apply the retention policy of the file backup job or an object storage job to the secondary repository.

VBRUnstructuredBackupShortTermRetentionType

False

Named

False

CustomRetentionPeriod

For the ShortTermRetentionType option.

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

Int32

False

Named

False

CustomEncryptionKey

Specifies an encryption key. Veeam Backup & Replication will use this key to encrypt data that is stored on the secondary repository.

Note: If you do not specify this parameter, Veeam Backup & Replication will apply an encryption key that is set to the file backup job or an object storage job.

Accepts the VBREncryptionKey object. To get this object, run the Get-VBREncryptionKey cmdlet.

False

Named

False

BackupWindow

Specifies backup window settings. Veeam Backup & Replication will create copies of backups that were created by file backup jobs or an object storage job according to these settings.

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

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBRUnstructuredBackupSecondaryTarget object that contains settings of secondary backup repositories.

Examples

New-VBRUnstructuredBackupSecondaryTargetExample 1. Creating Backup Repository

New-VBRUnstructuredBackupSecondaryTargetExample 2. Creating Backup Repository with Custom Retention Policy

New-VBRUnstructuredBackupSecondaryTargetExample 3. Creating Backup Repository with Backup Window

Related Commands

Page updated 8/14/2024

Page content applies to build 12.3.1.1139