Start-WssServerVolumeRestore
Start-WssServerVolumeRestore
Starts a volume restore operation.
Syntax
Parameter Set: Default
Start-WssServerVolumeRestore [-BackupSet] <BackupSet> [-VolumeToRestore] <BackupVolume> [-DestinationVolume] <BackupVolume> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Start-WssServerVolumeRestore cmdlet starts a volume restore operation on a server.
Parameters
-BackupSet<BackupSet>
Specifies a backup set from which to restore a volume.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DestinationVolume<BackupVolume>
Specifies a destination volume to which to restore a source volume.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VolumeToRestore<BackupVolume>
Specifies a source volume to restore.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Restore a volume
This example restores a volume from a backup set.
The first command uses the Get-WssBackupPolicy cmdlet to get the current backup policy, and stores the results in the variable $Policy.
The second command uses the Get-WssBackupVolume cmdlet to get the backup volumes that are backed up with this policy, and stores the result in the variable named $Source.
The third command uses the Get-WssBackupVolume cmdlet to get the volumes on the system, and stores the result in the variable named $Destination.
The fourth command uses the Get-WssBackupSet cmdlet to retrieve the backup sets, and stores the result in the variable named $Backupset.
The fifth command uses the Get-WssServerVolumeRestore cmdlet to restore the volume.
PS C:\> $Policy = Get-WssBackupPolicy
PS C:\> $Source = Get-WssBackupVolume -BackupPolicy $Policy
PS C:\> $Destination = Get-WssBackupVolume -AllVolumes
PS C:\> $Backupset = Get-WssBackupSet
PS C:\> Start-WssServerVolumeRestore -BackupSet $Backupset[0] -VolumeToRestore $Source[2] -DestinationVolume $Destination[2]