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>] |
Related Commands
Return Type
None
Detailed Description
This cmdlet removes a selected encryption key.
|
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 | Accept |
EncryptionKey | Specifies the encryption key you want to remove. Accepts PSCryptoKey object or description (string). | 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.
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 |