Get-VBREncryptionKey

Short Description

Returns encryption keys.

Platform: VMware, Hyper-V

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

Syntax

This cmdlet provides the following parameter sets:

Description (Default)

Get-VBREncryptionKey [[-Description] <String>] [<CommonParameters>]
Backup

Get-VBREncryptionKey [-Backup] <VBRImportedEncryptedBackup> [<CommonParameters>]
Medium

Get-VBREncryptionKey [-Medium] <VBRTapeMedium> [<CommonParameters>]

Detailed Description

This cmdlet returns encryption keys managed by Veeam Backup & Replication.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Backup	Specifies the imported backup for which you want to get the encryption key. Accepts the `VBRImportedEncryptedBackup` object. To get this object, run the `Get-VBRImportedEncryptedBackup` cmdlet.	`VBRImportedEncryptedBackup`	True	1	True (ByPropertyName, ByValue)
Description	Specifies the description of the encryption key you want to get.	`String`	False	0	True (ByPropertyName, ByValue)
Medium	Specifies the tape for which you want to get the encryption key. Accepts the `VBRTapeMedium` object. To get this object, run the `Get-VBRTapeMedium` cmdlet.	`VBRTapeMedium`	True	2	True (ByPropertyName, ByValue)

<CommonParameters>

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

Output Object

Examples

Get-VBREncryptionKey Example 1. Getting All Encryption Keys

This command looks for all encryption keys.

Get-VBREncryptionKey

Get-VBREncryptionKey Example 2. Getting Specific Encryption Key

This command looks for an encryption key with description Veeam Administrator.

Get-VBREncryptionKey -Description "Veeam Administrator"