Remove-VBREncryptionKey

Short Description

Removes encryption key.

Applies to

Platform: VMware, Hyper-V

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

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	Type	Required	Position	Accept Pipeline Input
EncryptionKey	Specifies the encryption key you want to remove.	Accepts the PSCryptoKey object or string (description). To get this object, run the Get-VBREncryptionKey cmdlet.	True	0	False
WhatIf	Defines whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.	SwitchParameter	False	Named	False
Confirm	Defines whether the cmdlet displays a prompt that asks if the user is sure that they want to continue. Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.	SwitchParameter	False	Named	False

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

EncryptionKey

Specifies the encryption key you want to remove.

Accepts the PSCryptoKey object or string (description). To get this object, run the Get-VBREncryptionKey cmdlet.

True

False

WhatIf

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

SwitchParameter

False

Named

False

Confirm

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

Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.

SwitchParameter

False

Named

False

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

Output Object

None.

Examples

Remove-VBREncryptionKey Example 1. Removing Encryption Key [Using Pipeline]

This example shows how to remove the Veeam Administrator encryption key.

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

Perform the following steps:

Run the Get-VBREncryptionKey cmdlet. Specify the Description parameter value.
Pipe the cmdlet output to the Remove-VBREncryptionKey cmdlet.

Remove-VBREncryptionKey Example 2. Removing Encryption Key [Using Variable]

This example shows how to remove the Veeam Administrator encryption key.

$administratorkey = Get-VBREncryptionKey -Description "Veeam Administrator"

Remove-VBREncryptionKey -EncryptionKey $administratorkey

Perform the following steps:

Run the Get-VBREncryptionKey cmdlet. Specify the Description parameter value. Save the result to the $administratorkey variable.
Run the Remove-VBREncryptionKey cmdlet. Set the $administratorkey variable as the EncryptionKey parameter value.

Related Commands

Get-VBREncryptionKey