1. Migrating Oracle Database Backup Cloud Service Backups to Oracle Cloud Infrastructure
  2. Prepare to Migrate Database Backups
  3. Set Up Your Target Environment
  4. Install the Oracle Database Cloud Backup Module for OCI
  5. Parameters to Run the Oracle Database Cloud Backup Module for OCI

Parameters to Run the Oracle Database Cloud Backup Module for OCI

You must specify parameters and their values when you run the Oracle Database Cloud Backup Module for OCI installer. Parameters include the host name for the Oracle Cloud Infrastructure account and the private key used to sign Oracle Cloud Infrastructure API requests. It’s best to compile this information before you run the installer.

The following example shows what you’ll need to provide:

java -jar oci_install.jar
-host https://objectstorage.us-phoenix-1.oraclecloud.com
-pvtKeyFile oci_private_key -pubFingerPrint oci_public_fingerprint 
-uOCID user_ocid -tOCID tenancy_ocid
-walletDir /wallet_directory -libDir /library_directory

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 oci_install.jar installer file:

java -jar oci_install.jar

Parameter Description Required or Optional

-host

End point of the Oracle Cloud Infrastructure account.

Required

-pvtKeyFile

File that contains the private key used to authenticate Oracle Cloud Infrastructure API requests. The key file must be in PEM format.

This private key is never transmitted outside of the computer where the installer is run.

Required

-pubFingerPrint

Finger print of the public key paired with the specified private key. The finger print tells Oracle Cloud Infrastructure which private and public key pair is used to authenticate the API requests.

Required

-tOCID

Tenancy OCID for the Oracle Cloud Infrastructure account.

Required

-uOCID

User OCID for the Oracle Cloud Infrastructure account.

Required

-bucket

Name of the bucket in which backups are stored. If this bucket does not exist, then the installer creates it.

When this parameter is omitted, a default bucket is automatically created to store backups.

Optional

-cOCID

Resource compartment ID for the Oracle Cloud Infrastructure account. The default value is the tenancy OCID if not specified.

Optional

-newRSAKeyPair

Set up a new pair of public and private RSA keys for authentication. If specified, the installer generates a random RSA private and public key pair of 2048 bits and stores them in the specified Oracle wallet directory.

Optional

-walletDir

Directory in which Oracle Cloud Infrastructure Object Storage 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 with Oracle Cloud Infrastructure 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 for OCI 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

-lib-download-only

Downloads only the SBT library. Use this parameter to update the library without making changes to the configuration file and the wallet.

 Optional

-configFile

Directory in which the Oracle Database Cloud Backup Module for OCI 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 opc2SID.ora, where SID is the system identifier of the Oracle database being backed up to Oracle Cloud Infrastructure Object Storage Service.

Optional

-trustedCerts

Comma-separated list of SSL certificates that must be added to the wallet. If the installer is unable to retrieve the certificates required for the SSL connection from local Java truststore, this SSL certificates specified by this parameter are imported. All SSL certificates must be in the PEM format.

Optional

-import-all-trustcerts

Import all X509 certificates from the Java truststore.

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$'
-host https://objectstorage.us-phoenix-1.oraclecloud.com
-libDir /home/oracle/OPC/lib
-walletDir /home/oracle/OPC/wallet

For this example, the following command installs the Oracle Database Cloud Backup Module for OCI using the parameters specified in the file:

java -jar opc2_install.jar -argFile arguments.txt

Optional