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

Get-VBREncryptionKey

On This Page

Short Description

Returns encryption keys.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Get-VBREncryptionKey [[-Description] <string>] [<CommonParameters>]

Related Commands

None

Return Type

Detailed Description

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

You can get the list of media pools within specified library, or search for instances directly by description.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Description

Specifies the description of the encryption key you want to get.

Accepts string type.

False

Named

True (by Value
FromPipeline,
ValueFromPipeline
ByPropertyName)

True

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 looks for all encryption keys.

PS C:\PS> Get-VBREncryptionKey

Example 2

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

PS C:\PS> Get-VBREncryptionKey -Description "Veeam Administrator"