Set-VBRJobAdvancedStorageOptions

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 = -1
  • None = 0
  • Dedupe-friendly = 4
  • Optimal = 5
  • High = 6
  • Extreme = 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.

  • KbBlockSize256 (former WAN Target) = 0.
  • KbBlockSize512 (former LAN target) = 1.
  • KbBlockSize1024 (former Local Target) = 3.
  • KbBlockSize2048 = 4.
  • KbBlockSize4096 (former Local Target (large blocks))= 5.
  • KbBlockSize8192 = 6.
  • Automatic (Defines the best block size depending on the target type)  = 7.

Default: KbBlockSize1024.

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