Add-VBREncryptionKey

Short Description

Creates encryption key.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Add-VBREncryptionKey -Password <securestring> [-Description <string>] [<CommonParameters>]

Detailed Description

This cmdlet creates a new encryption key.

This cmdlet accepts SecureString type. Use Microsoft PowerShell standard capabilities to convert your password into the SecureString.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Password	Specifies password you want to use to encrypt data.	SecureString	True	0	True (ByValue, ByProperty Name)
Description	Specifies description of the new encryption key that you can further use to search encryption keys.	String	False	1	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

Examples

Creating Encryption Key

This command creates the Veeam Administrator encryption key.

$plainpassword = "VeeamPassword"

$securepassword = $plainpassword | ConvertTo-SecureString -AsPlainText -Force

Add-VBREncryptionKey -Password $securepassword -Description "Veeam Administrator"

Perform the following steps:

Save the password into the $plainpassword variable.
Turn the password into a SecureString by running the ConvertTo-SecureString command. Provide the AsPlainText and Force parameters.
Run the Add-VBREncryptionKey cmdlet. Set the $securepassword variable as the Password parameter value. Specify the Description parameter value.