Remove-WBCatalog
Remove-WBCatalog
Removes the backup catalog from the local computer.
Syntax
Parameter Set: Default
Remove-WBCatalog [[-Force]] [ <CommonParameters>]
Detailed 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® 2012 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.
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.
Aliases |
none |
Required? |
false |
Position? |
1 |
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.
SwitchParameter
You can specify the Force parameter to suppress the confirmation message for the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
System.String
String that indicates that the cmdlet has deleted the catalog.
Examples
Example 1: Remove a backup catalog
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.
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.