Remove-BEEncryptionKey Help

Synopsis

Removes encryption keys from Backup Exec.

Syntax

Remove-BEEncryptionKey -InputObject [<BEEncryptionKey[]>] [-PassThru [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Description

Removes encryption keys from Backup Exec.

You must replace encryption keys that are in use by backup jobs before they can be removed. See Switch-BEEncryptionKey.

Parameters

-PassThru <SwitchParameter>

Passes the removed object to the pipeline. By default, this cmdlet does not generate any output.

Required	false
Position	Named
Accepts pipeline input	false
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

-WhatIf <SwitchParameter>

Describes what happens if you execute the command without actually executing the command.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

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

Input Type

BackupExec.Management.CLI.BEEncryptionKey

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

Return Value

None or BackupExec.Management.CLI.BEEncryptionKey

When you use the PassThru parameter, Remove-BEEncryptionKey returns an object that represents the encryption key that was removed. Otherwise, this cmdlet does not generate any output.

Example

C:\PS> Get-BEEncryptionKey "EncryptionKey 0001" | Switch-BEEncryptionKey -ReplacementEncryptionKey "EncryptionKey 0002" | Remove-BEEncryptionKey

These commands replace any jobs that use an encryption key named "EncryptionKey 0001" with another encryption key named "EncryptionKey 0002" before removing "EncryptionKey 0001".