Add-VBOEncryptionKey

Short Description

Creates encryption keys for object storage.

Syntax

Add-VBOEncryptionKey -Password <SecureString> [-Description <String>] [<CommonParameters>]

Detailed Description

This cmdlet creates an encryption key for object storage. You can use this key to encrypt data that is stored in object storage.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Password	Specifies a password that you want to use to encrypt data.	SecureString	True	Named	False	False
Description	Specifies a description of an encryption key. The cmdlet will create an encryption key with this description.	String	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

The cmdlet returns the VBOEncryptionKey object that contains settings of an encryption key.

Examples

Add-VBOEncryptionKey Example 1. Creating Encryption Key

This example shows how to create an encryption key.

$plainpassword = "VeeamPassword"

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

Add-VBOEncryptionKey -Password $securepassword

Perform the following steps:

Create the $plainpassword variable and assign a value to it.
Create the $securepassword variable and assign it to the $plainpassword variable value.
Pipe down the $plainpassword object to the ConvertTo-SecureString cmdlet. Specify the AsPlainText and the Force variables.
Run the Add-VBOEncryptionKey cmdlet. Set the $securepassword variable as the Password parameter value.

Add-VBOEncryptionKey Example 2. Creating Encryption Key with Description

This example shows how to create an encryption key with a description.

$securepassword = Read-Host "Enter your password" -AsSecureString

Enter your password: **********

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

Perform the following steps:

Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Provide the AsSecureString parameter. Save the result to the $securepassword variable.
Enter the password.
Run the Add-VBOEncryptionKey cmdlet. Set the $securepassword variable as the Password parameter value. Specify the Description parameter value.

Related Commands