This is an archive version of the document. To get the most up-to-date information, see the current version.

Set-VBRStorageOptions

Short Description

Modifies storage optimization settings for Veeam Agent backup jobs.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRStorageOptions -Options <VBRStorageOptions> [-CompressionLevel <VBRCompressionLevel> {None | DedupeFriendly | Optimal | High | Extreme}] [-StorageOptimizationType <VBRStorageOptimizationType> {LocalTarget | LocalTargetHugeBackup | LANTarget | WANTarget}] [-EnableEncryption] [-EncryptionKey <VBREncryptionKey>][<CommonParameters>]

Detailed Description

This cmdlet modifies storage optimization settings for Veeam Agent backup jobs. You can modify the following options for the storage:

Data compression settings
Data optimization settings
Encryption settings

Veeam Backup & Replication will apply the settings to new backups during the next Veeam Agent backup job run. The new settings will not modify previously created backups.

To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Options	Specifies storage options that you want to modify. Accpest VBRStorageOptions type.	True	Named	True (ByValue)
CompressionLevel	Specifies the compression level for the backup: None: use this option if you do not want to enable data compression. Dedupe-friendly: use this option to set a dedupe-friendly compression level. Optimal: use this option to set an optimal compression level. High: use this option to set a high compression level. Extreme: use this option to set an extreme compression level.	False	Named	False
StorageOptimizationType	Specifies the type of the storage that you plan to use as a backup target. LocalTarget: use this option for backup to SAN, DAS or local storage. LocalTargetHugeBackup: use this option for Veeam Agent jobs that can produce backup files larger than 16 TB. LANTarget: use this option for backup to NAS and for onsite backup. WANTarget: use this option if you plan to use WAN for offsite backup. Depending on the selected storage type, the job will use data blocks of different size to optimize the size of backup files.	False	Named	False
EnableEncryption	Indicates that the Veeam Agent backup job will encrypt will encrypt the backup data.	False	Named	False
EncryptionKey	For the EnableEncryption option. Specifies the encryption key that you want to use to encrypt the data. Accepts the VBREncryptionKey type.	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

Example

This example shows how to specify data compression and storage optimization settings for Veeam Agent backup job. The job will run with the following settings:

Veeam Backup & Replication will change the optimization type to use WAN for offsite backup.
Veeam Backup & Replication will change the compression level to dedupe-friendly.

To modify the data compression and storage optimization settings, perform the following steps:

Run Get-VBRJob to get the backup job that you want to modify. Save the result to the $job variable.
Cast the $job variable to the VBRComputerBackupJob type. Use the [Veeam.Backup.PowerShell.Infos.VBRComputerBackupJob]$ComputerBackupJob value.
Get the StorageOptions object. Save the result to the $storage variable.
Cast the $storage variable to the VBRStorageOptions type. Use the [Veeam.Backup.PowerShell.Infos.VBRStorageOptions]$StorageOptions value. Save the result to the $schedule variable.
Run Set-VBRStorageOptions with the $storage variable. Set the Dedupe-Friendly value for the CompressionLevel parameter to change the compression level and the WANTarget value for the StorageOptimizationType parameter to modify the storage type.

$job = Get-VBRJob -Name "BackupJob"

[Veeam.Backup.PowerShell.Infos.VBRComputerBackupJob]$ComputerBackupJob = $job

$storage = $computerbackupjob.StorageOptions

[Veeam.Backup.PowerShell.Infos.VBRStorageoptions]$StorageOptions = $storage

Set-VBRStorageOptions -Options $storage -CompressionLevel DedupeFriendly -StorageOptimizationType WANTarget

Related Commands