Oracle7 Enterprise Backup Utility Administrator's Guide Go to Product Documentation Library
Go to books for this product
Go to Contents for this book
Go to Index

Go to previous file in sequence Go to next file in sequence

Invoking EBU and Registering Target Databases

This chapter describes general Enterprise Backup Utility usage and explains how to register and update information about target databases in the EBU Catalog.

Topics covered in this chapter are:

Enterprise Backup Utility Usage

Overview for Using the Utility

You can use the Enterprise Backup Utility to make both online and offline backups. The following steps outline the procedure for using EBU, once you have completed setting it up (See Chapter 2, "Installing and Setting Up EBU").

Before invoking ebu for any operation, set the following environment variables:

You only need to register a target database if you do offline backups (before the first time and when configuration changes, or if you have more than one parameter file to be handled by EBU, or if you are not using INTERNAL as the user for the target database). Online registration is performed automatically by the utility. To register a database:

  1. Create a register command script.
  2. Invoke the script with the ebu command:
    $ ebu script_name

To back up a database:

  1. Create a backup command script.
  2. Invoke the script with the ebu command:
    $ ebu script_name

To restore a database, perform the following steps:

  1. Depending on the type of restore, either shut down the target database, or bring a tablespace/datafile offline.
  2. Create a restore command script.
  3. Invoke the script with the ebu command:
    $ ebu script_name

    The Enterprise Backup Utility builds a job list with the information in the EBU Catalog, then uses the media management software to retrieve backups from the appropriate media devices.

Recovering a database follows the same procedure as restoring, except that you must provide an additional specifier within the restore command script.


For a complete description of command scripts, see Appendix A, "Command Script Syntax", and Appendix B, "Command Script Examples" in this guide.


Invoking the Utility

For backup operations, the Enterprise Backup Utility can be invoked either from your command line interface, or from the interface of a media management product or administration tool like Oracle Enterprise Manager's Backup Manager. Registration operations must be invoked from the command line interface.

To invoke an EBU operation from the command line, enter the ebu command with the desired script name at the command prompt. For example:

$ ebu backondb_prod1

where backondb_prod1 might be the name of your script to perform an online backup of the database with the ORACLE_SID prod1, you have set ORACLE_HOME to point to your target database installation. Invoking the utility without any arguments returns the command usage:

ebu [ -ch[ecksum] | -t[est] ]
        [ -noa[utoregister] ]
        [ -s[ilent] ] 


ebu -u[pgrade] 

Command Line Options

The following command-line options may be specified with the ebu command at the command prompt:

Table 3-1 Options of the ebu Command
Option   Description  



Checksum: invokes the utility with file checksumming enabled for backups and restores. Cannot be used with the test specifier or -test command option.




Test: runs scripts without performing I/O operations. Use this specifier to verify that scripts work as expected. Test does not work with the register command, and cannot be used with the checksum command option or specifier.




Silent: suppresses output to screen when a log file has been specified. Note that a log file must be specified in the script when using this option. Syntax error messages are sent to standard error, even if the silent option has been set.




No autoregistration: disables the autoregistration feature for a particular job.




Upgrade: used only for upgrading the EBU Catalog from a prior release.


Specifying UNIX Path Names

On Unix systems, macro keys can be substituted for ORACLE_SID and ORACLE_HOME when entering the pathname of the parameter file(s) in command scripts. The @ character can be used for ORACLE_SID, and the ? character for ORACLE_HOME. For example, if you enter the following:


EBU interprets the ? and @ as the values of ORACLE_HOME and ORACLE_SID for the target database.


Macro keys cannot be used in the remap or remap_path specifier.


Specifying Path Names

The utility does not allow the use of wildcards or environment variables when specifying path names. For example, using syntaxes like *.dbf or $ORACLE_HOME in a command script results in an error, however, on NT the construct %<key>% can be used.

Registering a Target Database

Before performing an offline backup or a restore operation, the target database must be registered in the EBU Catalog. Registering the target database in the EBU Catalog stores essential structural information about the database, which the Enterprise Backup Utility uses in all backup and restore operations.

Once a database is initially registered, EBU maintains and updates the configuration information automatically during online backups, and verifies that it's up to date for offline backups. Changes which cause EBU to update target database configuration information include:

In an Oracle Parallel Server environment, all instances must be registered before running any restore or backup offline job.

Using the register Command

To register a target database or update configuration information, perform the following steps:

  1. Verify that the target database is online.
  2. Create a command script to register or update target database information in the EBU Catalog. See the following sections for examples of command scripts.
  3. Set ORACLE_SID and ORACLE_HOME from a command line prompt. A Bourne shell example follows:
    export ORACLE_HOME
    export ORACLE_SID

    From a C shell prompt (csh)

    setenv ORACLE_HOME /opt1/oracle
    setenv ORACLE_SID PROD

    From an NT DOS prompt:

    set ORACLE_HOME=/OPT1/oracle
  4. Invoke ebu by entering the following at either the UNIX shell prompt or NT DOS prompt, or from within your media management software:
    $ ebu script_name 

    where script_name is the name of the command script you created for the target database registration or reconfiguration.

If your backup strategy is to use backup offline database and restore database consistent, make sure you both register the new configuration and take an offline backup following any configuration changes in the target database.

Example 3-1 The following sample script uses the register command to register a target database

db_name = "PROD"
pfile = "?/dbs/init@.ora","?/dbs/include@.ora","?/dbs/config@.ora"
log = "/opt1/oracle/ebu/log/obkPROD.log"


EBU always takes the values of ORACLE_HOME and ORACLE_SID from the environment.


Additional Information:

For details on the syntax of the register command, see Appendix A, "Command Script Syntax" .


Target Database Specifiers

The following specifiers are used in the command script to identify the target database:

Table 3-2 Specifiers Used in the Command Script to Identify the Target Database
Specifier   Description  



The db_name specifier identifies the name of the target database. Its use is optional.




The pfile specifier is used to list one or more parameter files used by the target database. The parameter file information is optional for both registration and reconfiguration.



The Enterprise Backup Utility compares the active configuration of the target database with the most current configuration stored in the EBU Catalog before any backup if you are doing online backup. If the information in the EBU Catalog registration is outdated, the Enterprise Backup Utility automatically updates it before backing up the database. For offline backups EBU only checks the configuration. If -noa is used during offline backup, the configuration check is not performed. If you are doing offline backup or -noa, EBU aborts if the configuration is out of date.

Note that outdated configuration information is still maintained in the EBU Catalog. This allows you to restore your database to any point-in-time, regardless of configuration changes.

Though EBU autoregistration keeps target database information up-to-date, users can also update database configuration by invoking the register command manually.


Autoregistration can be disabled within an operation by the -noa command switch. See Appendix A, "Command Script Syntax" for more information on register command syntax.


EBU automatically uses the configuration appropriate to the point in time to which you are restoring the database. For all restores where a specific time is not specified, the utility uses the current configuration stored in the EBU Catalog. For point-in-time restores, EBU uses the configuration which was active at the specified time.


The Enterprise Backup Utility does not automatically update the EBU Catalog following a point-in-time restore. If you restore a database to a previous configuration, you should use the register command to update the database information in the EBU Catalog. (EBU will update the configuration information automatically at the next online backup, if you choose not update the information at this point.)


Additional Information:

See Chapter 7, "The EBU Catalog" for details on the information stored in the EBU Catalog.


Invoking obackup for pre-2.2 Compatibility

EBU 2.2's invocation differs from that of EBU 2.1 and prior versions. In 2.2, ebu uses your environment settings for ORACLE_SID and ORACLE_HOME. This was done for consistency with all other Oracle products and more intuitive behavior, and allowed many user-friendly enhancements to be made in 2.2. See obackup restrictions below for details.

Oracle recommends that you convert your environment and scripts to use the ebu executable directly as soon as possible. The steps to doing this are as follows:

  1. Edit your shell script which calls obackup:
  2. Edit the OBACKUP/EBU command scripts.

    Comment or delete ORACLE_SID and ORACLE_HOME settings from the script.

If you have problems converting to ebu from obackup in EBU Release 2.2, please call Oracle Support for assistance.

obackup Restrictions

obackup restrictions are the following:

obackup usage: obackup [-n] [obackup options] [ebu script]

Troubleshooting Target Database Connect Problems

Go to previous file in sequence Go to next file in sequence
Prev Next
Copyright © 1997 Oracle Corporation.
All Rights Reserved.
Go to Product Documentation Library
Go to books for this product
Go to Contents for this book
Go to Index