This is an archive version of the document. To get the most up-to-date information, see the current version.

Remove-VBREncryptionKey

Short Description

Removes encryption key.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Remove-VBREncryptionKey [-EncryptionKey] <PSCryptoKey> [-WhatIf] [-Confirm]  [<CommonParameters>]

Detailed Description

This cmdlet removes a selected encryption key.

Remove-VBREncryptionKey Important!

You cannot remove an encryption key if it is used by any job or set in permissions for repository for Veeam Agent for Microsoft Windows jobs.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

EncryptionKey

Specifies the encryption key you  want to remove.

Accepts PSCryptoKey or string (description) type.

True

0

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

None

Example 1

This command removes the 'Veeam Administrator' encryption key.

The encryption key is obtained by running  Get-VBREncryptionKey and piped down.

Get-VBREncryptionKey -Description "Veeam Administrator" | Remove-VBREncryptionKey

Example 2

This command removes the 'Veeam Administrator' encryption key.

The encryption key is obtained by running Get-VBREncryptionKey and assigned to the '$administratorkey' variable.

Remove-VBREncryptionKey -EncryptionKey $administratorkey

Related Commands

Get-VBREncryptionKey