Remove-VBREncryptedBackup
Short Description
Removes selected encrypted backups.
Note |
If the four-eyes authorization is enabled, you cannot run this cmdlet. For more information, see the Four-Eyes Authorization section in the User Guide for VMware vSphere. |
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Remove selected encrypted backups from the database.
Remove-VBREncryptedBackup -Backup <VBRImportedEncryptedBackup[]> [-WhatIf] [-Confirm] [<CommonParameters>] |
- Remove selected encrypted backups from the disk.
Remove-VBREncryptedBackup -Backup <VBRImportedEncryptedBackup[]> -FromDisk [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>] |
Detailed Description
This cmdlet removes selected encrypted backups. When you remove backups, you can use the following options:
- Remove from database. When you remove a backup from the database, you remove records about the backup from the Veeam configuration database. The backup files remain in the repository. Any type of backup can be removed with this option.
- Remove from disk. With this option, the backup is removed from the database and from the disk. This removal is complete and non-reversible. Cloud Connect backups cannot be removed with this option.
Parameters
Parameter | Description | Type | Required | Position | Accept |
|---|---|---|---|---|---|
Backup | Specifies the array of backups you want to remove. | Accepts the VBRImportedEncryptedBackup[] object. To get this object, run the Get-VBREncryptedBackup cmdlet. | True | 0 | True (ByValue, |
FromDisk | Defines that the cmdlet will delete backups from disk. If you do not provide this parameter, the cmdlet will delete only the information about the backups. Note: You must provide this parameter to remove backups from archive extents and capacity extents. | SwitchParameter | False | Named | False |
RunAsync | Defines that the command returns immediately without waiting for the task to complete. | SwitchParameter | False | Named | False |
WhatIf | Defines whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action. | SwichParameter | False | Named | False |
Confirm | Defines whether the cmdlet displays a prompt that asks if the user is sure that they want to continue. Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false. | SwitchParameter | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
None.
Examples
Example 1. Removing Specific Encrypted Backups from Database [Using Pipeline]
Example 2. Removing Encrypted Backups from Disk with Specified Names [Using Pipeline]
Example 3. Removing Encrypted Backup from Disk [Using Variable]
Related Commands
