Help Center
Choose product document...
Veeam Backup & Replication 9.5 [Archived]
PowerShell Reference

Set-VBRJobAdvancedStorageOptions

Short Description

Customizes advanced job storage settings.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRJobAdvancedStorageOptions -Job <CBackupJob[]> [-EnableDeduplication [<Boolean>]] [-CompressionLevel <Int32>] [-StorageBlockSize <EKbBlockSize>] [-WarningAction <ActionPreference>] [-WarningVariable <String>][<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.

For more information about job storage settings, see the Storage Settings section of the Veeam Backup & Replication user guide.

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

Job

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

True

Named

True (ByValue,
ByProperty
Name)

False

Enable
Deduplication

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

Compression
Level

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

Storage
BlockSize

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

Enable
Encryption

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

False

Named

False

False

Encryption
Key

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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

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 toto 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.

PS C:\PS> 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.

PS C:\PS> Get-VBRJob | Set-VBRJobAdvancedStorageOptions -CompressionLevel 5

Related Commands

Get-VBRJob

Get-VBREncryptionKey

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Backup Explorers User Guide

Backup and Restore of SQL Server Databases

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide