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

New-VBRStorageOptions

Short Description

Defines storage optimization settings for backup jobs.

Applies to

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

Syntax

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

Detailed Description

This cmdlet creates the VBRStorageOptions object that contains the storage optimization settings for backup jobs. These settings allow you to modify the following options for the storage:

Data compression options
Data optimization options
Encryption options

For more information about job storage settings, see the Data Compression and Deduplication section of User Guide for VMware vSphere.

For more information about job encryption settings, see the Storage Settings section in the Veeam Agent Management Guide.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input
CompressionLevel	Specifies the compression level of backups: 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. Default: Optimal.	True	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. Default: LocalTarget.	True	Named	False
EnableEncryption	Indicates that the Veeam Agent backup job will encrypt the backup data.	False	Named	False
EncryptionKey	For the EnableEncryption parameter. 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 on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

Example

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

The backup job will encrypt the data and will apply the optimal compression level.
The storage optimization type is set to keep backups larger than 16 TB on the local storage.

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

Run Add-VBREncryptionKey to specify the encryption settings. Save the result to the $key variable.
Run New-VBRStorageOptions with the $key variable. Use the Optimal value for the CompressionLevel parameter to set the optimal compression level and the LocalTargetHugeBackup value for the StorageOptimizationType parameter to specify the storage type.

$key = Add-VBREncryptionKey -Password $securepassword -Description Mypass

New-VBRStorageOptions -CompressionLevel Optimal -StorageOptimizationType LocalTargetHugeBackup -EnableEncryption -EncryptionKey $key

Related Commands

Add-VBREncryptionKey