Export-VEORPublishedDatabase

Short Description

Exports a published Oracle database.

Product: Veeam Backup & Replication

Product Edition: Community, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Export-VEORPublishedDatabase [-Database] <VEORPublishedDatabase> [-Path] <String> [-RmanBackupFormat <String>]

[-RmanBackupTagName <String>] [-RmanBackupEnableCompression] [-Force] [-ChannelsNumber <Int32>] [<CommonParameters>]

Detailed Description

This cmdlet exports a published Oracle database as an RMAN backup. The database is exported to the specified path on the machine where the PowerShell session is running.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
ChannelsNumber	Specifies a number of channels that will be used to export Oracle databases. Default: 4 Permitted value: 1–255.	`Int32`	False	Named	False
Database	Specifies a published Oracle database that you want to export. Accepts the `VEORPublishedDatabase` object. To get this object, run the `Get-VEORPublishedDatabase` cmdlet.	`VEORPublishedDatabase`	True	0	True (ByValue)
Force	Defines that the cmdlet will overwrite the existing Oracle database files with the database files from the backup. If you provide this parameter, the cmdlet will show no prompt before executing the command. Otherwise, the cmdlet will keep the existing version of Oracle database files.	`SwitchParameter`	False	Named	False
Path	Specifies a target directory. The cmdlet will export the Oracle database to the specified directory.	`String`	True	1	False
RmanBackupEnableCompression	Defines that the cmdlet will back up Oracle databases with compression. If you do not specify this parameter, the cmdlet will back up Oracle databases without compression.	`SwitchParameter`	False	Named	False
RmanBackupFormat	Specifies the FORMAT parameter of backed-up Oracle databases. The cmdlet will back up Oracle databases using the specified FORMAT parameter.	`String`	False	Named	False
RmanBackupTagName	Specifies tags of backed-up Oracle databases. The cmdlet will back up Oracle databases using the specified tags.	`String`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Examples

Exporting Published Oracle Databases

This example shows how to export a published Oracle database as an RMAN backup.

$session = Get-VEORRestoreSession

$database = Get-VEORPublishedDatabase -Session $session[0] -Name "orcl"

Export-VEORPublishedDatabase -Database $database -Path "C:\Users\Administrator\Desktop\orcl"

Perform the following steps:

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

The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session (in this example, it is the first restore session in the array).
Run the Get-VEORPublishedDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $database variable.
Run the Export-VEORPublishedDatabase cmdlet. Set the $database variable as the Database parameter value. Specify the Path parameter value.