Export (0) Print
Expand All

Start-OBRecovery

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Start-OBRecovery

Recovers the array of OBRecoverableItem objects with the specified recovery options in the OBRecoverableOptions object.

Syntax

Parameter Set: Default
Start-OBRecovery [-RecoverableItem] <CBRecoverableItem[]> [[-RecoveryOption] <CBRecoveryOption> ] [[-EncryptionPassphrase] <SecureString> ] [[-Async]] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed 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.
 1)  Restore to original location.
 2)  Create copies in case of conflict.
 3)  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 Windows Azure Backup cmdlets, the user must be a member of the Administrators group or Backup Operators group.

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.


Aliases

none

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EncryptionPassphrase<SecureString>

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.


Aliases

none

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-RecoverableItem<CBRecoverableItem[]>

Specifies the items to be recovered.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-RecoveryOption<CBRecoveryOption>

Specifies whether the items recovered should overwrite any existing copies or whether copies of existing items should be created during recovery.


Aliases

none

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByValue)

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.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Internal.CloudBackup.Client.Cmdlets.OBJob

Examples

EXAMPLE 1

This example starts a recovery job.


PS C:\> $sources = Get-OBRecoverableSourcePS C:\> $RP = Get-OBRecoverableItem -Source $sources[0]PS C:\> $passphrase = Read-Host –Prompt "Enter encryption passphrase" –AsSecureStringPS C:\> $pwd = ConvertTo-SecureString -String Notag00dpa55word -AsPlainText –Force PS C:\>PS C:\> $cred = New-Object –TypeName System.Management.Automation.PsCredential –ArgumentList contoso\johnj99, $pwdPS C:\> $RO = New-OBRecoveryOption -DestinationPath C:\\test -OverwriteType OverwritePS C:\> Start-OBRecovery -RecoverableItem $RP -RecoveryOption $RO -EncryptionPassphrase $passphrase -Credential $cred -Async

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft