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

Creates a new encryption key in Backup Exec.

Syntax
New-BEEncryptionKey [-Name] [<String>] [-Passphrase] [<SecureString>] [-EncryptionKeyType {Restricted | Common}] [-EncryptionType {Aes128Bit | Aes256Bit}] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Description

Creates a new encryption key in Backup Exec.

Parameters

-Passphrase <SecureString>

Designates a pass phrase for this key. For 128-bit AES encryption, the pass phrase must be at least eight characters. For 256-bit AES encryption, the pass phrase must be at least 16 characters.


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


-EncryptionType

Specifies the type of encryption algorithm that you want to use.

The valid values are:
Aes128Bit
Aes256Bit


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


-EncryptionKeyType

Specifies if the key is common or restricted. A restricted key allows only the key owner to restore the encrypted data.

The valid values are:
Restricted
Common


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


-Name <String>

Specifies the name of the new encryption key.


Required true
Position 0
Accepts pipeline input true (ByValue ByPropertyName)
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


<CommonParameters>

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

Input Type
System.String

You can pipe a string that contains the name of the Backup Exec encryption key object to create to New-BEEncryptionKey.

Return Value
BackupExec.Management.CLI.BEEncryptionKey

New-BEEncryptionKey returns the encryption key that was created.

Example
C:\PS> $passphrase = ConvertTo-SecureString "P@ssW0rD!" -AsPlainText -Force
C:\PS> New-BEEncryptionKey -Name "Encryption Key 0001" -Passphrase $passphrase -EncryptionType Aes128Bit

These commands create a secure string, which is then used as the passphrase to create an encryption key named "Encryption Key 0001".