PowerProtect Data Manager 19.10 Oracle RMAN User Guide

Configuration file requirements for connection to local databases

As required for certain ddbmcon program operations, you must complete the required configuration settings to enable the authentication method that you want the program to use. Each authentication method has its own requirements for parameter settings in the configuration file.

During the Oracle RMAN agent installation, the configuration file template, rman_agent.cfg, is installed in the $RMAN_AGENT_HOME/config directory. To enable a particular authentication method, you must set the required parameters in the rman_agent.cfg configuration file.

The configuration file template includes the following information.

# #############################################################################
#
# rman_agent.cfg
#
# All rights reserved.
#
# Oracle RMAN agent 19.10
#
# This template is designed to help users to configure the authentication of
# RMAN agent. Check the product administration guide for a complete list of
# all the supported parameters and rules for editing the configuration file.
#
# Make a copy of this file before making any modifications.
# To enable a parameter, uncomment or add the parameter in the file and
# specify its value.
#
# #############################################################################
#
# #############################################################################
# Oracle parameters.
# There can be repetitive sections of Oracle parameters. The Oracle database
# to which the parameters belong is described in the section name: SID_name.
# The name here must be replaced by the SID of the database.
# :
# #############################################################################
[SID_name]
# ORACLE_SERVICE =
# ORACLE_USER =
# ORACLE_OS_USER =
# TNS_ADMIN =
# RMAN_CATALOG_SERVICE =
# RMAN_CATALOG_USER =
# RAC_BACKUP_NODE_IP =
# DELETE_ARCHIVE_LOGS =
# FILESPERSET =
# MAXOPENFILES =
# SECTION_SIZE =
# BLOCK_SIZE =
# RAC_NODE_IP_1 =
# RAC_NODE_FQDN_1 =
# RAC_NODE_IP_2 =
# RAC_NODE_FQDN_2 =
# RAC_NODE_IP_<n> =
# RAC_NODE_FQDN_<n> =
# :
[GENERAL]
# EXCLUDE_SID=<Oracle SID>

To set a particular parameter in the configuration file, such as ORACLE_SERVICE, remove the # symbol at the start of the parameter line and add the parameter value after the equal sign (=).

You can complete the following settings in the configuration file:

• SID_name is mandatory for each authentication method when you set any parameters in the file for a particular system ID (SID). [SID_name] (for example, [SID_orcl]) must appear on a separate line before all the parameter settings for the SID.

  For any supported Oracle version in a stand-alone or RAC system, SID_name must match the SID that runs on the local host.

  NOTE Each Oracle SID on the same system requires its own entries in the configuration file. You must use the same configuration file for all the Oracle SIDs.
• ORACLE_SERVICE is mandatory for database authentication and Oracle wallet authentication. Specifies the TNS or Net service name of the Oracle database.
• ORACLE_USER is mandatory for database authentication only. Specifies the database username as saved in the lockbox.
• ORACLE_OS_USER is mandatory for operating system authentication when the username for connection is different than the ORACLE_OSDBA_USER username. Specifies the operating system user that will connect to the Oracle database for operating system authentication. When this parameter is set, ORACLE_OSDBA_USER is ignored.
• TNS_ADMIN is mandatory for database authentication and Oracle wallet authentication when the Oracle Net configuration files including tnsnames.ora reside in a non-default directory. Specifies the pathname of the non-default directory. When this parameter is not set, the system default directory $ORACLE_HOME/network is used.
• RMAN_CATALOG_SERVICE is mandatory when an RMAN catalog is used for backup or recovery of the database. Specifies the TNS name of the RMAN catalog.
• RMAN_CATALOG_USER is mandatory for each authentication method when an RMAN catalog is used. Specifies the catalog database username as saved in the lockbox.
• RAC_BACKUP_NODE_IP is highly recommended in an Oracle RAC environment only. In the Oracle RAC environment, select a single node to be the backup node and set this parameter to the hostname or IP address of the backup node.
  NOTE This parameter is not applicable for self-service and stand-alone backups.
• DELETE_ARCHIVE_LOGS is optional. Specifies whether to delete the archive logs just after performing a centralized log backup. When this parameter is set to TRUE, the archive logs are deleted after the log backup.

• FILESPERSET is optional. Specifies the maximum number of files that RMAN can include in a backup set. The value must be an integer between 1 and 64, inclusive.

  NOTE

  As an alternative to setting the parameters FILESPERSET, MAXOPENFILES, SECTION_SIZE, and BLOCK_SIZE in the configuration file, you can set the options Files Per Set, Maximum Open Files, Section Size, and Block Size, respectively, in the protection policy configuration in the PowerProtect Data Manager UI. Add a protection policy for Oracle database protection provides details about the protection policy options.

  The configuration file parameter settings take precedence over the option settings in the PowerProtect Data Manager UI. These parameter and option settings apply only to centralized backups. The FILESPERSET and SECTION_SIZE settings apply only to full, incremental cumulative, and incremental differential backups—not to log backups.

• MAXOPENFILES is optional. Specifies the maximum number of input files that a backup or copy can have open at a given time. The value must be an integer greater than 0.

• SECTION_SIZE is optional. Specifies the size in KB, MB, or GB of each backup section in a multisection backup. In the backup set, each backup piece contains the blocks from one file section. The specified value must be <n>K or <n>M or <n>G, where <n> is an integer greater than 0. K means kilobytes, M means megabytes, and G means gigabytes.

  If you specify a section size that is larger than the size of the file, then RMAN does not use a multisection backup for the file. If you specify a small section size that would produce more than 256 sections, then RMAN increases the section size to a value that results in exactly 256 sections.

• BLOCK_SIZE is optional. Specifies the number of KB of data that the Oracle database reads for the backup operation. The value must be a multiple of the minimum physical block size of the Oracle database. The value must be <n>K, where <n> is an integer between 1 and 1024 inclusive. K means kilobytes.
• EXCLUDE_SID is optional. Specifies the list of Oracle SIDs to exclude from PowerProtect Data Manager discovery.
• RAC_NODE_IP_1, RAC_NODE_FQDN_1, RAC_NODE_IP_2, RAC_NODE_FQDN_2, RAC_NODE_IP_<n>, RAC_NODE_FQDN_<n> are optional. Specify the IP addresses and fully qualified domain names (FQDNs) of the RAC nodes. These RAC node settings are required only if the asset discoveries are not working on the RAC system and the asset report refers to the system as "Stand-alone" instead of "RAC".

The following topics provide more details about the configuration requirements of each particular authentication method.