Veeam Backup & Replication 9.5 Update 4 [Archived]
Veeam Explorers PowerShell Reference
Related documents
Search
This is an archive version of the document. To get the most up-to-date information, see the current version.

Restore-VEORRMANDatabase

In this article

    Short Description

    Restores Oracle databases backed up with the Veeam Plug-in for Oracle RMAN.

    Applies to

    Product Edition: Enterprise Plus

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • To restore Oracle data files for Windows server to the latest available state:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Restore -ToCurrentPointInTime [-WindowsCredentials <pscredential>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To restore an Oracle database for the Windows server to the specific point in time state:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Restore -UntilTime <datetime> [-WindowsCredentials <pscredential>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To restore Oracle data files for the Windows server to the specified SCN:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Restore -UntilScn <bigint> [-WindowsCredentials <pscredential>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To restore Oracle data files for the Windows server to the specified sequence:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Restore -UntilSeq <bigint> [-WindowsCredentials <pscredential>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To restore Oracle data files for the Linux server to the latest available state:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Restore -LinuxCredentials <VEORLinuxCredential> -ToCurrentPointInTime [-SshPort <int>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To restore Oracle data files for the Linux server to the specified date and time:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Restore -LinuxCredentials <VEORLinuxCredential> -UntilTime <datetime> [-SshPort <int>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To restore Oracle data files for the Linux server to the specified SCN:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Restore -LinuxCredentials <VEORLinuxCredential> -UntilScn<bigint> [-SshPort <int>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To restore Oracle data files for the Linux server to the specified sequence:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Restore -LinuxCredentials <VEORLinuxCredential> -UntilSeq <bigint> [-SshPort <int>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Windows server to the latest available state:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Recover -ToCurrentPointInTime [-WindowsCredentials <pscredential>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Windows server to the specified date and time:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Recover -UntilTime <datetime> [-WindowsCredentials <pscredential>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Windows server to the specified SCN:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Recover -UntilScn <bigint> [-WindowsCredentials <pscredential>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Windows server to the specified sequence:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Recover -UntilSeq <bigint> [-WindowsCredentials <pscredential>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Linux server to the latest available state:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Recover -LinuxCredentials <VEORLinuxCredential> -ToCurrentPointInTime [-SshPort <int>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Linux server to the specified date and time:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Recover -LinuxCredentials <VEORLinuxCredential> -UntilTime <datetime> [-SshPort <int>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Linux server to the specified SCN:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Recover -LinuxCredentials <VEORLinuxCredential> -UntilScn <bigint> [-SshPort <int>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Linux server to the specified sequence:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -Recover -LinuxCredentials <VEORLinuxCredential> -UntilSeq <bigint> [-SshPort <int>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Windows server from the previously restored data files to the latest available state:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -RestoreAndRecover -ToCurrentPointInTime [-WindowsCredentials <pscredential>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Windows server from the previously restored data files to the specified date and time:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -RestoreAndRecover -UntilTime <datetime> [-WindowsCredentials <pscredential>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Windows server from the previously restored data files to the specified SCN:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -RestoreAndRecover -UntilScn <bigint> [-WindowsCredentials <pscredential>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Windows server from the previously restored data files to the specified sequence:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -RestoreAndRecover -UntilSeq <bigint> [-WindowsCredentials <pscredential>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Linux server from the previously restored data files to the latest available state:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -RestoreAndRecover -LinuxCredentials <VEORLinuxCredential> -ToCurrentPointInTime [-SshPort <int>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Linux server from the previously restored data files to the specified date and time:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -RestoreAndRecover -LinuxCredentials <VEORLinuxCredential> -UntilTime <datetime> [-SshPort <int>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Linux server from the previously restored data files to the specified SCN:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -RestoreAndRecover -LinuxCredentials <VEORLinuxCredential> -UntilScn <bigint> [-SshPort <int>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    • To recover an Oracle database for the Linux server from the previously restored data files to the specified sequence:

    Restore-VEORRMANDatabase [-Database] <VEORRMANDatabase> -RestoreAndRecover -LinuxCredentials <VEORLinuxCredential> -UntilSeq <bigint> [-SshPort <int>] [-DatabaseCredentials <pscredential>] [-TargetFolder <string>] [-ManualChannelsAllocation] [-ChannelsNumber <int>]  [<CommonParameters>]

    Detailed Description

    This cmdlet restores Oracle databases backed up with the Veeam Plug-in for Oracle RMAN.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Database

    Specifies an Oracle database. The cmdlet will start a restore of the specified database.

    Accepts the VEORRMANDatabase object. To get this object, run the Get-VEORRMANDatabase cmdlet.

    True

    0

    True (ByValue)

    False

    LinuxCredentials

    Specifies credentials that the cmdlet will use to connect to the target Linux server. The cmdlet will restore the database to this server.

    Accepts the VEORRMANDatabase object. To get this object, run the Get-VEORRMANDatabase cmdlet.

    True

    Named

    False

    False

    Recover

    Indicates that the cmdlet will restore Oracle databases to the latest available state.

    SwitchParameter

    True

    Named

    False

    False

    Restore

    Indicates that the cmdlet will restore the data files from a specific point in time without applying log files.

    SwitchParameter

    True

    Named

    False

    False

    RestoreAndRecover

    Indicates that the cmdlet will restore the data files from a specific point in time and will apply log files.

    SwitchParameter

    True

    Named

    False

    False

    ToCurrentPointInTime

    Indicates that the cmdlet will restore the data from the latest available date.

    SwitchParameter

    True

    Named

    False

    False

    UntilScn

    Specifies the System Change Number (SCN). The cmdlet will restore the database from a consistent point.

    BigInteger

    True

    Named

    False

    False

    UntilSeq

    Specifies the sequence. The cmdlet will restore the database from the specified sequence.

    BigInteger

    True

    Named

    False

    False

    UntilTime

    Specifies the date and time. The cmdlet will restore the database from the specified date and time.

    DateTime

    True

    Named

    False

    False

    ManualChannelsAllocation

    Indicates that the cmdlet will use several channels per a restore session to restore data.

    Use the ChannelsNumber parameter to specify the number of channels.

    SwitchParameter

    False

    Named

    False

    False

    ChannelsNumber

    For the manual channels allocation option.

    Specifies the number of channels that will be used for restore.

    Default: Will use the default channel configuration, specified in the Veeam Plug-in for Oracle RMAN settings.

    Int32

    False

    Named

    False

    False

    DatabaseCredentials

    Specifies database credentials.

    PSCredential

    False

    Named

    False

    False

    SshPort

    Specifies the SSH port. The cmdlet will use this port to connect to the Linux target server.

    Int32

    False

    Named

    False

    False

    TargetFolder

    Specifies the target folder. The cmdlet will restore the database to the specified folder.

    String

    False

    Named

    False

    False

    WindowsCredentials

    Specifies Windows credentials. The cmdlet will use these credentials to connect to the target Windows server.

    PSCredential

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Examples

    Restoring to Linux Server From Latest Available State

    This example shows how to restore an Oracle database backed up with the Veeam Plug-in for Oracle RMAN with the following settings:

    • The cmdlet will restore the database from the latest available state.
    • The cmdlet will restore the database to the Linux server.

    $session = Get-VEORRMANRestoreSession

    $database =  Get-VEORRMANDatabase -Session $session[0]

    $securepassword = Read-Host -Prompt "Enter password" -AsSecureString

    $credentials = New-VEORLinuxCredential -Account "root" -Password $securepassword

    Restore-VEORRMANDatabase -Database $database -LinuxCredentials $credentials -ToCurrentPointInTime -Restore

    You must perform the following steps:

    1. Run the Get-VEORRMANRestoreSession cmdlet. Save the result to the $session variable.

    The Get-VEORRMANRestoreSession cmdlet will return an array of active restore sessions. Mind the ordinal number of the necessary restore session (in our example, it is the forth restore session in the array).

    1. Run the Get-VEORRMANDatabase cmdlet. Set the $session variable as the Session parameter value. Save the result to the $database variable.
    2. Run the Read-Host cmdlet to create a secure password. Enter credentials that will be used to connect to the Veeam Backup & Replication server. Define the AsSecureString parameter. Save the result to the $securepassword variable.
    3. Run the New-VEORLinuxCredential cmdlet. Specify the Account parameter value. Set the $securepassword variable as the Password parameter value. Save the result to the $credentials variable.
    4. Run the Restore-VEORRMANDatabase cmdlet. Specify the following settings:
    • Set the $database variable as the Database parameter value.
    • Set the $credentials variable as the LinuxCredentials parameter value.
    • Define the ToCurrentPointInTime and Restore parameters.

    Related Commands

    View all results across Veeam
    Back to document search