Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

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 Endpoint 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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

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.

PS C:\PS> 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.

PS C:\PS> Remove-VBREncryptionKey -EncryptionKey $administratorkey

Related Commands

Get-VBREncryptionKey

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation