D Configuration Files for Oracle Collaboration Suite Recovery Manager

This appendix provides the listing of two configuration files used by the Oracle Collaboration Suite Recovery Manager: config.inp and myconfig.inp.

config.inp

This is the default environment configuration file that ships with the Oracle Collaboration Suite Recovery Manager, and is automatically used by the configure command.

Note:

These files contain comments under the ORACLE_HOME and ORACLE_SID sections which make reference to when the tool is invoked through EM (Enterprise Manager). These comments do not apply to the Oracle Collaboration Suite Recovery Manager.

On UNIX:

ocs_bkp_restore.sh -m configure

# Description
# -----------
# This file contains the user-specific environment used for doing backup and
# recovery operations. This file (config.inp) is picked up by default as
# the environment configuration file.
# If desired, you can use the "-e" option to select a different environment
# configuration file
#
# Syntax of this file
# ------------------
# parameter_name=parameter_value
#    where parameter_name is one of
#       log_path
#       config_backup_path
#       database_backup_path
#       pfile
#       config_files_list
#       plugin_config_files_list
#       orainst_loc_path
#       install_type
#       dcm_repository_type
#       oracle_home
#       instance_name
#       dbid
#       oracle_sid
#       infra_with_portal
# No spaces are allowed before and after the "=" sign in the syntax
# Comment lines have a leading "#" sign in the beginning of the line
# It is OK to have blank lines in the file
 
 
# *************************** REQUIRED PARAMETERS ****************************
# These parameters should be set by the user.
# ****************************************************************************
 
# - LOG_PATH (Required)
# This is path under which the tool saves logs generated during backups and
# restores of database and configuration files.
log_path=VALUE_NOT_SET
 
# - CONFIG_BACKUP_PATH (Required)
# This parameter points to a directory which should be used by the script
# to backup your configuration files. 
# Additionally, this path is used to display the list of instance or
# configuration backups that can be restored.
config_backup_path=VALUE_NOT_SET
 
# - DATABASE_BACKUP_PATH (Required for infrastructure)
# This is the path under which database backups are stored.
# If you want to backup the database to an ASM disk group then specify
# the disk group as in this example: database_backup_path=+DISKGROUP1
# (Path names beginning with '+' are assumed to be ASM paths).
database_backup_path=VALUE_NOT_SET
 
 
# *************************** OPTIONAL PARAMETERS ****************************
# These parameters are set by the tool. The user can modify them if
# necessary.
# ****************************************************************************
 
# - CONFIG_FILE_LIST (Automatically set during configure)
# This parameter specifies the filenames which contains the lists of config
# files that need to be backed up and restored.  Remove .inp files that do
# not apply.  If you would like to include your own custom config files,
# add those to the end of the list AFTER running the tool w/ the configure
# option.
config_files_list=DO_NOT_SET
 
# - PLUGIN_CONFIG_FILES_LIST
plugin_config_files_list=DO_NOT_SET
 
# - ORAINST_LOC_PATH
# This parameter is used only by LOHA (Loss of Host Automation) operations on
# Unix platforms. It points to the location of oraInst.loc created by Oracle
# Universal Installer. It should be changed only if oraInst.loc is not in its
# default location.
orainst_loc_path=default
 
# - PFILE (Optional for infrastructure)
# This is your database parameter file, and is used when the database is
# restarted.  Only set this parameter if you do not wish to use the default
# pfile/spfile.
# Note: Comment out the pfile line if it is not being set
# pfile=
 
 
# ***************************** SYSTEM PARAMETERS ****************************
# These parameters are saved by the tool.  The user should not modify them.
# ****************************************************************************
 
# - INSTALL_TYPE (Automatically set during configure)
# This parameter lets the tool "know" what the install type is
# (e.g. Infrastructure or Midtier)
install_type=DO_NOT_SET
 
# - REPOSITORY_TYPE (Automatically set during configure/backup)
# This parameter specifies the dcm repository type on this node
dcm_repository_type=none
 
# - ORACLE_HOME (Automatically set by the tool)
# This is your oracle_home setting.
# This parameter is automatically set when the tool is invoked through EM.
# When using command line interface, the user needs to set ORACLE_HOME in the
# environment before invoking the tool.
# All operations will assume that directories in $oracle_home, such
# as $oracle_home/bin, $oracle_home/opmn/bin, ... contain the necessary
# utilities.
# All configuration backup/recovery options will assume that the configuration
# files have to be backed up and restored to paths relative to this setting.
oracle_home=VALUE_NOT_SET
 
# - INSTANCE_NAME (Automatically set by the tool)
# This parameter contains the fully qualified instance name.
# The backup catalog file is saved in $config_backup_path/br_catalog under
# this name.
instance_name=DO_NOT_SET
 
# - DBID (Automatically set during configure)
# This parameter is the database identifier, and is populated automatically
# when you run the script in the '-configure' mode. A subsequent attempt to
# recover the database uses this parameter
dbid=DO_NOT_SET
 
# - ORACLE_SID (Automatically set by the tool)
# This parameter is automatically set during configure operation through EM.
# For an infrastructure, the command line user needs to set ORACLE_SID in the
# environment to point to the correct database instance.
oracle_sid=VALUE_NOT_SET
 
# - INFRA_WITH_PORTAL (Automatically set during configure/backup)
# This parameter indicates whether the instance is an infrastructure with
# portal mid-tiers registered. If so, portal schema validation utility will
# be run as part of backups.
infra_with_portal=VALUE_NOT_SET
 
 
# --------------- Notes on configuration file backup/recovery ---------------
# Backup/recovery of configuration files depends on the setting of
# - 'config_files_list' specifies the list of files to be backed up or recovered
# - 'oracle_home' specifies the base directory for the location of the files
#   specified in 'config_files_list'
# - 'config_backup_path' specifies the location where the configuration files
#   should be backed up
# - 'config_backup_path' is also used in the 'restore_config' mode to provide
#   the user with a list of configurations that can be restored

myconfig.inp

This is an example of a modified environment configuration file that can be used with the Oracle Collaboration Suite Recovery Manager through the -e switch on the configure command.

On UNIX:

ocs_bkp_restore.sh -m configure -e myconfig.inp

To use this file, create a copy of your config.inp file and rename it myconfig.inp, and change the values of these parameters:

log_path
config_backup_path
database_backup_path
oracle_home
oracle_sid

#
# Description
# -----------
# This file contains the user-specific environment used for doing backup and
# recovery operations. This file (myconfig.inp) is used with the "-e" option.
#
# Syntax of this file
# ------------------
# parameter_name=parameter_value
# where parameter_name is one of
# log_path
# config_backup_path
# database_backup_path
# pfile
# config_files_list
# plugin_config_files_list
# orainst_loc_path
# install_type
# dcm_repository_type
# oracle_home
# instance_name
# dbid
# oracle_sid
# infra_with_portal
# No spaces are allowed before and after the "=" sign in the syntax
# Comment lines have a leading "#" sign in the beginning of the line
# It is OK to have blank lines in the file

# *************************** REQUIRED PARAMETERS ****************************
# These parameters should be set by the user.
# ****************************************************************************

# - LOG_PATH (Required)
# This is path under which the tool saves logs generated during backups and
# restores of database and configuration files.
log_path=/scratch/ocs_home/infra/backup_restore/backups/log_files

# - CONFIG_BACKUP_PATH (Required)
# This parameter points to a directory which should be used by the script
# to backup your configuration files.
# Additionally, this path is used to display the list of instance or
# configuration backups that can be restored.
config_backup_path=/scratch/ocs_home/infra/backup_restore/backups/config_files

# - DATABASE_BACKUP_PATH (Required for infrastructure)
# This is the path under which database backups are stored.
# If you want to backup the database to an ASM disk group then specify
# the disk group as in this example: database_backup_path=+DISKGROUP1
# (Path names beginning with '+' are assumed to be ASM paths).
database_backup_path=/scratch/ocs_home/infra/backup_restore/backups/db_files

# *************************** OPTIONAL PARAMETERS ****************************
# These parameters are set by the tool. The user can modify them if
# necessary.
# ****************************************************************************

# - CONFIG_FILE_LIST (Automatically set during configure)
# This parameter specifies the filenames which contains the lists of config
# files that need to be backed up and restored. Remove .inp files that do
# not apply. If you would like to include your own custom config files,
# add those to the end of the list AFTER running the tool w/ the configure
# option.
config_files_list=config_ohs_files.inp,config_oc4j_files.inp,config_sso_files.inp,config_oid_files.inp,config_das_files.inp,config_dip_files.inp,config_opmn_files.inp,config_dsa_files.inp,config_javaobjcache_files.inp,config_em_files.inp,config_dcm_files.inp,config_install_files.inp,config_logloader_files.inp,config_misc_files.inp

# - PLUGIN_CONFIG_FILES_LIST
plugin_config_files_list=DO_NOT_SET

# - ORAINST_LOC_PATH
# This parameter is used only by LOHA (Loss of Host Automation) operations on
# Unix platforms. It points to the location of oraInst.loc created by Oracle
# Universal Installer. It should be changed only if oraInst.loc is not in its
# default location.
orainst_loc_path=default

# - PFILE (Optional for infrastructure)
# This is your database parameter file, and is used when the database is
# restarted. Only set this parameter if you do not wish to use the default
# pfile/spfile.
# Note: Comment out the pfile line if it is not being set
# pfile=

# ***************************** SYSTEM PARAMETERS ****************************
# These parameters are saved by the tool. The user should not modify them.
# ****************************************************************************

# - INSTALL_TYPE (Automatically set during configure)
# This parameter lets the tool "know" what the install type is
# (e.g. Infrastructure or Midtier)
install_type=Infrastructure

# - REPOSITORY_TYPE (Automatically set during configure/backup)
# This parameter specifies the dcm repository type on this node
dcm_repository_type=database

# - ORACLE_HOME (Automatically set by the tool)
# This is your oracle_home setting.
# This parameter is automatically set when the tool is invoked through EM.
# When using command line interface, the user needs to set ORACLE_HOME in the
# environment before invoking the tool.
# All operations will assume that directories in $oracle_home, such
# as $oracle_home/bin, $oracle_home/opmn/bin, ... contain the necessary
# utilities.
# All configuration backup/recovery options will assume that the configuration
# files have to be backed up and restored to paths relative to this setting.
oracle_home=/scratch/ocs_home/infra

# - INSTANCE_NAME (Automatically set by the tool)
# This parameter contains the fully qualified instance name.
# The backup catalog file is saved in $config_backup_path/br_catalog under
# this name.
instance_name=ocsinfra.stade55.us.oracle.com

# - DBID (Automatically set during configure)
# This parameter is the database identifier, and is populated automatically
# when you run the script in the '-configure' mode. A subsequent attempt to
# recover the database uses this parameter
dbid=1093580787

# - ORACLE_SID (Automatically set by the tool)
# This parameter is automatically set during configure operation through EM.
# For an infrastructure, the command line user needs to set ORACLE_SID in the
# environment to point to the correct database instance.
oracle_sid=orcl

# - INFRA_WITH_PORTAL (Automatically set during configure/backup)
# This parameter indicates whether the instance is an infrastructure with
# portal mid-tiers registered. If so, portal schema validation utility will
# be run as part of backups.
infra_with_portal=yes

# --------------- Notes on configuration file backup/recovery ---------------
# Backup/recovery of configuration files depends on the setting of
# - 'config_files_list' specifies the list of files to be backed up or recovered
# - 'oracle_home' specifies the base directory for the location of the files
# specified in 'config_files_list'
# - 'config_backup_path' specifies the location where the configuration files
# should be backed up
# - 'config_backup_path' is also used in the 'restore_config' mode to provide
# the user with a list of configurations that can be restored