Set-VBOEncryptionKey

In this article

    Short Description

    Modifies encryption keys for object storage repositories.

    Syntax

    Set-VBOEncryptionKey -EncryptionKey <VBOEncryptionKey> [-Password <securestring>] [-Description <string>] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies an encryption key for object storage repositories that have been created before. To modify settings, you need to enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    EncryptionKey

    Specifies an encryption key that you want to modify.

    Accepts the VBOEncryptionKey object. To get this object, run the Get-VBOEncryptionKey cmdlet.

    True

    Named

    False

     

    NewPassword

    Specifies an old password that was applied for an encryption key.

    SecureString

    False

    Named

    False

     

    OldPassword

    Specifies a new password that you want to apply for the encryption key.

    SecureString

    False

    Named

    False

     

    Description

    Specifies a new description that you want to apply to the encryption key.

    String

    False

    Named

    False

     

    <CommonParameters>

    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

    Set-VBOEncryptionKeyExample 1. Modifying Encryption Key Password

    This example shows how to modify an encryption key password.

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

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

    $key = Get-VBOEncryptionKey -Description "Veeam Admin Key"

    Set-VBOEncryptionKey -EncryptionKey $key -Password $newpassword

    Perform the following steps:

    1. Create a new secure password:
    1. Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
    2. Enter the password.
    1. Run the Get-VBOEncryptionKey cmdlet. Specify the Description parameter. Save the result to the $key variable.
    2. Run the Set-VBOEncryptionKey cmdlet. Specify the EncryptionKey parameter value. Set the $newpassword variable as the Password parameter value.

    Set-VBOEncryptionKeyExample 2. Modifying Encryption Key Description

    This example shows how to modify an encryption key description.

    $key = Get-VBOEncryptionKey -Description "Veeam Admin Key"

    Set-VBOEncryptionKey -EncryptionKey $key -Description "Veeam Administrator"

    Perform the following steps:

    1. Run the Get-VBOEncryptionKey cmdlet. Specify the Description parameter. Save the result to the $key variable.
    2. Run the Set-VBOEncryptionKey cmdlet. Specify the EncryptionKey parameter value. Set the $newpassword variable as the Password parameter value.

    Set-VBOEncryptionKeyExample 3. Modifying Encryption Key Password and Description

    This example shows how to modify an encryption key password and description.

    $plainpassword = "VeeamPassword"

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

    Add-VBOEncryptionKey -Password $securepassword

    $key = Get-VBOEncryptionKey -Description "Veeam Admin Key"

    Set-VBOEncryptionKey -EncryptionKey $key -Password $newpassword

    Perform the following steps:

    1. Create a new secure password:
    1. Create the $plainpassword variable and assign a value to it.
    2. 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.
    3. Run the Add-VBOEncryptionKey cmdlet. Set the $securepassword variable as the Password parameter value.
    1. Run the Get-VBOEncryptionKey cmdlet. Specify the Description parameter. Save the result to the $key variable.
    2. Run the Set-VBOEncryptionKey cmdlet. Specify the EncryptionKey parameter value. Set the $newpassword variable as the Password parameter value.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.