Veeam Backup & Replication 12
Veeam PowerShell Reference
Archive
Version 11 Version 10
Related documents
Search

New-VBREncryptionOptions

Short Description

Defines encryption settings.

Applies to

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Define encryption options with the disabled encryption.

New-VBREncryptionOptions [-EnableEncryption]  [<CommonParameters>]

  • Define encryption options with the encryption using an encryption key.

New-VBREncryptionOptions [-EnableEncryption] -EncryptionKey <VBREncryptionKey>  [<CommonParameters>]

  • Define encryption options with the encryption using a KMS server.

New-VBREncryptionOptions [-EnableEncryption] -KMSServer <VBRKMSServer> -KMSSourceName <String>  [<CommonParameters>]

Detailed Description

This cmdlet creates the VBREncryptionOptions object that defines encryption options.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

EncryptionKey

Specifies an encryption key. Veeam Backup & Replication will use this key to encrypt backup files.

Accepts the VBREncryptionKey object. To get this object, run the Get-VBREncryptionKey cmdlet.

False

Named

True (ByPropertyName)

KMSServer

Specifies the KMS server you want to use to encrypt the data.

Accepts the VBRKMSServer object. To get this object, run the Get-VBRKMSServer cmdlet.

False

Named

False

KMSSourceName

Specifies the displayed name for the key. The cmdlet will create a key and include this name into the key name on the KMS server.

String

False

Named

False

EnableEncryption

Enables encryption.

Default: False.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBREncryptionOptions object that defines encryption options.

Examples

New-VBREncryptionOptionsExample 1. Creating Encryption Options with Encryption Key

This example shows how to define encryption options with the encryption using an encryption key.

$encKey = Get-VBREncryptionKey -Description "For Entra ID encryption"

$encOptions = New-VBREncryptionOptions -EnableEncryption -EncryptionKey $encKey

Perform the following steps:

  1. Run the Get-VBREncryptionKey cmdlet. Specify the Description parameter value. Save the result to the $encKey variable.
  2. Run the New-VBREncryptionOptions cmdlet. Provide the EnableEncryption parameter. Set the $encKey variable as the EncryptionKey parameter value. Save the result to the $encOptions variable.

New-VBREncryptionOptionsExample 2. Creating Encryption Options with KMS

This example shows how to define encryption options with the encryption using a KMS server.

$kmsServer = Get-VBRKMSServer -Name "thales.tech.local"

$encOptions = New-VBREncryptionOptions -EnableEncryption -KMSSourceName "EntraIDKey" -KMSServer $kmsServer

Perform the following steps:

  1. Run the Get-VBRKMSServer cmdlet. Specify the Name parameter value. Save the result to the $kmsServer variable.
  2. Run the New-VBREncryptionOptions cmdlet. Specify the following settings:
  • Provide the EnableEncryption parameter.
  • Specify the KMSSourceName parameter.
  • Set the $kmsServer variable as the KMSServer parameter value.
  • Save the result to the $encOptions variable.

Related Commands

Page updated 1/28/2025

Page content applies to build 12.3.1.1139

View all results across Veeam
Back to document search