Restore-WBCatalog
Restore-WBCatalog
Recovers a backup catalog for the local computer from a storage location.
Syntax
Parameter Set: Default
Restore-WBCatalog [-BackupTarget] <WBBackupTarget> [[-Force]] [ <CommonParameters>]
Detailed Description
The Restore-WBCatalog cmdlet recovers a backup catalog for the local computer from a storage location that you specify.
If the location (disk, DVD, or remote shared folder) where you store your backups is damaged or lost and you cannot use it to restore the backup catalog, use the Remove-WBCatalog cmdlet to delete the corrupted catalog. Then, create a new backup after the cmdlet finishes deleting your backup catalog.
Parameters
-BackupTarget<WBBackupTarget>
Specifies a backup target object that contains the storage location where backups from which the cmdlet restores the catalog reside.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Force
Indicates that the cmdlet recovers the catalog without prompting you for confirmation. By default, the cmdlet prompts you for confirmation before it proceeds.
Aliases |
none |
Required? |
false |
Position? |
2 |
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.
WBBackupTarget, SwitchParamter
Specifies a backup target object from which to restore the catalog. Use the Force parameter to suppress the confirmation message.
Outputs
The output type is the type of the objects that the cmdlet emits.
System.String
Specifies a warning that gives details about the backups present in the backup target and a message that confirms that the cmdlet successfully recovered the catalog.
Examples
Example 1: Restore a backup catalog
This command recovers the backup catalog from the backup target in the variable named $Bt. The cmdlet displays a warning that gives details about the backups present in the backup target. The cmdlet also displays a message that confirms that it has successfully recovered the catalog.
PS C:\> Restore-WBCatalog -BackupTarget $Bt -Force
3 backups found in the specified target.
WARNING: The backup information on this location has details of backups created
up to 12/8/2011 11:41:38 AM. You may not be able to access backups created
after this date when the catalog recovery operation completes.
The catalog has been successfully recovered.