Remove-VBRUnstructuredBackup

Short Description

Removes backup files created by the file backup jobs and object storage backup jobs.

Applies to

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Remove backup files created by file backup jobs and object storage backup jobs from the backup infrastructure.

Remove-VBRUnstructuredBackup -Backup <VBRUnstructuredBackup[]> [-Confirm] [-WhatIf]  [<CommonParameters>]

  • Remove backup files of specific file shares or object storage from the disk.

Remove-VBRUnstructuredBackup -Backup <VBRUnstructuredBackup[]> -Server <VBRUnstructuredServer[]> [-RunAsync] [-Confirm] [-WhatIf]  [<CommonParameters>]

  • Remove backup files created by the file backup jobs and object storage backup jobs from the disk.

Remove-VBRUnstructuredBackup -Backup <VBRUnstructuredBackup[]> -FromDisk [-RunAsync] [-Confirm] [-WhatIf]  [<CommonParameters>]

  • Remove the whole backup or a particular restore point from the backup.

Remove-VBRUnstructuredBackup -RestorePoint <VBRUnstructuredBackupRestorePoint[]> [-RunAsync] [-Confirm] [-WhatIf]  [<CommonParameters>]

Detailed Description

This cmdlet removes backup files created by the file backup jobs and object storage backup jobs.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Backup

Specifies an array of backup files created by the file backup jobs and object storage backup jobs. The cmdlet will remove these backup files.

Accepts the VBRUnstructuredBackup[] object. To get this object, run the Get-VBRUnstructuredBackup cmdlet.

True

Named

True (ByValue, ByPropertyName)

Server

Specifies an array of file shares and object storage. The cmdlet will remove backup files of the specified file shares from the disk.

Accepts the VBRUnstructuredServer[] object. To get this object, run the Get-VBRUnstructuredServer cmdlet.

True

Named

False

RestorePoint

Specifies an array of restore points. The cmdlet will remove backups that have restore points specified in the array.

Note: If the Backup parameter is also specified, the cmdlet will remove backup files for specified file shares.

Accepts the VBRUnstructuredBackupRestorePoint[] object. To get this object, run the Get-VBRUnstructuredBackupRestorePoint cmdlet.

True

Named

True (ByValue, ByPropertyName)

FromDisk

Defines that the cmdlet will remove backup files from disk.

SwitchParameter

True

Named

False

RunAsync

Defines that the command returns immediately without waiting for the task to complete.

SwitchParameter

False

Named

False

WhatIf

Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.

SwitchParameter

False

Named

False

Confirm

Defines that the cmdlet will display a prompt that asks if the user is sure that he wants 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

Remove-VBRUnstructuredBackupExample 1. Removing Backup Files from Veeam Backup & Replication Infrastructure

Remove-VBRUnstructuredBackupExample 2. Removing Backup Files of Specific Object Storage from Disk

Remove-VBRUnstructuredBackupExample 3. Removing Backup Files From Disk

Remove-VBRUnstructuredBackupExample 4. Removing Restore Points of File Backups for Specific File Share

Related Commands

Page updated 8/14/2024

Page content applies to build 12.3.1.1139