Set-VBRComputerRecoveryToken

Short Description

Modifies tokens for bare-metal recovery.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Set-VBRComputerRecoveryToken -RecoveryToken <VBRComputerRecoveryToken[]> [-ExpirationDate <DateTime>]

[-FriendlyName <String>] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of tokens that you can use to perform bare-metal recovery.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
ExpirationDate	Specifies the expiration date of a token.	`DateTime`	False	Named	False
FriendlyName	Specifies a token friendly name.	`String`	False	Named	False
RecoveryToken	Specifies an array of token. The cmdlet will modify these tokens. Accepts the `VBRComputerRecoveryToken`[] object. To get this object, run the `Get-VBRComputerRecoveryToken` cmdlet.	`VBRComputerRecoveryToken[]`	True	Named	True (ByPropertyName, ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

None.

Note

Since the cmdlet does not return any object, to view the changes you must run the Get-VBRComputerRecoveryToken cmdlet.

Examples

Modifying Expiration Date of Tokens for Bare-Metal Recovery

This example shows how to modify an expiration date of tokens that you can use to perform bare-metal recovery. The cmdlet will set expiration date to 02.20.2023 at 12.00.00 AM.

$token = Get-VBRComputerRecoveryToken

$expirationDate = Get-Date -Year 2023 -Month 2 -Day 20 -Hour 0 -Minute 0 -Second 0

Set-VBRComputerRecoveryToken -RecoveryToken $token -ExpirationDate $expirationDate

Perform the following steps:

Run the Get-VBRComputerRecoveryToken cmdlet. Save the result to the $token variable.
Run the Get-Date cmdlet. Specify the Year, Month, Day, Hour, Minute and Second parameter values. Save the result to the $expirationDate variable.
Run the Set-VBRComputerRecoveryToken cmdlet. Set the $token variable as the RecoveryToken parameter value. Set the $expirationDate variable as the ExpirationDate parameter value.