New-VBRDecryptionSet

Short Description

Defines data decryption settings.

Applies to

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Decrypt data encrypted by KMS server.

New-VBRDecryptionSet -EncryptionKey <PSCryptoKey> -KMSServer <VBRKMSServer> [-KmsKeyId <String>]  [<CommonParameters>]

  • Decrypt data using password.

New-VBRDecryptionSet -EncryptionKey <PSCryptoKey> -Password <String>  [<CommonParameters>]

Detailed Description

This cmdlet creates the VBRDecryptionSet object. This object defines the data decryption settings.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

EncryptionKey

Specifies encryption keys managed by Veeam Backup & Replication.

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

True

Named

True (ByPropertyName, ByValue)

KMSServer

Specifies KMS servers added to the Veeam Backup & Replication console. The cmdlet will decrypt data encrypted by this server.

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

True

Named

True (ByPropertyName, ByValue)

KmsKeyId

Specifies the ID of the private key stored on the KMS server. The cmdlet will use it to decrypt data.

String

False

Named

True (ByPropertyName, ByValue)

Password

Specifies a password. The cmdlet will use the password to decrypt data.

String

True

Named

True (ByPropertyName, ByValue)

<CommonParameters>

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

Output Object

VBRDecryptionSet

Examples

New-VBRDecryptionSetExample 1. Defining Decryption Settings for Data Encrypted by KMS

New-VBRDecryptionSetExample 2. Defining Data Decryption Settings with Password

Related Commands

Page updated 8/14/2024

Page content applies to build 12.3.1.1139