Remove-WBBackupSet

Remove-WBBackupSet

Deletes backups from a target catalog, a system catalog, or both.

Syntax

Parameter Set: Default
Remove-WBBackupSet [[-BackupSet] <WBBackupSet[]> ] [[-KeepVersions] <Int32> ] [[-DeleteOldest]] [[-MachineName] <String> ] [[-Force]] [ <CommonParameters>]

Parameter Set: NetworkWithPSCred
Remove-WBBackupSet [[-BackupSet] <WBBackupSet[]> ] [[-KeepVersions] <Int32> ] [[-DeleteOldest]] [-NetworkPath] <String> [[-Credential] <PSCredential> ] [[-NonInheritAcl]] [[-MachineName] <String> ] [[-Force]] [ <CommonParameters>]

Parameter Set: VolumePath
Remove-WBBackupSet [[-BackupSet] <WBBackupSet[]> ] [[-KeepVersions] <Int32> ] [[-DeleteOldest]] [-VolumePath] <String> [[-MachineName] <String> ] [[-Force]] [ <CommonParameters>]

Parameter Set: WBBackupTarget
Remove-WBBackupSet [[-BackupSet] <WBBackupSet[]> ] [[-KeepVersions] <Int32> ] [[-DeleteOldest]] [-BackupTarget] <WBBackupTarget> [[-MachineName] <String> ] [[-Force]] [ <CommonParameters>]

Detailed Description

The Remove-WBBackupSet cmdlet deletes a set of backups from a target catalog, a system catalog, or both.

Parameters

-BackupSet<WBBackupSet[]>

Specifies an array of backup set objects that determine which backup or which backup sets to delete. You can specify one backup or an array of backup sets.

Aliases	none
Required?	false
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-BackupTarget<WBBackupTarget>

Specifies a backup target object that indicates the storage location with the backups that you want to delete.

Use this parameter to delete backups from computers other than the local computer. The cmdlet deletes the backup sets from the catalog on the computer that you specify in this parameter and from the system catalog of the local computer. These locations can be locally attached disk drives or remote shared folders.

Aliases	none
Required?	true
Position?	4
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Credential<PSCredential>

Specifies a PSCredential object that contains the username and password for a user account that has access permissions for the location that stores backups.

Aliases	none
Required?	false
Position?	5
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-DeleteOldest

Indicates that the cmdlet deletes the oldest backup in the set.

Aliases	none
Required?	false
Position?	3
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Force

Indicates that the cmdlet removes the backup set without prompting you for confirmation. By default, the cmdlet prompts you for confirmation before it proceeds.

Aliases	none
Required?	false
Position?	8
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-KeepVersions<Int32>

Specifies the number of the most recent backups to keep on the backup target. The cmdlet deletes backups over this number from the target.

If you specify this parameter along with the BackupTarget and MachineName parameters, the cmdlet examines the target location on the specified computer for backups to remove.

Aliases	none
Required?	false
Position?	2
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-MachineName<String>

Specifies the name of the computer for which you want to delete backups.

Use this parameter when you specify the BackupTarget parameter or when multiple computers store backups in the same location.

Aliases	none
Required?	false
Position?	7
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-NetworkPath<String>

Specifies the path to the remote shared folder from which the cmdlet deletes backups.

Aliases	none
Required?	true
Position?	4
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-NonInheritAcl

Do not use. This parameter is not implemented in this version of the module.

Aliases	none
Required?	false
Position?	6
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VolumePath<String>

Specifies the drive letter of the volume where the cmdlet stores backups.

Aliases	none
Required?	true
Position?	4
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• Windows.ServerBackup.Commands.WBBackupSet,System.Int32,System.Management.Automation.SwitchParameter, Windows.ServerBackup.Commands.WBBackupTarget, System.String, System.Management.Automation.PSCredential

Outputs

The output type is the type of the objects that the cmdlet emits.

• Windows.ServerBackup.Commands.WBBackupSet

Examples

Example 1: Remove oldest backup set

This command deletes the oldest backup of the computer that has its name in the $MachineName variable from the backup target. Because the command includes the Force parameter, it does not ask for confirmation of the deletion.

PS C:\> $Ret = Remove-WBBackupSet -DeleteOldest -BackupTarget $WB_BackupTarget -MachineName $MachineName -Force