This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBRNASBackupSecondaryTarget
Short Description
Modifies settings of secondary backup repositories.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRNASBackupSecondaryTarget -SecondaryTarget <VBRNASBackupSecondaryTarget> [-BackupRepository <CBackupRepository>] [-EnableCustomRetention] [-CustomRetentionType <VBRNASBackupShortTermRetentionType> {Daily |Monthly}] [-CustomRetentionPeriod <int>] [-UseCustomEncryptionKey] [-CustomEncryptionKey <VBREncryptionKey>][-EnableBackupWindow] [-BackupWindow <VBRBackupWindowOptions>] [<CommonParameters>] |
Detailed Description
This cmdlet modifies settings of secondary backup repositories. This cmdlet modifies an existing VMware replication job. To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input | Accept Wildcard Characters |
SecondaryTarget | Specifies the secondary backup repository. The cmdlet will modify this repository. | Accepts the VBRNASBackupSecondaryTarget object. To create this object, run the Get-VBRBackupRepository cmdlet. | True | Named | True (ByValue, ByPropertyName) |
|
BackupRepository | Specifies the backup repository that you want to add as a secondary backup repository to a file backup job. | Accepts the CBackupRepository object. To create this object, run the Get-VBRBackupRepository cmdlet. | False | Named | False |
|
EnableCustomRetention | Defines that the cmdlet will enable the custom retention policy. If you provide this parameter, Veeam Backup & Replication will apply this policy for backups located on the secondary backup repository. Otherwise, Veeam Backup & Replication will apply the retention policy of the file backup job to the secondary repository. | SwitchParameter | False | Named | False |
|
CustomRetentionType | Specifies a retention policy for the secondary repository. You can set retention policy to either of the following periods:
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 to the secondary repository. | VBRNASBackupShortTermRetentionType | 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 |
|
UseCustomEncryptionKey | Defines that the cmdlet will enable the custom encryption key option. If you provide this parameter, Veeam Backup & Replication will use the encryption key to encrypt data that is stored on the secondary repository. Otherwise, Veeam Backup & Replication will apply an encryption key that is set to the file backup job to the secondary repository. | SwitchParameter | 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 to the secondary repository. | Accepts the VBREncryptionKey object. To create this object, run the Get-VBREncryptionKey cmdlet. | False | Named | False |
|
EnableBackupWindow | Defines that the cmdlet will enable the backup window option. If you provide this parameter, Veeam Backup & Replication will create copies of backups that were created by file backup jobs according to these settings. Otherwise, Veeam Backup & Replication will copy data to the repository continuously. | SwitchParameter | False | Named | False |
|
BackupWindow | Specifies backup window settings. Veeam Backup & Replication will create copies of backups that were created by file backup jobs according to these settings | VBRBackupWindowOptions | 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 VBRNASBackupSecondaryTarget object that contains settings secondary backup repositories.
Examples
Example 1. Enabling Custom Retention Policy
Example 2. Enabling Custom Encryption Key
Related Commands
