Backup Exec Management Command Line Interface Help
Get-BEEncryptionKey Cmdlet
Synopsis

Gets encryption keys in Backup Exec.

Syntax
Get-BEEncryptionKey [[-Name] [<String[]>]] [<CommonParameters>]

Get-BEEncryptionKey [-Id] [<Guid[]>] [<CommonParameters>]

Get-BEEncryptionKey -InputObject [<BEEncryptionKey[]>] [<CommonParameters>]
Description

Gets encryption keys in Backup Exec.

Without parameters, Get-BEEncryptionKey gets all of the Backup Exec encryption keys. You can also specify an encryption key by encryption key name or encryption key ID (Guid) or pass a Backup Exec encryption key object through the pipeline to Get-BEEncryptionKey.

Parameters

-Name <String[]>

Specifies one or more encryption keys by encryption key name (wildcards accepted). To specify multiple names, use commas to separate the names.


Required false
Position 0
Accepts pipeline input false
Accepts wildcard characters true


-Id <Guid[]>

Specifies one or more encryption keys by encryption key ID (Guid). To specify multiple IDs, use commas to separate the IDs.


Required true
Position 0
Accepts pipeline input true (ByValue)
Accepts wildcard characters false


-InputObject <BEEncryptionKey[]>

Specifies one or more encryption key objects. Enter a variable that contains the objects, or type a command or expression that gets the objects.


Required true
Position Named
Accepts pipeline input true (ByValue)
Accepts wildcard characters false


<CommonParameters>

For more information about common parameters, type "Get-Help about_commonparameters".

Input Types
System.Guid

You can pipe a System.Guid that contains the ID of a Backup Exec encryption key object to Get-BEEncryptionKey.



BackupExec.Management.CLI.BEEncryptionKey

You can pipe a Backup Exec encryption key object to Get-BEEncryptionKey.

Return Value
BackupExec.Management.CLI.BEEncryptionKey

Get-BEEncryptionKey returns objects that represent Backup Exec encryption keys.

Examples

Example 1

C:\PS> Get-BEEncryptionKey

This command gets all of the encryption keys.


Example 2
C:\PS> Get-BEEncryptionKey -Name "Encryption Key 01"

This command gets the encryption key named "Encryption Key 01".


Example 3
C:\PS> Get-BEEncryptionKey -Name "Encryption Key*"

This command gets all of the encryption keys that match the wildcard "Encryption Key*".