Switch-BEEncryptionKey Help

Synopsis

Replaces one encryption key with another for all backup jobs in Backup Exec.

Syntax

Switch-BEEncryptionKey -InputObject [<BEEncryptionKey[]>] -ReplacementEncryptionKey [<BEEncryptionKey>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Switch-BEEncryptionKey -InputObject [<BEEncryptionKey[]>] -ReplaceWithNone [<SwitchParameter>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Description

Replaces one encryption key with another for all backup jobs in Backup Exec.

If an encryption key is in use by one or more jobs, you must use Switch-BEEncryptionKey before deleting the encryption key with the Remove-BEEncryptionKey command.

Parameters

-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

-ReplacementEncryptionKey <BEEncryptionKey>

Specifies the encryption key to be used as the replacement.

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

-ReplaceWithNone <SwitchParameter>

Specifies that no encryption key is to be used as a replacement.

Required	true
Position	Named
Accepts pipeline input	false
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 Switch-BEEncryptionKey.

Return Value

BackupExec.Management.CLI.BEEncryptionKey

Switch-BEEncryptionKey returns a Backup Exec encryption key object.

Examples

Example 1

C:\PS> Get-BEEncryptionKey "Encryption Key 0001" | Replace-BEEncryptionKey -ReplacementEncryptionKey "Encryption Key 0002"

These commands replace the encryption key named "Encryption Key 0001" with the encryption key named "Encryption Key 0002" for all jobs that are using it.

Example 2

C:\PS> Get-BEEncryptionKey "Encryption Key 0001" | Replace-BEEncryptionKey -ReplaceWithNone

These commands remove the encryption key named "Encryption Key 0001" from all jobs that use it.