New-VBRUnstructuredBackupSecondaryTarget

Short Description

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

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

Syntax

This cmdlet provides the following parameter sets:

AllParameterSets (Default)

New-VBRUnstructuredBackupSecondaryTarget -BackupRepository <CBackupRepository>

[-CustomRetentionType <VBRUnstructuredBackupShortTermRetentionType>] [-CustomRetentionPeriod <Int32>]

[-BackupWindow <VBRBackupWindowOptions>] [-GfsPolicyOptions <VBRComputerGFSOptions>] [<CommonParameters>]

EncryptionKey

New-VBRUnstructuredBackupSecondaryTarget -BackupRepository <CBackupRepository>

[-CustomRetentionType <VBRUnstructuredBackupShortTermRetentionType>] [-CustomRetentionPeriod <Int32>]

[-CustomEncryptionKey <VBREncryptionKey>] [-BackupWindow <VBRBackupWindowOptions>]

[-GfsPolicyOptions <VBRComputerGFSOptions>] [<CommonParameters>]

KmsServer

New-VBRUnstructuredBackupSecondaryTarget -BackupRepository <CBackupRepository>

[-CustomRetentionType <VBRUnstructuredBackupShortTermRetentionType>] [-CustomRetentionPeriod <Int32>]

[-CustomKMSServer <VBRKMSServer>] [-BackupWindow <VBRBackupWindowOptions>]

[-GfsPolicyOptions <VBRComputerGFSOptions>] [<CommonParameters>]

Detailed Description

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

Parameters

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.	`CBackupRepository`	True	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.	`VBRBackupWindowOptions`	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.	`VBREncryptionKey`	False	Named	False
CustomKMSServer	Specifies a KMS server. Veeam Backup & Replication will use keys generated by this KMS server to encrypt data that is stored on the secondary repository. Note: If you do not specify this parameter, Veeam Backup & Replication will use the KMS server that is set to the file backup job or an object storage job. Accepts the `VBRKMSServer` object. To get this object, run the `Get-VBRKMSServer` cmdlet.	`VBRKMSServer`	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
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
GfsPolicyOptions	Specifies a GFS retention policy for the secondary repository. Accepts the `VBRComputerGFSOptions` object. To create this object, run the `New-VBRComputerGFSOptions` cmdlet.	`VBRComputerGFSOptions`	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-VBRUnstructuredBackupSecondaryTarget Example 1. Creating Backup Repository

This example shows how to create a secondary backup repository with the following settings:

Veeam Backup & Replication will apply a retention policy that is set to the file backup job or object storage backup job.
Veeam Backup & Replication will apply an encryption key that is set to the file backup job or object storage backup job.
Veeam Backup & Replication will copy data to the repository continuously.

$repository = Get-VBRBackupRepository -Name "Backup Repository 07"

New-VBRUnstructuredBackupSecondaryTarget -BackupRepository $repository

Perform the following steps:

Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Run the New-VBRUnstructuredBackupSecondaryTarget cmdlet. Set the $repository variable as the BackupRepository parameter value.

New-VBRUnstructuredBackupSecondaryTarget Example 2. Creating Backup Repository with Custom Retention Policy

This example shows how to create a secondary backup repository with the custom retention policy. Veeam Backup & Replication will keep versions of backup files on the secondary backup repository for 7 days.

$repository = Get-VBRBackupRepository -Name "Backup Repository 07"

New-VBRUnstructuredBackupSecondaryTarget -BackupRepository $repository -CustomRetentionType Daily -CustomRetentionPeriod 7

Perform the following steps:

Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Run the New-VBRUnstructuredBackupSecondaryTarget cmdlet. Specify the following settings:
- Set the $repository variable as the BackupRepository parameter value.
- Set the Daily option for the CustomRetentionType parameter.
- Specify the value for the CustomRetentionPeriod parameter.

New-VBRUnstructuredBackupSecondaryTarget Example 3. Creating Backup Repository with Backup Window

This example shows how to create a secondary backup repository. Veeam Backup & Replication will copy data to the secondary repository according to the following schedule:

From 22:00 to 22:59 on Friday
From 22:00 to 22:59 on Saturday

$repository = Get-VBRBackupRepository -Name "Backup Repository 07"

$windowoptions = New-VBRBackupWindowOptions -FromDay Friday -FromHour 22 -ToDay Saturday -ToHour 22 -Enabled

New-VBRUnstructuredBackupSecondaryTarget -BackupRepository $repository -BackupWindow $windowoptions

Perform the following steps:

Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Run the New-VBRBackupWindowOptions cmdlet. Specify the FromDay, FromHour, ToDay and ToHour parameter values. Save the result to the $windowoptions variable.
Run the New-VBRUnstructuredBackupSecondaryTarget cmdlet. Set the $repository variable as the BackupRepository parameter value. Set the $windowoptions variable as the BackupWindow parameter value.