Forget-VBRCloudUnavailableBackupFile

Short Description

Removes tenant backup files marked as unavailable from the configuration database.

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

Syntax

Forget-VBRCloudUnavailableBackupFile -BackupFiles <VBRCloudUnavailableBackupFile[]> [-IncludeDependentFiles] [<CommonParameters>]

Detailed Description

This cmdlet removes tenant backup files marked as unavailable from the configuration database.

Important

This cmdlet is intended for the service provider side only.

Note

Restore points on a repository or extent that is inaccessible or in Maintenance mode are considered unavailable. Before you remove these backup files, check the list of the files that the Get-VBRCloudUnavailableBackupFile cmdlet returns to ensure the correct files will be removed.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
BackupFiles	Specifies backup files that you want to remove from the configuration database. Accepts the `VBRCloudUnavailableBackupFile[]` object. To create this object, run the `Get-VBRCloudUnavailableBackupFile` cmdlet.	`VBRCloudUnavailableBackupFile[]`	True	Named	True (ByPropertyName, ByValue)
IncludeDependentFiles	Defines that the cmdlet will remove dependent backup files. If the specified backup file has dependent backup files and you do not provide this parameter, the cmdlet will not remove the backup file. Note: This applies to both full and incremental backup files. If a backup file that you want to remove has no dependent backup files, the cmdlet will remove it even if you do not provide the `IncludeDependentFiles` parameter.	`SwitchParameter`	False	Named	True (ByPropertyName, ByValue)

<CommonParameters>

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

Examples

Removing Unavailable Backup Files for Cloud Tenant Account

This example shows how to remove backup files that are marked as unavailable for the ABC Company cloud tenant account. The cmdlet will also remove dependent backup files.

$tenant = Get-VBRCloudTenant -Name "ABC Company"

$backupfiles = Get-VBRCloudUnavailableBackupFile -CloudTenant $tenant

Forget-VBRCloudUnavailableBackupFile -BackupFiles $backupfiles -IncludeDependentFiles

Perform the following steps:

Run the Get-VBRCloudTenant cmdlet. Specify the Name parameter value. Save the result to the $tenant variable.
Run the Get-VBRCloudUnavailableBackupFile cmdlet. Set the $tenant variable as the CloudTenant parameter value. Save the result to the $backupfiles variable.
Run the Forget-VBRCloudUnavailableBackupFile cmdlet. Set the $backupfiles variable as the BackupFiles parameter value. Provide the IncludeDependentFiles parameter.