Get-VBREncryptionKey

Short Description

Returns encryption keys.

Applies to

Platform: VMware, Hyper-V

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

Syntax

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

Detailed Description

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

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Description

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

False

Named

True (ByValue,
ByProperty
Name)

True

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

The cmdlet returns the PSCryptoKey object that contains information on an encryption key.

Example 1

This command looks for all encryption keys.

Get-VBREncryptionKey

Example 2

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

Get-VBREncryptionKey -Description "Veeam Administrator"