Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Add-VBREncryptionKey

Short Description

Creates encryption key.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

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
Pipeline
Input

Accept
Wildcard
Characters

Password

Specifies password you want to use to encrypt data.

Accepts SecureString type.

True

0

True (by Value
FromPipeline,
ValueFromPipeline
ByPropertyName)

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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

PSCryptoKey

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.

PS C:\PS> $plainpassword = "VeeamPassword"

PS C:\PS> $securepassword = $plainpassword | ConvertTo-SecureString -AsPlainText -Force

PS C:\PS> Add-VBREncryptionKey -Password $securepassword -Description "Veeam Administrator"

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation