|
Oracle® Application Server Administrator's Guide
10g Release 2 (10.1.2) Part No. B13995-01 |
|
 Previous |
 Next |
|
Oracle® Application Server Administrator's Guide
10g Release 2 (10.1.2) Part No. B13995-01 |
|
|
Previous |
Next |
This chapter describes how to install, configure, and use the Oracle Application Server Backup and Recovery Tool (OracleAS Backup and Recovery Tool).
It contains the following topics:
The Oracle Application Server Backup and Recovery Tool (OracleAS Backup and Recovery Tool) is a Perl script and associated configuration files you can use to backup and recover configuration files and the Metadata Repository in your Oracle Application Server environment. The types of files you can back up and recover using the tool are shaded in Figure 18-1.
Figure 18-1 Files You Can Backup and Recover Using OracleAS Backup and Recovery Tool
The tool can be used in different ways, depending on your level of experience and requirements:
At a minimum, all users can refer to the tool for the list of Oracle Application Server configuration files that must be backed up.
If you are new to backup and recovery, you can use the tool to perform configuration file and Metadata Repository backup and recovery.
If you are experienced with backup and recovery, you can refer to the tool for guidance when setting up your own configuration file and Metadata Repository backup and recovery scripts.
The Oracle Application Server Backup and Recovery Tool is installed as part of an Oracle Application Server installation. The tool is located in the Oracle_Home/backup_restore directory. Table 18-1 lists the files that may reside in the backup_restore directory.
Table 18-1 OracleAS Backup and Recovery Tool Files
| FileFoot 1 | Description |
|---|---|
bkp_restore.pl bkp_restore.sh bkp_restore.bat |
If you have installed TopLink or RepCA, run this Perl script.
A shell script used to run the Perl script on UNIX. A batch command file used to run the Perl script on Windows. |
config/config.inp |
The main configuration file that contains parameters for customizing the tool for your environment |
config/config_component_files.inp
|
Component configuration files—each contains a list of configuration files for a particular component. These specify which files to back up when performing a configuration file backup. |
*.tmpl
|
Templates for scripts for performing database backup and recovery operations using RMAN. When you initially configure the tool, a customized .dat file will be created from each .tmpl file.
|
*.sql
|
SQL scripts used by the tool to check the repository database. |
|
See Also: Oracle Application Server Installation Guide for information about installing the Oracle Application Server. |
If you are running TopLink, in standalone mode, or RepCA, in an existing database, you must install the OracleAS Backup and Recovery Tool manually. Before you install the OracleAS Backup and Recovery Tool, review the following notes:
You must install the tool on the same host as its corresponding installation. You can install the tool in the Oracle home of its corresponding installation, or you can install it into a directory outside of the Oracle home.
The tool is a Perl script that requires a Perl 5.6.1 interpreter, or later. You can obtain the interpreter from the Perl site: http://www.perl.org, or you can use the Perl interpreter that ships with Oracle Application Server:
On UNIX systems:
ORACLE_HOME/perl/bin/perl
On Windows systems:
ORACLE_HOME\perl\5.6.1\bin\MSWin32-x86\perl.exe
The tool requires that Java Runtime Environment (JRE) be installed. You can obtain JRE at: http://java.sun.com/j2se/desktopjava/jre/index.jsp.
To install the OracleAS Backup and Recovery Tool:
Log in as the user who installed Oracle Application Server.
Extract the backup_restore.jar from the backup.jar which is located in the directory: CD_ROM/stage/Components/oracle.iappserver.backup_restore/10.1.2.0.0/1/DataFiles/backup.jar, for example:
cd ORACLE_HOME
jar xvf
CD_ROM/stage/Components/oracle.iappserver.backup_restore
/10.1.2.0.0/1/DataFiles/backup.jar
If you install Oracle Application Server Metadata Repository Upgrade Assistant, then file backup_restore.jar is automatically extracted for you and put in directory ORACLE_HOME/utilities/backup
Once you have obtained backup_restore.jar, extract its contents into the Oracle home of the Toplink or RepCA installation. For example:
cd ORACLE_HOME jar xvf utilities/backup/backup_restore.jar
On UNIX, make sure the bkp_restore.sh file has execute permission, for example:
chmod 755 ORACLE_HOME/backup_restore/bkp_restore.sh
Familiarize yourself with the OracleAS Backup and Recovery Tool files, which are described in the Table 18-1. Instructions for editing the configuration files are in subsequent steps.
This section describes how to configure the OracleAS Backup and Recovery Tool. You must follow these steps for each installation in your environment.
|
Note for Windows Users: Do not use a rich text editor, such as WordPad, when editing files in the Backup and Recovery Tool directory. It inserts a return character at the end of each line that may cause the tool to fail. Oracle recommends that you use a basic text formatter, such as Notepad, instead. |
The tool writes out log files and backup files, and you must create the following directories to hold these.
Log file directory: (Middle tier and Infrastructure) This directory holds log files created by the tool. This directory should have several megabytes of space.
Configuration file backup directory: (Middle tier and Infrastructure) This directory holds configuration file backups. This directory should have several hundred megabytes of space.
Database backup directory: (Infrastructure only) This directory holds datafile and control files backups of the Metadata Repository, as well as archived redo logs. This directory should have several gigabytes of space.
Recommendations for creating these directories are as follows:
Create your backup directories on a file system on a separate disk and, if possible, a separate disk controller, than your Oracle Application Server Oracle home. This will give you the best chance of recovering data in the event of a hardware failure.
Make sure your backup directories are writable by the user that installed Oracle Application Server.
For example, to create a log file directory, configuration file backup directory, and database backup directory on /disk1:
On Unix:
mkdir -p /disk1/backups/log_files
mkdir -p /disk1/backups/config_files
mkdir -p /disk1/backups/db_files
cd /disk1/backups
chmod 755 log_files config_files db_files
chown OracleAS_user log_files config_files db_files
On Windows:
mkdir C:\backups\log_files mkdir C:\backups\db_files mkdir C:\backups\config_files
Edit config.inp and modify the parameters as described in Table 18-2. Notice that some of the instructions are different depending on whether this is a middle-tier or Infrastructure installation.
Table 18-2 Parameters in config.inp
| Parameter | Value |
|---|---|
oracle_home
|
Specify the full path of the Oracle home. |
log_path
|
Specify the full path of the log file directory. |
config_files_list
|
Do not insert a value for this; leave it as config_files_list=DO_NOT_SET.
This parameter will be updated with the appropriate list of configuration files for your installation when you run |
config_backup_path
|
Specify the full path of the configuration file backup directory. |
install_type
|
Do not insert a value for this; leave it as install_type=DO_NOT_SET.
This parameter is updated with the appropriate value for your installation when you run |
dbid
|
Do not insert a value for this; leave it as dbid=DO_NOT_SET.
For Infrastructure installations, this value will be updated when you run For middle-tier installations, this value will stay untouched. |
pfile
|
Middle-tier Installation:
Leave this line commented out. Infrastructure: If desired, specify an alternate pfile to use when starting up the database. Otherwise, leave the line commented out and the default spfile will be used:
Be sure to leave the If the spfileorcl.ora file is not present at the default location, the following file will be used as pfile: For UNIX: For Windows: If you want to use a different pfile, specify an alternate pfile name for starting up the database. |
database_backup_path
|
Middle-tier Installation:
Do not insert a value for this; leave it as Infrastructure: Specify the full path of the database backup directory. |
Set the ORACLE_HOME environment variable to the Oracle Application Server Oracle home.
If this is an Infrastructure installation:
Set the ORACLE_SID environment variable to the Metadata Repository SID. The default is orcl.
Make sure the Metadata Repository is started.
Configure the tool by running it with the -m configure option, for example:
For UNIX systems:
./bkp_restore.sh -m configure
For Windows systems:
bkp_restore.bat -m configure
For TopLink or RepCA installations on UNIX or Windows, after specifying the correct version of perl.exe, run:
bkp_restore.pl -m configure
This updates parameters in config.inp and, in the case of an Infrastructure, creates customized .dat files, which are used to backup, restore, and recover the Metadata Repository.
You are now ready to use the OracleAS Backup and Recovery Tool.
As shipped, the OracleAS Backup and Recovery Tool backs up all of the Oracle Application Server configuration files that are necessary to reconstruct an Oracle Application Server installation. You can customize the tool to include any additional files that you would like to back up regularly, or to exclude any configuration files you do not want to back up.
Before you customize the tool, you should understand how it works. When you use the tool to back up your configuration files, it:
Opens config.inp (unless another environment file was specified with the -e option) and retrieves config_files_list.
Attempts to open each file in config_files_list and exits with an error if it cannot open all of the files.
Examines the contents of config_exclude_files.inp. The tool will not attempt to back up the files listed in this file.
Walks through each file in config_files_list and examines the first entry in each file. This entry is the key file. The key file is used to determine if the component exists in this installation.
If the tool finds the key file, it knows the component is installed, and attempts to back up all of the entries in the file. It logs an error whenever it cannot find a file. For all other files that the tool does not find, a warning is issued and the backup continues.
If the key file does not exist, the tool does not attempt to back up any entries in the configuration file. It logs an error to the log file and skips to the next configuration file.
The configuration files are stored in jar files located in the directory specified by the config_backup_path parameter in the config.inp file. Two jar files are created, one for DCM-managed components and one for all the other components. The jar files are paired by the timestamp incorporated in each jar file name. For example:
config_bkp_2004-05-10_18-33-10.jar dcm_archive_2004-05-10_18-33-10.jar
Since the tool knows how to determine which configuration files exist in your installation, it is not necessary to customize the tool. However, you may want to customize the tool by:
You may want to add your own local configuration files or any other files you would like to back up regularly, such as log files
You may want to exclude files from being backed up
To add a files, such as Oracle Application Server component specific log files, to a backup, add entries to the config_misc_files.inp file as follows:
To specify a particular file:
${OH}/directorypath/file
To specify an entire directory:
${OH}/directorypath/
To use wildcards:
${OH}/directorypath/*.html
You can add as many entries as you like. The config_misc_files.inp file is always included in the config_files_list in parameter in config.inp, so there is no need to edit config.inp.
Note that you do not need to specify a key file in config_misc_files.inp.
Excluding Files from a Backup
You can exclude files from a backup in either of the following ways:
You can simply remove the file entry from its config_component.inp file.
If you have a situation where a config_component.inp file specifies an entire directory to back up, and you would like to exclude a specific file from that directory, you can add an entry for that file to config_exclude_files.inp. The tool will back up the entire directory except for the file you specify. You cannot specify directories or use wildcards in config_exclude_files.inp—only single file entries are allowed.
Note that you do not need to specify a key file in config_exclude_files.inp.
This section summarizes usage for the OracleAS Backup and Recovery Tool.
It contains the following topics:
Before running the OracleAS Backup and Recovery Tool:
Log in as the user that installed Oracle Application Server.
Make sure the ORACLE_HOME environment variable is set.
If you are performing a database backup, make sure the ORACLE_SID environment variable is set. The default is orcl.
The syntax for the OracleAS Backup and Recovery Tool is:
On UNIX:
bkp_restore.sh [-defsv] -m mode [args]
On Windows:
bkp_restore.bat [-defsv] -m mode [args]
It accepts the following options:
-d Print a trace without executing.
-e Specify an environment file (default is config.inp).
-f Force log file, database backup, and configuration file directories to be created if they are required by the current command and do not exist.
-n Suppress prompts so the tool can be run in batch mode.
-s Run in silent mode.
-v Run in verbose mode.
Use the -m option to specify which mode to run. Some modes take arguments. Table 18-3 describes the OracleAS Backup and Recovery Tool modes and their arguments. All modes and arguments are case-sensitive.
Table 18-3 Oracle Application Server Backup and Recovery Tool Modes and Arguments
| Mode and Arguments | Description |
|---|---|
backup_cold
|
Performs a complete cold backup of the Metadata Repository.
For a DCM file-based Metadata Repository:
If both a metadata repository and a file based repository coexist in an application server instance, the To check whether a particular OracleAS instance hosts a file based repository or a database, use the following command: |
backup_cold_incr
|
Performs an incremental backup of the Metadata Repository.
Works the same as
There are two types of incremental backups, cumulative and differential. The tool uses the default type, which is differential. For more information, refer to Oracle Database Backup and Recovery Basics in the Oracle Database 10g Documentation Library. |
backup_config
|
Performs a full configuration backup. The backup includes the configurations for DCM managed components and non-DCM managed components.
Process Prerequisites: If the DCM repository type is a database, the following processes should be up:
To check whether a particular OracleAS instance hosts a file based repository or a database repository, use the following command: |
backup_config_incr
|
Performs an incremental configuration file backup.
Works the same as
For process prerequisites, refer to the |
backup_online
|
Performs an online backup of the Metadata Repository. If you are running this command on an Infrastructure, ensure that the Metadata Repository is up before running this command.
For a DCM file-based Metadata Repository:
If both a metadata repository and a file based repository coexist in an application server instance, the To check whether a particular OracleAS instance hosts a file based repository or a database, use the following command: |
backup_online_incr
|
Performs an incremental online backup of the Metadata Repository.
Works the same as
There are two types of incremental backups, cumulative and differential. The tool uses the default type, which is differential. For more information, refer to Oracle Database Backup and Recovery Basics in the Oracle Database 10g Documentation Library. |
configure
|
Configures the tool.
When using this on an Infrastructure, make sure the Metadata Repository is up before you run this command.
|
configure_nodb
|
Same as "configure" but does not perform the Infrastructure configuration.
Note: You should use " |
help
|
Prints a usage message. |
list_changed_config
|
Lists any configuration files that have changed since the last full or incremental backup. This command checks the modification date of each file; it doesn't check the actual contents of the file. It writes the list of files to a log file and prints the name of the log file. |
restore_config
[ |
Restores configuration files.
The For the process prerequisites, refer to the Do not run |
restore_db
|
This command is deprecated. Use restore_repos instead.
|
restore_repos
|
Restores and recovers the Metadata Repository and the DCM file-based repository from the available cold and online backups. To perform restore_repos, the Metadata Repository database must be started and open. The command performs the following operations:
By default, this command restores and recovers the database to its most recent state. You can use the On UNIX: bkp_restore.sh -m restore_repos -u 07/26/2003_13:45:06 On Windows: bkp_restore.bat -m restore_repos -u 07/26/2003_13:45:06 By default, this command does not restore the control file. You can use the If you use the The Refer to Section 20.2.4, "Restoring and Recovering the Metadata Repository" for more information. This command performs the following operations to restore a file-based repository:
On UNIX: bkp_restore.sh -m restore_repos -t 2004-05-10_18-33-12 On Windows: bkp_restore.bat -m restore_repos -t 2004-05-10_18-33-12 If both the metadata repository and a file based repository coexist in an application server instance, the |
flashback_repos
|
Rewinds the Metadata Repository to a specified time by using the before images of changed data blocks to back out changes made to the database since the specified time. To perform flashback, the Metadata Repository database must be started and open. The command performs the following operations:
Flashback requires a database repository. Flashback is not supported on file-based repositories. You do not need to perform a cold backup before running flashback. Flashback does not require restoring previous backups in order to recover the database. This means the flashback_repos operation is faster than the restore_repos operation. Flashback can undo any logical data corruption or user error, such as deleting an Oracle Application Server scheme or undeploying an application by mistake. To perform flashback, the database must be in configured with a Flash Recovery Area, and ARCHIVELOG mode and Flashback must be enabled. Use the following SQL statements to configure and enable Flashback: ALTER SYSTEM SET DB_RECOVERY_FILE_DEST_SIZE = <size> SCOPE=BOTH SID='*';
ALTER SYSTEM SET DB_RECOVERY_FILE_DEST = <directory_path> SCOPE=BOTH SID='*';
Refer to the Oracle Database Backup and Recovery Basics manual, Chapter 3, the section on "Setting up a Flash Recovery Area for RMAN" for more detail. Also, refer to Section 19.2.2, "Enabling ARCHIVELOG Mode" in this manual for information on enabling ARCHIVELOG mode. Either the -u or -b option must be specified. The -u option returns the database to its state at the specified time. The -b option returns the database to its state prior to the specified time. The format for the timestamp is
The -n option suppresses prompts so the tool can be run in batch mode. For more information on Flashback technology, refer to the Oracle Database Backup and Recovery Advanced User's Guide. After running flashback_repos, do a full backup immediately because all past backups are invalidated. See Section 20.2.4, "Restoring and Recovering the Metadata Repository" for more information. |
This section contains usage examples for the OracleAS Backup and Recovery Tool. The Unix command is listed first and then the Windows command.
Configure the tool using the default config.inp file:
bkp_restore.sh -m configure bkp_restore.bat -m configure
Configure the tool using a configuration file called myconfig.inp:
bkp_restore.sh -m configure -e myconfig.inp bkp_restore.bat -m configure -e myconfig.inp
Perform a full configuration file backup:
bkp_restore.sh -v -m backup_config bkp_restore.bat -v -m backup_config
Perform a full configuration file backup using an environment file called myconfig.inp:
bkp_restore.sh -v -m backup_config -e myconfig.inp bkp_restore.bat -v -m backup_config -e myconfig.inp
Perform an incremental configuration file backup:
bkp_restore.sh -v -m backup_config_incr bkp_restore.bat -v -m backup_config_incr
Restore configuration files.
bkp_restore.sh -m restore_config -t 2004-09-21_06-12-45 bkp_restore.bat -m restore_config -t 2004-09-21_06-12-45
Perform a full cold backup of the Metadata Repository:
bkp_restore.sh -m backup_cold bkp_restore.bat -m backup_cold
Perform a level 2 incremental cold backup of the Metadata Repository:
bkp_restore.sh -m backup_cold_incr -l 2 bkp_restore.bat -m backup_cold_incr -l 2
Perform an full online backup of the Metadata Repository:
bkp_restore.sh -m backup_online bkp_restore.bat -m backup_online
Perform a level 0 incremental online backup of the Metadata Repository:
bkp_restore.sh -m backup_online_incr -l 0 bkp_restore.bat -m backup_online_incr -l 0
Restore the Metadata Repository to its most recent state:
bkp_restore.sh -m restore_repos bkp_restore.bat -m restore_repos
Restore the Metadata Repository to its state at a particular time:
bkp_restore.sh -m restore_repos -u 07/26/2003_13:45:06 bkp_restore.bat -m restore_repos -u 07/26/2003_13:45:06
Flashback the Metadata Repository to its state at a particular point in time:
bkp_restore.sh -m flashback_repos -u 07/26/2003_13:45:06 bkp_restore.bat -m flashback_repos -u 07/26/2003_13:45:06
Restores the file based repository to its state at a particular time:
bkp_restore.sh -m restore_repos -t 2004-05-10_18-33-12 bkp_restore.bat -m restore_repos -t 2004-05-10_18-33-12
