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
Parameter | Description | Required | Position | Accept | Accept |
|---|---|---|---|---|---|
Password | Specifies password you want to use to encrypt data. Accepts SecureString type. | True | 0 | True (ByValue, | False |
Description | Specifies description of the new encryption key that you can further use to search encryption keys. | False | 1 | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Return Type
Example
This command creates a 'Veeam Administrator' encryption key.
The password is turned into a SecureString by running ConvertTo-SecureString and assigned to the '$securepassword' variable.
$plainpassword = "VeeamPassword" $securepassword = $plainpassword | ConvertTo-SecureString -AsPlainText -Force Add-VBREncryptionKey -Password $securepassword -Description "Veeam Administrator" |