Set-VBRStorageOptions

In this article

    Short Description

    Modifies storage optimization settings for Veeam Agent backup jobs.

    Applies to

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

    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

     

    <CommonParameters>

    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:

    1. Run Get-VBRComputerBackupJob to get the backup job that you want to modify. Save the result to the $job variable.
    2. Run New-VBRStorageOptions to specify data compression and storage optimization settings for a backup job. Save the result to the $options variable
    3. 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.
    4. Run the Set-VBRComputerBackupJob with the $job and $newoptions variables to modify the storage settings of the Veeam Agent backup job.

    $job = Get-VBRComputerBackupJob -Name "AgentBackupJob"

    $options = New-VBRStorageOptions -CompressionLevel Optimal -StorageOptimizationType LocalTargetHugeBackup

    $newoptions = Set-VBRStorageOptions -Options $options -CompressionLevel DedupeFriendly -StorageOptimizationType WANTarget

    Set-VBRComputerBackupJob -Job $job -StorageOptions $newoptions

    Related Commands