Set-VBOEncryptionKey

Short Description

Modifies encryption keys for object storage.

Syntax

Set-VBOEncryptionKey -EncryptionKey <VBOEncryptionKey> [-OldPassword <SecureString>] [-NewPassword <SecureString>] [-Description <String>] [<CommonParameters>]

Detailed Description

This cmdlet modifies an encryption key for object storage 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	False
NewPassword	Specifies a new password that you want to apply to the encryption key.	SecureString	False	Named	False	False
OldPassword	Specifies an old password that you want to modify.	SecureString	False	Named	False	False
Description	Specifies a new description that you want to apply to the encryption key.	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

Set-VBOEncryptionKey Example 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 -NewPassword $newpassword

Perform the following steps:

Create a new secure password:

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 $newpassword variable.
Enter the password.

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

Set-VBOEncryptionKey Example 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:

Run the Get-VBOEncryptionKey cmdlet. Specify the Description parameter value. Save the result to the $key variable.
Run the Set-VBOEncryptionKey cmdlet. Set the $key variable as the EncryptionKey parameter value. Specify a new value for the Description parameter.

Related Commands