Start-OBRecovery
Recovers the array of OBRecoverableItem objects with the specified recovery options in the OBRecoverableOptions object.
Syntax
Default (Default)
Start-OBRecovery
[-RecoverableItem] <CBRecoverableItem[]>
[[-RecoveryOption] <CBRecoveryOption>]
[[-EncryptionPassphrase] <SecureString>]
[-Async]
[-Confirm]
[-WhatIf]
Description
The Start-OBRecovery cmdlet recovers the array of OBRecoverableItem objects with the specified recovery options in OBRecoverableOptions object. In case of Alternate Server Recovery, the credential and encryption passphrase object would be required to do the recovery.
If no recovery option is specified, the following default options will be used.
- Restore to original location.
- Create copies in case of conflict.
- Restore ACLs of the files.
When recovering data to an alternate server restore flow the cmdlet will display an error message if the OBRecoverableOptions object is not specified because there is no default original location in a recovery from another server.
This cmdlet supports WhatIf and Confirm parameters with a medium impact. The medium impact signifies that the cmdlet will not prompt the user for confirmation by default. The WhatIf parameter gives a verbose description of what the cmdlet does without performing any operation. The Confirm parameter specifies whether the cmdlet should prompt the user. Using -Confirm:$FALSE will override the prompt.
To use Microsoft Azure Backup cmdlets, the user needs to be an administrator on the protected machine.
Examples
EXAMPLE 1
$sources = Get-OBRecoverableSource
$RP = Get-OBRecoverableItem -Source $sources[0]
$passphrase = Read-Host -Prompt "Enter encryption passphrase" -AsSecureString
$pwd = ConvertTo-SecureString -String Notag00dpa55word -AsPlainText -Force
$cred = New-Object -TypeName System.Management.Automation.PsCredential -ArgumentList contoso\johnj99, $pwd
$RO = New-OBRecoveryOption -DestinationPath C:\\test -OverwriteType Overwrite
Start-OBRecovery -RecoverableItem $RP -RecoveryOption $RO -EncryptionPassphrase $passphrase -Credential $cred -Async
This example starts a recovery job.
Parameters
-Async
Allows the user to indicate that the cmdlet should run asynchronously. This is useful with cmdlets that take a long time to complete. The control returns to the user immediately after the operation.
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 |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EncryptionPassphrase
Specifies the encryption passphrase to be used to decrypt the data for recovery. This should be same as the latest encryption passphrase set for backup. This is required in case of Alternate Server Recovery. In case of Alternate Server Recovery this encryption passphrase should match with the latest encryption passphrase set for backup on the original server.
Parameter properties
| Type: | SecureString |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 4 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RecoverableItem
Specifies the items to be recovered.
Parameter properties
| Type: | CBRecoverableItem[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RecoveryOption
Specifies whether the items recovered should overwrite any existing copies or whether copies of existing items should be created during recovery.
Parameter properties
| Type: | CBRecoveryOption |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |