Set-VBRJobAdvancedStorageOptions

In this article

    Short Description

    Customizes advanced job storage settings.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Set-VBRJobAdvancedStorageOptions -Job <CBackupJob[]> [-EnableDeduplication [<Boolean>]] [-CompressionLevel <Int32>] [-StorageBlockSize <EKbBlockSize>] [-EnableEncryption [<Boolean>]] [-EncryptionKey <PSCryptoKey>][<CommonParameters>]

    Detailed Description

    This cmdlet sets storage options for the selected job.

    You can enable backup data deduplication and customize data units compression level and size.

    Read more about job storage settings in Veeam Backup & Replication user guide at http://www.veeam.com/vmware-backup/help-center.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Job

    Specifies the array of jobs. The cmdlet will modify advanced storage options of these jobs.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    EnableDeduplication

    Indicates that the job will deduplicate. If set to TRUE, the data will be deduplicated during the backup job run (recommended). Otherwise, no data will be checked for duplication.

    False

    Named

    False

    False

    CompressionLevel

    Specifies the compression level for the created backup:

    AUTO _COMPRESSION _LEVEL = -1,

    NONE _COMPRESSION _LEVEL = 0,

    DEDUPE _COMPRESSION _LEVEL = 4,

    OPTIMAL _COMPRESSION _LEVEL = 5,

    HIGH _COMPRESSION _LEVEL = 6,

    EXTREME _COMPRESSION _LEVEL = 9

    Default: OPTIMAL.

    False

    Named

    False

    False

    StorageBlockSize

    Specifies the integer defining the data blocks size. Larger sized blocks provide faster procession but lower deduplication level.

    0 = KbBlockSize256,

    1 = KbBlockSize512,

    3 = KbBlockSize1024,

    4 = KbBlockSize2048,

    5 = KbBlockSize4096,

    6 = KbBlockSize8192,

    7= Automatic.

    False

    Named

    False

    False

    EnableEncryption

    Indicates if the job must use encryption. Use the EncryptionKey parameter to specify the encryption key.

    False

    Named

    False

    False

    EncryptionKey

    Used to specify the encryption key for the EnableEncryption parameter.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Example 1

    This command edits advanced storage settings for the backup jobs named "Backup Job 01" and "Backup Job 02".

    • The EnableDeduplication parameter is set to enable data deduplication,
    • The compression level is set to none (0),
    • The storage blocks size is set to Automatic.

    The jobs are obtained with Get-VBRJob and piped down.

    Get-VBRJob -Name "Backup Job 01", "Backup Job 02" | Set-VBRJobAdvancedStorageOptions -EnableDeduplication $True -CompressionLevel 0 -StorageBlockSize 7

    Example 2

    This command applies the optimal compression level (=5) to all jobs. The jobs are obtained with Get-VBRJob and piped down.

    Get-VBRJob | Set-VBRJobAdvancedStorageOptions -CompressionLevel 5

    Related Commands

    Get-VBRJob

    Get-VBREncryptionKey