Edit

Remove-WBCatalog

  • Reference
Module:
WindowsServerBackup

Removes the backup catalog from the local computer.

Syntax

Remove-WBCatalog
      [-Force]
      [<CommonParameters>]

Description

The Remove-WBCatalog cmdlet removes the backup catalog from the local computer. Use this cmdlet when the backup catalog is corrupted and you cannot restore it by using the Restore-WBCatalog cmdlet.

If you remove the backup catalog for a computer, you cannot access the backups of that computer by using Windows Server Backup. In this case, if you can access another backup location, use Restore-WBCatalog to restore the backup catalog from that location, and then create a new backup from that backup catalog.

Examples

Example 1: Remove a backup catalog

PS C:\> Remove-WBCatalog

Warning
Are you sure that you want to delete the backup catalog? If you delete the
catalog, you will need to create a new set of backups.
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): Y
The backup catalog has been successfully deleted.

This command removes the backup catalog. Because the command does not include the Force parameter, the command asks for confirmation before it removes the catalog.

Parameters

-Force

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

Type:SwitchParameter
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

SwitchParameter

You can specify the Force parameter to suppress the confirmation message for the cmdlet.

Outputs

String

String that indicates that the cmdlet has deleted the catalog.