This is an archive version of the document. To get the most up-to-date information, see the current version.

Add-VBREncryptionKey

In this article

    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>]

    Related Commands

    None

    Return Type

    PSCryptoKey

    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.

    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"