Set-VBREncryptionKey

Short Description

Modifies encryption key.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Set-VBREncryptionKey -EncryptionKey <PSCryptoKey> [-Password <securestring>] [-Description <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet modifies encryption key that was created before. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

This cmdlet accepts SecureString type. Use Microsoft PowerShell standard capabilities to convert your password into the SecureString.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

EncryptionKey

Specifies the encryption key you want to modify.

Accepts PSCryptoKey or string (description) type.

0

0

True (ByValue,
ByProperty
Name)

False

Password

Specifies the new password you want to apply to the encryption key.

Accepts SecureString type.

False

Named

False

False

Description

Specifies the new description you want to apply to the encryption key.

False

Named

False

False

WhatIf

Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

False

Named

False

False

Confirm

Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

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.

Return Type

The cmdlet returns the PSCryptoKey object that contains information on an encryption key.

Example 1

This command modifies description of the 'Veeam Administrator' encryption key.

  • The encryption key is obtained by running  Get-VBREncryptionKey and piped down.
  • The new description is set to 'Veeam Tape Backup Administrator'.

Get-VBREncryptionKey -Description "Veeam Administrator" | Set-VBREncryptionKey -Description "Veeam Tape Backup Administrator"

Example 2

This command sets a new password to the 'Veeam Administrator' encryption key.

  • The password is turned into a SecureString by running ConvertTo-SecureString and assigned to the '$securepassword' variable.
  • The encryption key is obtained by running  Get-VBREncryptionKey and piped down.

$plainpassword = "VeeamPassword"

$securepassword = $plainpassword | ConvertTo-SecureString -AsPlainText -Force

Get-VBREncryptionKey -Description "Veeam Administrator" | Set-VBREncryptionKey -Password $securepassword

Related Commands

Get-VBREncryptionKey