Installing the Oracle Database Cloud Backup Module

To back up to Oracle Database Backup Cloud Service, you first need to install the Oracle Database Cloud Backup Module. You’ll download the module from Oracle Technology Network (OTN) and install it on your database server.

Before You Begin

Before you install the Oracle Database Cloud Backup Module, make sure you have what you need:

Note:

If your database server has multiple Oracle homes, the backup module must be installed into each ORACLE_HOME. Alternatively, you can copy the library file (libopc.so or oraopc.dll, depending on your operating system) to other Oracle home library locations, along with the opcSID.ora configuration file (assuming you're using the same cloud credentials for backing up all databases in the database server).

Copy and rename the opcSID.ora file for each database instance you are backing up to the cloud, where SID matches the SID for the database instance.

Supported Databases and Operating Systems

The Oracle Database Cloud Backup Module can be used to back up Oracle Database 10g Release 2 (10.2) and later to Oracle Database Backup Cloud Service.

The following table lists supported database versions and operating systems for the backup module. It also lists supported Recovery Manager (RMAN) compression and encryption options. For information about these optimizations, see About Oracle Database Backup Cloud Service.

System Supported Versions

Oracle Database*

Enterprise Edition: 10g Release 2 (10.2.0.5) and later

Standard Edition (SE, SE1, SE2): 10g Release 2 (10.2.0.5), 11g Release 1 (11.1.0.7), 11g Release 2 (11.2.0.3 and 11.2.0.4), and later

* Unsupported Oracle Database versions are in deprecated mode. See My Oracle Support Doc ID 1640149.1 at http://support.oracle.com for the latest support matrix.

Operating system (64 bits)

Linux, Solaris x86-64, SPARC, Windows, AIX, HP-UX, zLinux

RMAN compression

HIGH, MEDIUM, BASIC, LOW

RMAN encryption

Enterprise Edition: Password, Transparent Data Encryption (TDE), dual mode.

Standard Edition: Password, TDE, dual mode. Requires a patch. Refer to My Oracle Support Doc ID 1640149.1 at http://support.oracle.com.

Parameters Used to Run the Backup Module Installer

You’ll need to specify parameters and their values when you run the Oracle Database Cloud Backup Module installer. Parameters include host (REST endpoint), service name, identity domain, and account credentials. It’s best to compile this information before you run the installer.

The following examples show what you’ll need to provide:

java -jar opc_install.jar -serviceName myService
-identityDomain myDomain -opcId 'myAccount@myCompany.com'
-opcPass 'myPassword' -walletDir /walletDirectory
-libDir /libraryDirectory

-or-

java -jar opc_install.jar
-host https://identityDomain.storage.oraclecloud.com/v1/serviceName-identityDomain
-opcId 'myAccount@myCompany.com' -opcPass 'myPassword'
-walletDir /walletDirectory -libDir /libraryDirectory

The following table lists required parameters. Optional parameters are also listed.

Parameters can also be displayed by running the following command from the directory that contains the opc_install.jar installer file:

java -jar opc_install.jar

Parameter Description Required or Optional

—serviceName

Service name associated with your Oracle Database Backup Cloud Service account.

If you have a pre-paid metered subscription, the service name is Storage (case sensitive).

Optional if the -host parameter is used (don’t include -serviceName if -host is used)

—identityDomain

Identity domain of the Oracle Database Backup Cloud Service account.

Optional if the -host parameter is used (don’t include —identityDomain if -host is used)

-host

REST endpoint for your service as listed on the service details page. For information about finding the URL for your account, see About REST URLs for Oracle Storage Cloud Service Resources in Using Oracle Storage Cloud Service.

Use the -host parameter to specify a REST endpoint other than the default endpoint constructed when the -serviceName and -identityDomain parameters are used to install the Oracle Database Cloud Backup Module. This might be necessary if you run the module installer using the -serviceName and -identityDomain parameters but get an error indicating an incorrect URL.

The format of the URL used with the -host parameter is as follows:

https://identityDomain.storage.oraclecloud.com/v1/serviceName-identityDomain

For example:

-host https://abc.storage.oraclecloud.com/v1/hr-abc

Optional if the -serviceName and -identityDomain parameters are used (don’t include -host if -serviceName and -identityDomain are used)

—opcId

User name for your Oracle Database Backup Cloud Service account.

Enclose the user name in single quotes, for example 'myAccount@myCompany.com'. On Windows systems, use double quotes if the user name contains special characters.

Required

—opcPass

Password for the Oracle Database Backup Cloud Service account specified by —opcId.

Enclose the password in single quotes, for example 'myPassword'. On Windows systems, use double quotes if the password contains special characters.

Required

—walletDir

Directory in which Oracle Database Backup Cloud Service credentials are stored.

Suggested location on Linux and UNIX systems:

ORACLE_HOME/dbs/opc_wallet

Suggested location on Windows systems:

ORACLE_HOME\database\opc_wallet

If the specified wallet directory does not exist (for example, opc_wallet), the installer creates it.

Required

—libDir

Directory in which the system backup to tape (SBT) library used for backups and restores is stored.

If omitted, the library is not downloaded. In most cases, you should specify this parameter and download the library. An exception might be if you’re using the installer to regenerate the wallet and configuration file in an Oracle home directory where the Oracle Database Cloud Backup Module was previously installed.

Suggested location on Linux and UNIX systems:

ORACLE_HOME/lib

Suggested location on Windows systems:

ORACLE_HOME\bin

If the specified directory does not exist, you are prompted to create it and then run the installer again.

Required if you want to download the latest module

Optional if you just want to update the password after you change it in Oracle Cloud

—libPlatform

Operating system for the SBT library used for backups and restores.

In most cases, you don’t need to specify this parameter because the installer automatically determines the correct operating system.

Exceptions might be if you see error messages indicating your operating system can’t be identified or if you need to download the library for use on a different system.

Supported values for this parameter:
  • linux64

  • windows64

  • solaris_sparc64

  • solaris_x64

  • zlinux64

  • hpux_ia64

  • aix_ppc64

For information about supported operating systems, see Supported Databases and Operating Systems.

Optional

—container

Custom container created by you, separate from Oracle Database Backup Cloud Service, to store backups. If omitted, backups are stored in the default container that’s created when the backup module is installed. See Storing Backups in Custom Containers.

Note: Containers that are used by Recovery Manager (RMAN) cannot have server-side encryption enabled.

Optional

—configFile

Directory in which the Oracle Database Cloud Backup Module configuration file is stored. If omitted, the configuration file is stored in a default location.

Default location on Linux and UNIX systems:

ORACLE_HOME/dbs

Default location on Windows systems:

ORACLE_HOME\database

The file name is opcSID.ora, where SID is the system identifier of the Oracle database being backed up to Oracle Database Backup Cloud Service.

Optional

—proxyHost

HTTP proxy server host name

Optional

—proxyPort

HTTP proxy server port number

Optional

—proxyId

HTTP proxy server user name, if needed

Optional

—proxyPass

HTTP proxy server password, if needed

Optional

—argFile

Indicates that parameters should be read from the specified file. For example, a file named arguments.txt might contain the following:

-opcID 'myAccount@myCompany.com'
-opcPass 'abc123$'
-serviceName myService
-identityDomain myDomain
-libDir /home/oracle/OPC/lib
-walletDir /home/oracle/OPC/wallet

For this example, the following command installs the backup module using the parameters specified in the file:

java -jar opc_install.jar -argFile arguments.txt

Optional

Downloading and Installing the Backup Module

Download and install the Oracle Database Cloud Backup Module on your database server.

First, make sure you’re ready. See Before You Begin.
To download and install the backup module:
  1. Download the Oracle Database Cloud Backup Module from Oracle Technology Network (OTN):

    http://www.oracle.com/technetwork/database/availability/oracle-cloud-backup-2162729.html

    Accept the license agreement, click All Supported Platforms, and provide your OTN user name and password when prompted. Then download the ZIP file that contains the installer (opc_installer.zip) to your system.

  2. Extract the contents of the file.

    The file contains the installer file, opc_install.jar, and a README file.

  3. Run the installer from the directory that contains opc_install.jar, providing the required parameters in one line, with each parameter preceded by a hyphen and followed by its value. For information about required parameters, see Parameters Used to Run the Backup Module Installer.

The following is an example run of the installer. This example shows how the installer automatically downloads the Oracle Database Cloud Backup Module for your operating system, creates a wallet that contains Oracle Database Backup Cloud Service identifiers and credentials, creates the Oracle Database Cloud Backup Module configuration file, and downloads the library necessary for cloud backups and restores.

java -jar opc_install.jar -serviceName myService
-identityDomain myDomain -opcId 'myAccount@myCompany.com'
-opcPass 'myPassword' -walletDir /home/oracle/OPC/wallet
-libDir /home/oracle/OPC/lib
 
Oracle Database Cloud Backup Module Install Tool, build 2014-08-15
Oracle Database Cloud Backup Module credentials are valid.
Oracle Database Cloud Backup Module wallet created in directory /home/oracle/OPC/wallet.
Oracle Database Cloud Backup Module initialization file /orclhome/dbs/opcmySID.ora created.
Downloading Oracle Database Cloud Backup Module Software Library from fileopc_linux64.zip.
Downloaded 13165919 bytes in 204 seconds. Transfer rate was 64538 bytes/second.
Download complete.

If you're installing the module using the -host parameter instead of the -serviceName and -identityDomain parameters, you'd specify something like this:

java -jar opc_install.jar -host https://myDomain.storage.oraclecloud.com/v1/myService-myDomain
-opcId 'myAccount@myCompany.com' -opcPass 'myPassword'
-walletDir /home/oracle/OPC/wallet -libDir /home/oracle/OPC/lib

Note:

You can run the installer and install the backup module as many times as you like. Periodically perform the installation procedure to get the latest RMAN SBT library module, and also to update the password after you change it in Oracle Cloud.

Files Created When the Backup Module is Installed

After you run the Oracle Database Cloud Backup Module installer, make sure the required files are on your system.

The following files are created when you install the backup module and are used by Oracle Database Backup Cloud Service to perform cloud backups and restores. For information about the parameters mentioned, see Parameters Used to Run the Backup Module Installer.

File Location Purpose

libopc.so on Linux and UNIX systems

oraopc.dll on Windows systems

As specified for the —libDir parameter when you run the backup module installer.

Example location:

ORACLE_HOME/lib

Operating system-specific SBT library that enables cloud backups and restores.

opcSID.ora

As specified for the —configFile parameter when you run the backup module installer.

Default location on Linux and UNIX systems:

ORACLE_HOME/dbs

Default location on Windows systems:

ORACLE_HOME\database

Configuration file that contains the Oracle Database Backup Cloud Service container URL and credential wallet location, where SID is the system identifier of the Oracle database being backed up to Oracle Database Backup Cloud Service.

Note: Containers that are used by Recovery Manager (RMAN) cannot have server-side encryption enabled.

cwallet.sso

As specified for the —walletDir parameter when you run the backup module installer.

Example location:

ORACLE_HOME/dbs/opc_wallet

Oracle wallet file that securely stores Oracle Database Backup Cloud Service credentials. This file is used during Recovery Manager (RMAN) backup and restore operations and is stored in the Oracle Database Backup Cloud Service wallet directory (for example, opc_wallet).