Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
Veeam Explorers PowerShell Reference

Restore-VEORRMANDatabase

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

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.

True

Named

False

False

Restore

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

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.

True

Named

False

False

ToCurrentPointInTime

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

True

Named

False

False

UntilScn

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

True

Named

False

False

UntilSeq

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

True

Named

False

False

UntilTime

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

True

Named

False

False

Manual
Channels
Allocation

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.

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.

False

Named

False

False

DatabaseCredentials

Specifies database credentials.

False

Named

False

False

SshPort

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

False

Named

False

False

TargetFolder

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

False

Named

False

False

WindowsCredentials

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

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Example

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.

You must perform the following steps:

  1. Run the Get-VEORRMANRestoreSession cmdlet to get the RMAN restore session. Save the result to the $session variable.
  2. Run the Get-VEORRMANDatabase cmdlet to get an Oracle database. Save the result to the $database variable.
  3. Run the Read-Host cmdlet to create a secure password. Save the result to the $securepassword variable.
  4. Run the New-VEORLinuxCredential cmdlet with the $securepassword variable. Save the result to the $credentials variable.
  5. Run the Restore-VEORRMANDatabase cmdlet with the $database variable. Use the TargetFolder parameter to specify the restore location.

$session = Get-VEORRMANRestoreSession

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

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

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

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

Related Commands

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation