Publish-VEORDatabase

Short Description

Publishes backed-up Oracle databases.

Applies to Veeam Backup & Replication

Product Edition: Community, Enterprise, Enterprise Plus

Syntax

This cmdlet provides parameter sets that allow you to:

  • Publish backed-up Oracle databases to Windows VMs.

Publish-VEORDatabase [-Database] <VEORDatabase> [-Server <string>] [-OracleHome <string>] [-GlobalDatabaseName <string>] [-OracleSid <string>] [-WindowsCredentials <pscredential>] [-OracleHomePassword <securestring>][-ToDateTime <datetime>] [-Force]  [<CommonParameters>]

  • Publish backed-up Oracle databases to Linux VMs.

Publish-VEORDatabase [-Database] <VEORDatabase> -LinuxCredentials <VEORLinuxCredential> [-Server <string>][-OracleHome <string>] [-GlobalDatabaseName <string>] [-OracleSid <string>] [-SshPort <int>] [-ToDateTime<datetime>] [-Force]  [<CommonParameters>]

Detailed Description

This cmdlet publishes backed-up Oracle databases.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Database

Specifies an Oracle database. The cmdlet will publish this database.

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

True

0

True (ByValue)

Server

Specifies a name of the target Oracle server. The cmdlet will publish an Oracle database to that server.

String

False

Named

False

LinuxCredentials

Specifies Linux credentials. The cmdlet will use these credentials to connect to the Linux VM.

Accepts the VEORLinuxCredentials object. To get this object, run the New-VEORLinuxCredential cmdlet.

False

Named

False

OracleHome

For publishing to another location.

Specifies the target Oracle Home path. The cmdlet will publish an Oracle database to the location specified in the Oracle Home path.

String

False

Named

False

GlobalDatabaseName

Specifies a target global database name. The cmdlet will publish an Oracle database with the specified name.

String

False

Named

False

OracleSid

Specifies target SID for an Oracle database. The cmdlet will publish the database with the specified SID.

String

False

Named

False

WindowsCredentials

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

PSCredential

False

Named

False

OracleHomePassword

For publishing Oracle Database 12c or later on Windows server.

Specifies Oracle Home credentials. The cmdlet will use these credentials for starting Oracle Services on the VM guest OS.

Note: This parameter is required in case you use the following types of Oracle Home User:

  • Existing Windows user
  • New Windows user

SecureString

False

Named

False

ToDateTime

Specifies a restore period. The cmdlet will publish the Oracle database to the specified period.

DateTime

False

Named

False

SshPort

Specifies the SSH port number. The cmdlet will use that port to connect to the Linux VM.

Default: 22.

Int32

False

Named

False

Force

Defines that the cmdlet will remove the target Oracle database with the database from backup.

Note: The cmdlet will show no prompt before executing the command.

SwitchParameter

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 Docs.

Output Object

The cmdlet returns the VEORPublishedDatabase object that contains settings of published Oracle databases.

Publish-VEORDatabaseExample 1. Publishing Oracle Database

This example shows how to publish backed-up Oracle database.

$session = Get-VEORRestoreSession

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

Publish-VEORDatabase -Database $database -Server "OracleSrv2049"

Perform the following steps:

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

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

  1. Run the Get-VEORDatabase cmdlet. Set the $session variable as the Session parameter value. Save the result to the $database variable.
  2. Run the Publish-VEORDatabase cmdlet. Set the $database variable as the Database parameter value. Specify the Server parameter value.

Publish-VEORDatabaseExample 2. Publishing Oracle Database to Linux VM

This example shows how to publish backed-up Oracle databases to Linux VM.

$session = Get-VEORRestoreSession

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

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

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

Publish-VEORDatabase -Database $database -LinuxCredentials $linuxcreds

Perform the following steps:

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

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

  1. Run the Get-VEORDatabase cmdlet. Set the $session variable as the Session parameter value. Save the result to the $database variable.
  1. Get Linux credentials:
  1. Run the Read-Host cmdlet. Specify the Prompt parameter value. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
  2. Run the New-VEORLinuxCredential cmdlet. Specify the Account parameter value. Set the $securepassword as the Password parameter value.
  1. Run the Publish-VEORDatabase cmdlet. Specify the following settings:
  • Set the $database variable as the Database parameter value.
  • Set the $linuxcreds as the LinuxCredentials parameter value.

Related Commands

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.