The Start-WBSystemStateRecovery cmdlet starts a system state recovery operation.
If the System State recovery operation is performed on the actual computer, completion of the operation requires a restart.
If recovery is performed on an Active Directory (AD) computer, this cmdlet must be run in Directory Services Restore Mode (DSRM).
Examples
Example 1: Start a system state recovery operation
This example starts a system state recovery operation, and then restarts the computer at the end of the recovery operation.
The first command stores the result of Get-WBBackupSet in a variable named $Backup.
The second command starts the system state recovery from the backup stored in the $Backup variable.
The command also uses the Force parameter to perform the recovery without prompting, the RestartComputer parameter to restart the computer when recovery finishes, and the Async parameter to suppress status output.
Parameters
-ADIFM
Indicates that this cmdlet recovers all the related data needed for Active Directory Domain Services from an install from a media (IFM) operation.
Active Directory Install From Media (ADIFM) creates a copy of the Active Directory database, registry, and SYSVOL state, and then saves this information in the location specified by the RecoveryTarget parameter.
Use this parameter only when RecoveryTarget is specified.
This parameter is valid only if the backup set contains an Active Directory system state backup.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
ADIFM
Position:
1
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Async
Indicates that Windows PowerShell returns immediately after starting the backup, and does not output status to the screen.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
4
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-AuthoritativeSysvolRecovery
Indicates that this cmdlet performs an authoritative recovery of SYSVOL, the System Volume shared directory.
This parameter is valid only if the backup set contains an Active Directory system state backup.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
SSR
Position:
2
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-BackupSet
Specifies the backup set from which this cmdlet performs system state recovery.
Parameter properties
Type:
WBBackupSet
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
0
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
5
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-RestartComputer
Indicates that this cmdlet performs a system restart at the completion of the system state recovery operation.
Use this parameter only for a recovery to the original location.
Do not use this parameter if you need to perform steps after the recovery operation.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
SSR
Position:
3
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-TargetPath
Specifies an alternate location where the files belonging to system state can be recovered from the backup set.
If you do not specify this parameter, system state recovery is performed for the actual computer, which needs a restart at the end of the operation.
ADIFM recovery requires this parameter.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
SSR
Position:
1
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.