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>] [-KMSServer <VBRKMSServer>] [<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 | Type | Required | Position | Accept Pipeline Input |
---|---|---|---|---|---|
CompressionLevel | Specifies the compression level of backups:
Default: Optimal. | VBRCompressionLevel | True | Named | False |
StorageOptimizationType | Specifies the type of the storage that you plan to use as a backup target.
Depending on the selected storage type, the job will use data blocks of different size to optimize the size of backup files. Default: LocalTarget. | VBRStorageOptimizationType | True | Named | False |
EnableEncryption | Enables the option for the Veeam Agent backup job to encrypt the backup data. | SwitchParameter | False | Named | False |
EncryptionKey | For the EnableEncryption parameter. Specifies the encryption key that you want to use to encrypt the data. | Accepts the VBREncryptionKey object. To create this object, run the Add-VBREncryptionKey cmdlet. | False | Named | False |
KMSServer | Specifies KMS servers added to the Veeam Backup & Replication console. The cmdlet will decrypt data encrypted by this server. | Accepts the VBRKMSServer object. To get this object, run the Get-VBRKMSServer cmdlet. | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
This cmdlet returns the VBRStorageOptions object that contains storage optimization settings for backup jobs.
Examples
Specifying Data Compression and Storage Optimization Settings
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.
$key = Add-VBREncryptionKey -Password $securepassword -Description Mypass New-VBRStorageOptions -CompressionLevel Optimal -StorageOptimizationType LocalTargetHugeBackup -EnableEncryption -EncryptionKey $key |
Perform the following steps:
- Run the Add-VBREncryptionKey cmdlet. Specify the Password and Description parameter values. Save the result to the $key variable.
- Run the New-VBRStorageOptions cmdlet. Specify the following settings:
- Set the Optimal option for the CompressionLevel parameter.
- Set the LocalTargetHugeBackup option for the StorageOptimizationType parameter.
- Provide the EnableEncryption parameter.
- Set the $key variable as the EncryptionKey parameter value.
Related Commands