Contents

List of Examples

List of Figures

List of Tables

Title and Copyright Information

Preface

Audience

Documentation Accessibility

Structure

Conventions

1 Introduction to Oracle Universal Installer

System Requirements

Key Features

Utilities

Oracle Universal Installer

OPatch

Actions Performed by the Utilities

Installation

Deinstallation

Cloning

Patching

Upgrades and Patchsets

Adding Nodes

Inventory Operations

Attaching Oracle Homes

Detaching Oracle Homes

Updating the Node List

Major Entities Created

Inventory

Oracle Home

Modes of Installation

Interactive Mode

Suppressed-Interactive Mode

Silent Mode

Cluster Mode

2 Managing Oracle Homes

Introduction to Oracle Homes

Installing an Oracle Product

Removing Oracle Homes

Determining the Default Oracle Home

Multiple Oracle Homes

Target Home

Oracle Universal Installer Inventory

Structure of the Oracle Universal Installer Inventory

Central Inventory Pointer File

Central Inventory

Oracle Home Inventory

Creating the Central Inventory

Using the Session Variables

Verifying the Operation

Detaching Oracle Homes from the Central Inventory

Using Optional Flags

Removing the Central Inventory

Consolidating Multiple Central Inventories

Upgrading and Patching the Oracle Home

Cloning Oracle Homes

Backing up the Inventory

Recovering from Inventory Corruption

Diagnosing and Recovering from Central Inventory Corruption

Diagnosing and Recovering from Oracle Home Inventory Corruption

Real Application Clusters

Updating the Nodes of a Cluster

Diagnosing and Recovering from RAC Oracle Home Inventory Corruption

Home Selector (Available on Win32 Platforms)

Home Selector Overview

How Home Selector Works

Oracle Home Directory Structure for Windows Platforms

Optimal Flexible Architecture Directory Structure (on UNIX)

ORACLE_BASE Directory

ORACLE_HOME Directory

3 Customizing and Creating Response Files

About Response Files

What Is a Silent Installation?

What Is a Response File?

Why Perform a Silent Installation?

Modifying a Response File

Creating a Response File With Record Mode

Using Record Mode

Response File Format

Variable Values

Variable Lookup Order

Setting the Recommendation Value

Comments

Headers

Response File Parameters

Installing with a Response File

Specifying a Response File

Optional Parameters When Specifying a Response File

Setting Response File Variables From the Command Line

Specifying the Value of a Session Variable

Specifying the Value of a Component Variable

4 Installing Products

Checking Prerequisites Before Installation

Installing Oracle Products

Getting Help While Installing Oracle Products

About the ORAPARAM.INI File

Modes of Installation

Installation Media

Installing from a Single CD-ROM

Installing from Multiple CD-ROMs

Installing from a staged HTTP location

Special Instructions for UNIX Users

Failed to Connect to Server Error

Providing a UNIX Installer Location with Root Privileges

Providing a UNIX Group Name

Deinstalling Oracle Products

Removing Oracle Products and Oracle Homes

Deinstalling Top-level Products That Have Dependents

Silent Deinstallation

Immediately Displaying the Inventory Dialog Box

Hiding the Inventory Dialog Box

Hiding the Deinstallation Confirmation and Progress Dialog Boxes

Running Oracle Universal Installer After Installation

Starting Oracle Universal Installer

Command Line Arguments

Using Oracle Universal Installer Exit Codes

Cloning Considerations

About Oracle Universal Installer Log Files

5 Installing Cluster Environments

Oracle Universal Installer and Real Application Clusters

Oracle Clusterware

Installed Real Application Clusters Components

General System Installation Requirements for Real Application Clusters

Hardware Requirements for Real Application Clusters Setup

Software Requirements for Real Application Clusters Setup

Cluster Setup and Pre-installation Configuration Tasks for Real Application Clusters

Pre-installation Tasks for Real Application Clusters on UNIX

Logging In to the System as root

Creating Required UNIX Groups and Users

Creating Identical Users and Groups on Other Cluster Nodes

Configuring SSH on all Cluster Nodes

Configuring the Oracle User Environment

Checking the Hardware Requirements

Checking the Network Requirements

Network Hardware Requirements

Network Parameter Requirements

IP Address Requirements

Node Time Requirements

Checking Software Requirements

Configuring Kernel Parameters

Identifying Required Software Directories

Oracle Base Directory

Oracle Inventory Directory

Oracle Clusterware Home Directory

Oracle Home Directory

Identifying or Creating an Oracle Base Directory

Creating the Clusterware Home Directory

Pre-installation Tasks for Real Application Clusters on Windows

Checking Hardware and Software Certification

Checking the Hardware Requirements

Hard Disk Space Requirements

Checking the Software Requirements

Checking the Network Requirements

Network Hardware Requirements

IP Address Requirements

Checking Individual Component Requirements

Configuring Storage for Oracle Clusterware

Installing Oracle Clusterware on UNIX

Running the Oracle Universal Installer to Install Oracle Clusterware

Running the Oracle Universal Installer in Silent Mode to Install Oracle Clusterware

Oracle Clusterware Background Processes

Installing Oracle Clusterware on Windows

Running the Oracle Universal Installer to Install Oracle Clusterware

Running the Oracle Universal Installer in Silent Mode to Install Oracle Clusterware

Oracle Clusterware Background Processes

Adding More Nodes to the Cluster for Mass Deployment

Installing Product Software on a Cluster

Cluster Detection

Availability Checking

Cluster Installation

Cluster Installation in Silent Mode

Cluster Deinstallation

Command Line Options for Cluster Installations (UNIX Only)

Patchsets and Upgrades

Post-installation Tasks

Verification

Back Up Disk after Installation

Download and Install Patches

Configure Oracle Products

Deinstalling Real Application Clusters Software

Deinstalling Oracle Product Software on UNIX

Deinstalling Oracle Product Software on Windows

Deinstalling Oracle Clusterware

Deinstalling Oracle Clusterware from a UNIX Environment

Deinstalling Oracle Clusterware from a Windows Environment

Converting Single-instance Nodes to Real Application Clusters

Troubleshooting Real Application Clusters / Oracle Clusterware Installation

6 Cloning Oracle Software

About Cloning

Overview of the Cloning Process

Source Preparation Phase

Cloning Phase

Locating and Viewing Log Files

Cloning an Oracle Database 11.1 Oracle Home

Preparing the 11.1 Oracle Database Source

Cloning an 11.1 Oracle Database

Viewing Log and Error Files

Cloning Oracle Clusterware and Oracle Real Application Clusters Homes

7 Patching Oracle Software with OPatch

About OPatch

OPatch Features

Getting Interim Patches

Environment Variables OPatch Uses

Requirements for OPatch

Prerequisite Checks for OPatch

Checks for Single Instances and Real Application Clusters

Additional Checks for Real Application Clusters

Check for User Equivalence

Check for OPatch Lsinventory

Backup and Recovery Considerations for Patching

OPatch Utility for OUI-based Oracle Homes

Apply Command for OUI-based Oracle Homes

Napply Command for OUI-based Oracle Homes

Lsinventory Command for OUI-based Oracle Homes

Query Command for OUI-based Oracle Homes

Rollback Command for OUI-based Oracle Homes

Nrollback Command for OUI-based Oracle Homes

Version Command for OUI-based Oracle Homes

Standalone Patching

Unsupported Services for Standalone Patching

Standalone Patching Requirements

OPatch Utility for Standalone Homes

Apply Command for Standalone OPatch

Lsinventory Command for Standalone OPatch

Query Command for Standalone OPatch

Rollback Command for Standalone OPatch

Version Command for Standalone OPatch

Use Cases

Inventory Operations

Patching Operations

Utility Operations

Schema Patching

Schema Patching Options

Standalone SQL Execution

Online Patching

Real Application Clusters Patching

All Node Patching

Rolling Patching

Minimum Downtime Patching

About Patch Conflicts

Types of Conflicts

Superset

Subset

Duplicate

Bug Conflict

File Conflict

Patch Conflict Behavior for Apply and Napply

Patch Conflict Detection and Resolution

Problem Resolution

Logging and Tracing

Command Index

Levels of Logging

Recovering from a Failed Patching Session

Single Instance Setup

Real Application Clusters Setup

Resolving OPatch Application Errors

8 Oracle Internationalization and Translation

Installation Dialogs Language

Product Language Selections

Language Add-on

A Frequently Asked Questions

Oracle Universal Installer

OPatch

B Troubleshooting and Debugging Oracle Universal Installer

Debugging Mechanisms in Oracle Universal Installer

Installation Log

Automated Inventory Backups

Central Inventory Backup

Oracle Home Inventory Backup

Oracle Universal Installer Errors

Other Tips

C Understanding Oracle Universal Installer Commands

Options Available in Oracle Universal Installer

Command-line Variables Available in Oracle Universal Installer

D Sample Files

Sample Response File

Sample ORAPARAM.INI File

Sample Components File

Index

List of Examples

7-1

7-2

List of Figures

5-1 Troubleshooting Real Application Clusters / Oracle Clusterware Installation

7-1 All Node Patching

7-2 Rolling Patching

7-3 Minimum Downtime Patching

B-1 Setting Exceed's Window Manager to "Native"

List of Tables

2-1 Oracle Installation Settings for Specify Home Details page

2-2 ARU_IDs for Platforms

2-3 Other Folders in the Oracle Home Inventory

2-4 Oracle Home Directory for Windows Platforms

2-5 Sample ORACLE_BASE Directory Structure and Content

2-6 Sample Oracle Home Directory Structure and Content

3-1 Variable Types and Representations

4-1 Command Line Parameters for Prerequisite Checks

4-2 Parameters in oraparam.ini

6-1 Command-line arguments in the clone.pl script

7-1 OPatch OUI-based Commands

7-2 Apply Options for OUI Patches

7-3 Napply Options for OUI Patches

7-4 Lsinventory Options for OUI Patches

7-5 Query Options

7-6 Rollback Options for OUI Patches

7-7 Nrollback Options for OUI Patches

7-8 OPatch Standalone Commands

7-9 Apply Options for Standalone Patches

7-10 Lsinventory Options for Standalone Patches

7-11 Query Options

7-12 Rollback Options for Standalone Patches

7-13 Getting Patch Information

7-14 Getting Detailed Patch Information

7-15 Applying an Interim Patch - Case 1

7-16 Applying an Interim Patch - Case 2

7-17 Applying an Interim Patch - Case 3

7-18 Rolling Back an Applied Interim Patch

7-19 Loading an Arbitrary XML File

7-20 Verifying that the Patch is Applied

7-21 Schema Patching Options

7-22 Expected Behavior for Apply and Napply Commands

8-1 Oracle Universal Installer Translated Languages

C-1 Options in Oracle Universal Installer

C-2 Command Line Variables in Oracle Universal Installer

Oracle® Universal Installer

and OPatch User's Guide

11g Release 1 (11.1) for Windows and UNIX

E12255-01

December 2008

Oracle Universal Installer and OPatch User's Guide, 11g Release 1 (11.1) for Windows and UNIX

E12255-01

Copyright © 1996, 2008, Oracle. All rights reserved.

Primary Author:  Michael Zampiceni

Contributor:  Sudip Datta, Pradeep Kumar Itharaju, Bharat Paliwal, Phidien Nguyen, Vijay Sriram

The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited.

The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose.

If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software—Restricted Rights (June 1987). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any damages caused by such use of the Programs.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party.

Preface

This manual describes how to manage Oracle and third-party software using the Oracle Universal Installer and OPatch. This guide provides instructions for installing, setting up, and starting the Oracle Universal Installer software. It also provides instructions on cloning and patching Oracle software.

Audience

This manual is intended for users installing Oracle software products using the Oracle Universal Installer and covers only the generic functionality and concepts. Use this manual in conjunction with any product-specific installation guides available with your Oracle product.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/.

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

TTY Access to Oracle Support Services

Oracle provides dedicated Text Telephone (TTY) access to Oracle Support Services within the United States of America 24 hours a day, 7 days a week. For TTY support, call 800.446.2398. Outside the United States, call +1.407.458.2479.

Structure

This manual contains the following chapters and is organized as follows:

Chapter 1, "Introduction to Oracle Universal Installer"

This chapter contains overview information on Oracle Universal Installer.

Chapter 2, "Managing Oracle Homes"

This chapter contains information on how you can manage Oracle homes and Oracle inventory using Oracle Universal Installer.

Chapter 3, "Customizing and Creating Response Files"

This chapter contains information on how you can perform a silent installation using response files in the Oracle Universal Installer.

Chapter 4, "Installing Products"

This chapter contains information on the prerequisites for installation and how you install and remove Oracle products.

Chapter 5, "Installing Cluster Environments"

This chapter contains information on Oracle Clusterware and Real Application Clusters installation.

Chapter 6, "Cloning Oracle Software"

This chapter contains information on Oracle software cloning using Oracle Universal Installer. It also contains the steps to perform a database cloning, Oracle Clusterware cloning, and Real Application Clusters cloning.

Chapter 7, "Patching Oracle Software with OPatch"

This chapter contains information on applying interim patches to Oracle products using the Oracle proprietary tool — OPatch.

Chapter 8, "Oracle Internationalization and Translation"

This chapter contains information on the various languages in which Oracle produces software.

Appendix A, " Frequently Asked Questions"

This appendix contains frequently asked questions on Oracle Universal Installer and OPatch.

Appendix B, " Troubleshooting and Debugging Oracle Universal Installer"

This appendix contains information on how you can troubleshoot Oracle Universal Installer.

Appendix C, "Understanding Oracle Universal Installer Commands"

This appendix contains information on Oracle Universal Installer commands.

Appendix D, "Sample Files"

This appendix contains a sample response file, a sample components file and ORAPARAM.INI file.

Conventions

The following text conventions are used in this document:

Convention | Meaning
boldface | Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.
italic | Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.
monospace | Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

1 Introduction to Oracle Universal Installer

This chapter is designed to aid developers, administrators, and all other users who install Oracle software by understanding the system requirements, features, and key concepts of Oracle Universal Installer.

This chapter includes the following sections:

System Requirements

Key Features

Utilities

Actions Performed by the Utilities

Major Entities Created

Modes of Installation

System Requirements

The minimum system requirements for Oracle Universal Installer are as follows:

Java Runtime Environment (JRE) — Automatically installed with Oracle Universal Installer on most platforms. Check the Release Notes or installation guide of the products that you are installing for the required version.

Memory Requirements — Memory requirements vary depending on the number of components installed. Check the Release Notes or installation guide for the products that you are installing for details. 32 MB is the minimum recommended on all platforms.

Disk Space Requirements — Oracle recommends at least 60 MB for Oracle Universal Installer files on Windows platforms and 70 MB on UNIX. (UNIX requires more memory because of the difference in JRE sizes for the platforms.) You may need up to 1 MB for the related inventory files.

When you run Oracle Universal Installer from an NFS-mounted user home, especially for Linux, execute the quota command to check the space availability. Never perform an installation on a user home for which space is allocated based on quota.

Key Features

Oracle Universal Installer 11g Release 1 (11.1) offers the following features:

An XML-based centralized inventory.

The XML format allows third-party Java applications to query the inventory for information about installed software. For backward compatibility, the Central Inventory continues to maintain the binary versions as well.

Cloning of existing Oracle homes.

Allows you to copy an existing Oracle home to another location and "fix it up" by updating the installation configuration to be specific to the new environment. Cloning makes it easy to propagate a standard setup without having to install and configure installation after installation.

Better support for cluster environments.

Oracle Universal Installer now replicates its inventory to all nodes that participate in a cluster-based installation. You can invoke Oracle Universal Installer from any node on the cluster that is part of the installation. You can then upgrade, remove, or patch existing software from any node.

True silent capability.

When running Oracle Universal Installer in silent mode on a character mode console, you no longer need to specify an X-server or set the DISPLAY environment variable on UNIX. No GUI classes are instantiated, making the silent mode truly silent.

Ability to record your Oracle Universal Installer session to a response file.

This feature makes it easy to duplicate the results of a successful installation on multiple systems. All the options you selected during the installation are saved in the resulting response file. For information about recording your Oracle Universal Installer sessions, see "Creating a Response File With Record Mode".

More accurate disk space calculations.

Oracle Universal Installer now uses a more accurate method of calculating the disk space your Oracle products require. This feature reduces the risk of running out of disk space during an installation.

Automatically launched software after installation.

Some Oracle products now take advantage of a new feature that allows the software to launch automatically immediately after the installation.

Cleaner deinstallation and upgrades.

Deinstallation completely removes all software, leaving no "bits" behind. This also completely removes files associated with configuration assistants and patchsets. Oracle homes can also be removed from the inventory and registry.

Integrated prerequisite checking.

Provides a prerequisite checking tool to diagnose the readiness of an environment for installation. The prerequisite checks are run as part of the installation process, but can also be run as a separate application.

Support for single-click installation.

Provides a facility where you can perform single-click installations for certain products for basic configurations. You also have an advanced mode for more options.

Utilities

Oracle offers two utilities for software deployment:

Oracle Universal Installer to install Oracle products

OPatch to apply interim patches

Oracle Universal Installer

Oracle Universal Installer 11g Release 1 (11.1) is a Java-based installer that enables you to install Oracle components from CDs or from a staged HTTP location. It performs component-based installations as well as complex installations, such as integrated bundle and suite installations, and installations over the Web.

OPatch

OPatch is an Oracle-supplied utility that assists you with the process of applying interim patches to Oracle's software. OPatch 11.1 is a Java-based utility that can run on either OUI-based Oracle homes or standalone homes. It works on all operating systems for which Oracle releases software. For more information on OPatch, see Chapter 7, "Patching Oracle Software with OPatch".

Actions Performed by the Utilities

Oracle Universal Installer and OPatch performs the following activities:

Installation

Installation is the process of choosing products from a release or stage area and deploying them in the target directory. There are four modes of installation, which are explained in the section "Modes of Installation".

Deinstallation

Deinstallation is the process of removing an installed product from the installation area. A de-installation can be cancelled, resumed or rolled back. It can be executed either interactively or silently.

Cloning

Cloning is the process of copying an existing installation to a different location while preserving its configuration. You can install multiple copies of the Oracle product easily on different computers using cloning. During cloning, Oracle Universal Installer is invoked in clone mode to adapt the home to the target environment. Oracle Universal Installer in clone mode replays all the actions that have been executed to originally install the Oracle home. The difference between installation and cloning is that during cloning, Oracle Universal Installer runs the actions in the clone mode. Each action decides how to respond during cloning. For more information on cloning, see Chapter 6, "Cloning Oracle Software".

Patching

During patching, a small collection of files are copied over an existing installation to fix certain bugs. OPatch is an Oracle-supplied utility that facilitates Oracle software patching. For more information on OPatch, see Chapter 7, "Patching Oracle Software with OPatch".

Upgrades and Patchsets

Oracle Universal Installer enables you to upgrade a product from one version to another version. An upgrade is a major product enhancement that often requires installation of the upgraded software. For example, you may want to convert your Oracle Database 10gR2 (10.2) to Oracle 11gR1 (11.1) Database, which is called an upgrade.

A group of patches form a patchset. For example, you may want to convert your Oracle 11gR1 (11.1) Database from version 11.1.1 to version 11.1.2, which is called applying a patchset.

Adding Nodes

You can install an Oracle home on multiple nodes in a cluster. You can extend the cluster for a particular Oracle home using the -addNode flag of Oracle Universal Installer. You can add more than one node to the Oracle home. The Oracle Universal Installer with the -addNode flag is always run on the local node and not on the node(s) to be added. You can add nodes to an Oracle Clusterware node or a Real Application Clusters node depending upon whether the node addition is being performed at the Oracle Clusterware layer or the Real Application Clusters database layer. You can use $OH/oui/bin/addNode.sh to add nodes.

For more information on adding nodes, see "Installing Cluster Environments".

Inventory Operations

Oracle Universal Installer supports the following inventory operations:

Attaching Oracle Homes

Oracle Universal Installer uses the -attachHome flag to attach an Oracle home to the inventory to set up the Central Inventory or to register an existing Oracle home with the Central Inventory. You can use attachHome.sh (bat) from an Oracle home as well as from the shiphome.

For more information, see "Creating the Central Inventory".

Detaching Oracle Homes

Oracle Universal Installer uses the -detachHome flag to remove an Oracle home from the Central Inventory. You can use detachHome.sh (bat) from an Oracle home.

For more information, see "Detaching Oracle Homes from the Central Inventory".

Updating the Node List

Oracle Universal Installer uses the -updateNodeList flag to get the list of nodes and update the inventory.xml file. If the CRS flag is set to TRUE, then the oraclehomeproperties.xml file is updated with the Oracle Clusterware home information.

For more information, see "Updating the Nodes of a Cluster".

Major Entities Created

The following major entities are created when you run Oracle Universal Installer.

Inventory

The Oracle Universal Installer inventory stores information about all Oracle software products installed in all the Oracle homes on a host, provided the product was installed using Oracle Universal Installer. The inventory is organized as follows:

Central Inventory

Oracle home inventory

For more information on the inventory and the structure of the inventory, see "Oracle Universal Installer Inventory".

Oracle Home

An Oracle home is the system context in which the Oracle products run. This context consists of the following:

Directory location where the products are installed

Corresponding system path setup

Program groups associated with the products installed in that home (where applicable)

Services running from that home

For more information on Oracle homes, see Chapter 2, "Managing Oracle Homes".

Modes of Installation

You can run the Oracle Universal Installer in the following modes:

Interactive Mode

You can use the interactive mode to walk through the installation by providing information in the dialogs when prompted. This method is useful when installing a small number of products in different setups on a small number of hosts.

Suppressed-Interactive Mode

You can use this mode to supply the necessary information by using a combination of a response file or command line entries with certain interactive dialogs. This is useful when an installation has a common set of parameters that can be captured in a response file, in addition to the custom information that you must enter manually.

Silent Mode

You can use this mode to bypass the Graphical User Interface (GUI) and supply the necessary information in a response file. This method is useful when installing the same product multiple times on multiple hosts. By using the response files, you can also automate the installation of a product for which you know the installation parameters.

For more information on silent installation, see Chapter 3, "Customizing and Creating Response Files".

Cluster Mode

A cluster installation uses Oracle Universal Installer to install software on the nodes of a cluster that are network-reachable and bound together by Oracle Clusterware. You can use Oracle Universal Installer to extend the Oracle home of a product installation to include additional nodes on the cluster. You need to install Oracle Clusterware for a cluster installation.

For more information on cluster installations, see Chapter 5, "Installing Cluster Environments".

2 Managing Oracle Homes

This chapter contains the following sections:

Introduction to Oracle Homes

Installing an Oracle Product

Removing Oracle Homes

Determining the Default Oracle Home

Multiple Oracle Homes

Oracle Universal Installer Inventory

Home Selector (Available on Win32 Platforms)

Introduction to Oracle Homes

The Oracle Universal Installer supports the installation of several active Oracle homes on the same host. An Oracle home is a directory into which all Oracle software is installed. This is pointed to by an environment variable. The Oracle home consists of the following:

Directory location where the products are installed

Corresponding system path setup

Program groups associated with the products installed in the home (where applicable)

Services running from the home

Installing an Oracle Product

When you install an Oracle product, an Oracle home is created.

To install the product and create the Oracle home, perform the following steps:

Run Oracle Universal Installer.

In the Specify Home Details page, enter the Oracle home settings for the installation session. See Table 2-1 for a description of the fields in this section of the screen.

Continue with your installation. See Chapter 4, "Installing Products" for detailed information.

Table 2-1 Oracle Installation Settings for Specify Home Details page

Settings
Functions

Name

Enter a name for the Oracle home. This name identifies the program group associated with a particular home and the Oracle services installed on this home. The Oracle home name must be between 1 to 127 characters long, and can include only alphanumeric characters and underscores.

Path

Enter the full path to an Oracle home, or select an Oracle home from the drop-down list of existing Oracle homes. The Oracle home location is the directory where products are installed.

Data files may or may not be installed within an Oracle home. You can use the Browse button to choose a directory to install your product.

For Windows platforms, you must provide a valid path that is not in the Windows directory. Different homes cannot share the same location.

Note:

Oracle recommends that you designate an Oracle home location that is an empty or non-existing directory. If you select a directory for the Oracle home location that is not empty or already exists, you will be warned and asked if you want to proceed.

For silent installations, if a non-empty, existing directory is specified, an error is logged in the console and in the installActions<timestamp>.log file. Also, the Oracle Universal Installer aborts. To override this condition, use the -force flag on the command line. The effect of using the -force flag is the same as selecting Yes while installing in interactive mode. You receive a warning message, but the installation continues.

Removing Oracle Homes

To remove an existing Oracle home, invoke Oracle Universal Installer and click Deinstall Products. At the inventory dialog, select the homes you want to delete and click Remove. You can also use the REMOVE_HOMES variable in the command line or in a response file. The syntax is as follows:

./runInstaller -deinstall -silent ORACLE_HOME=<LOCATION_OF_ORACLE_HOME> "REMOVE_
HOMES={<LOCATION_OF_ORACLE_HOME_TO_BE_REMOVED>}"

Determining the Default Oracle Home

By default, when you start Oracle Universal Installer, the software searches your system to determine the default Oracle home where Oracle software should be installed.

In all cases, the ORACLE_HOME name is taken first from the command line if it is specified, or else from the response file if specified. If not, the following convention is used for the name:

Ora<short_marketing_name_in_oraparam.ini>_<home_identifier>

Where <short_marketing_name_in oraparam.ini> is the short product marketing name as specified in the oraparam.ini file; for example, "Db11g", and <home_identifier> is a counter derived from the Central Inventory. For example, the ORACLE_HOME name could be OraDb11g_1.

The ORACLE_HOME path is taken first from the command line if specified, or else from the response file if specified. If not, the ORACLE_HOME environment variable is used. If neither is specified, the following conventions are used for the path:

If ORACLE_BASE has been specified in the environment:

$ORACLE_BASE/product/<version>/<short_name>_<counter>

For example: $ORACLE_BASE/product/11.1.0/Db_1.

If ORACLE_BASE has not been specified in the environment:

$HOME/product/<version>/<short_name>_<counter>

Where <short_name> is the short product name; for example, "Db", and <counter> is picked up based on the existence of the files. For example, the ORACLE_HOME path could be $HOME/product/11.1.0/Db_1.

The instance-related directory location is accepted first from the response file, if specified. If not, the oradata, flash_recovery_area, admin, and doc directories are created under ORACLE_BASE. If ORACLE_BASE has not been specified, the default is the $ORACLE_HOME/oradata directory. If the parent directory of the Oracle home is writable, these directories are created in the parent directory of the Oracle home.

Multiple Oracle Homes

Oracle Universal Installer supports the installation of several active Oracle homes on the same host as long as the products support this at run-time. Multiple versions of the same product or different products can run from different Oracle homes concurrently. Products installed in one home do not conflict or interact with products installed on another home. You can update software in any home at any time, assuming all Oracle applications, services, and processes installed on the target home are shut down. Processes from other homes may still be running.

Target Home

The Oracle home currently accessed by Oracle Universal Installer for installation or deinstallation is the target home. To upgrade or remove products from the target homes, these products must be shut down or stopped.

Oracle Universal Installer Inventory

The Oracle Universal Installer inventory stores information about all Oracle software products installed in all Oracle homes on a host, provided the product was installed using Oracle Universal Installer.

Inventory information is stored in Extensible Markup Language (XML) format. The XML format allows for easier diagnosis of problems and faster loading of data. Any secure information is not stored directly in the inventory. As a result, during removal of some products, you may be prompted to enter the required credentials for validation.

Structure of the Oracle Universal Installer Inventory

The Oracle Universal Installer inventory has the following hierarchical structure:

Central Inventory Pointer File

Central Inventory

Oracle Home Inventory

Central Inventory Pointer File

Every Oracle software installation has an associated Central Inventory where the details of all the Oracle products installed on a host are registered. The Central Inventory is located in the directory that the inventory pointer file specifies. Each Oracle software installation has its own Central Inventory pointer file that is unknown to another Oracle software installation.

For Oracle homes sharing the same Central Inventory, the Oracle Universal Installer components perform all read and write operations on the inventory. The operations on the Central Inventory are performed through a locking mechanism. This implies that when an operation such as installation, upgrade, or patching occurs on an Oracle home, these operations become blocked on other Oracle homes that share the same Central Inventory.

The following list shows the location of the inventory pointer file for various platforms:

Solaris — /var/opt/oracle/oraInst.loc

Linux — /etc/oraInst.loc

Windows — The pointer is located in the registry key:

\\HKEY_LOCAL_MACHINE\\Software\Oracle\inst.loc

The following string shows an example of the path for the oraInst.loc file:

inventory_loc=/home/oracle_db11g/product/11.1.0/db_1inst_group=oracle

In UNIX, if you do not want to use the Central Inventory located in the directory specified by the inventory pointer file, you can use the -invPtrLoc flag to specify another inventory pointer file. The syntax is as follows:

./runInstaller -silent -invPtrLoc <Location_of_oraInst.loc> ORACLE_
HOME="<Location_of_Oracle_Home>" ORACLE_HOME_NAME="<Name_of_Oracle_Home>"

Note:

If the contents of the oraInst.loc file is empty, Oracle Universal Installer prompts you to create a new inventory.

Central Inventory

The Central Inventory contains the information relating to all Oracle products installed on a host. It contains the following files and folders:

Inventory File

Logs Directory

Inventory File

This file lists all the Oracle homes installed on the node. For each Oracle home, it also lists the Oracle home name, home index, and nodes on which the home is installed. It also mentions if the home is an Oracle Clusterware home or a removed Oracle home. It can only detect removed Oracle homes created using Oracle Universal Installer version 11.1 and later. This file is present in the following location:

<central inventory location>/ContentsXML/inventory.xml

The following code shows a sample inventory.xml file:

<?xml version="1.0" standalone="yes" ?>
<!-- Copyright (c) 2007 Oracle Corporation. All rights Reserved -->
<!-- Do not modify the contents of this file by hand. -->
<INVENTORY>
<VERSION_INFO>
   <SAVED_WITH>11.1.0.0.0</SAVED_WITH>
   <MINIMUM_VER>2.1.0.6.0</MINIMUM_VER>
</VERSION_INFO>
<HOME_LIST>
<HOME NAME="OraDb11g_home1" LOC="/home/oracle_db11g/product/11.1.0/db_1" TYPE="O" IDX="1"/>
<HOME NAME="OUIHome" LOC="D:\OraHome1" TYPE="O" IDX="2" />
<HOME NAME="OUIHome12" LOC="D:\OraHome12" TYPE="O" IDX="3" />
<HOME NAME="OUIHome1" LOC="D:\homes\OraHome1" TYPE="O" IDX="4" />
<HOME NAME="OUIHome11" LOC="d:\homes\oui11" TYPE="O" IDX="2" REMOVED="T" />
</HOME_LIST>
</INVENTORY>

Note:

Oracle recommends that you do not remove or manually edit this file as it could affect installation and patching.

Logs Directory

The Central Inventory contains installation logs in the following location:

<central inventory location>/logs

The logs directory contains the logs corresponding to all installations performed on a particular node. You can also find a copy of the installation log in the $ORACLE_HOME/cfgtoollogs directory.The installation logs for an installation are identified by the timestamp associated with the log files. These files are generally saved in the following format:

<Name_of_Action><YYYY-MM-DD_HH-MM-SS{AM/PM}>.log

For example, consider an attachHome operation performed on 17th, May, 2007 at 6.45AM. The associated log file would be created as follows:

AttachHome2007-05-17_06-45-00AM.log

Note:

The installation logs do not contain any errors or failures.

Oracle Home Inventory

Oracle home inventory or local inventory is present inside each Oracle home. It only contains information relevant to a particular Oracle home. This file is located in the following location:

$ORACLE_HOME/inventory

It contains the following files and folders:

Components File

Home Properties File

Other Folders

Components File

This file contains the details about third-party applications like Java Runtime Environment (JRE) required by different Java-based Oracle tools and components. In addition, it also contains details of all the components as well as patchsets or interim patches installed in the Oracle home. This file is located here:

ORACLE_HOME/inventory/ContentsXML/comps.xml

For an example of the components file, see "Sample Components File".

Home Properties File

This file contains the details about the node list, the local node name, and the CRS flag for the Oracle home. In a shared Oracle home, the local node information is not present. This file also contains the following information:

GUID — Unique global ID for the Oracle home

ARU ID — Unique platform ID. The patching and patchset application depends on this ID.

ARU ID DESCRIPTION — Platform description

The information in oraclehomeproperties.xml overrides the information in inventory.xml. This file is located here:

$ORACLE_HOME/inventory/ContentsXML/oraclehomeproperties.xml

The following example shows the Oracle home property file:

<GUID>893051798#.356758136</GUID>
   <HOME CRS="T"/>
   <ARU_PLATFORM_INFO>
      <ARU_ID>46</ARU_ID>
      <ARU_ID_DESCRIPTION>Linux x86</ARU_ID_DESCRIPTION>
   </ARU_PLATFORM_INFO>
   <CLUSTER_INFO>
      <LOCAL_NODE NAME="stacg30"/>
    <NODE_LIST><NODE NAME="stacg34"/><NODE
NAME="stacg30"/></NODE_LIST></CLUSTER_INFO>

Table 2-2 lists the ARU_IDs for some platforms:

Table 2-2 ARU_IDs for Platforms

Platform
ARU_ID

HPUX 64-bit

59

IBM 5L

212

Linux 32-bit

46

Solaris 32-bit

453

Solaris 64-bit

23

Windows XP

912

Other Folders

Table 2-3 lists the other folders you can find in the Oracle home inventory:

Table 2-3 Other Folders in the Oracle Home Inventory

Folder Name
Description

Scripts

Contains the scripts used for the cloning operation.

ContentsXML

Contains the details of the components and libraries installed.

Templates

Contains the template files used for cloning.

oneoffs

Contains the details of the one-off patches applied.

Creating the Central Inventory

Oracle Universal Installer enables you to set up the Central Inventory on a clean host or register an existing Oracle home with the Central Inventory when it is lost or corrupted. If the Central Inventory does not already exist, Oracle Universal Installer creates the Central Inventory in the location specified by the oraInst.loc file.

You can set up the Central Inventory by using the -attachHome flag of Oracle Universal Installer. The syntax is as follows:

./runInstaller -silent -attachHome -invPtrLoc ./oraInst.loc
ORACLE_HOME="<Oracle_Home_Location>" ORACLE_HOME_NAME="<Oracle_Home_Name>"
"CLUSTER_NODES={<node1,node2>}" LOCAL_NODE="<node_name>"

Using the Session Variables

You can use the following session variables:

ORACLE_HOME

ORACLE_HOME_NAME

CLUSTER_NODES

REMOTE_NODES

LOCAL_NODE

In a cluster installation:

If you do not pass the CLUSTER_NODES session variable, Oracle Universal Installer takes it from the $ORACLE_HOME/inventory/ContentsXML/oraclehomeproperties.xml file.

If you do not pass the LOCAL_NODE session variable, Oracle Universal Installer takes it from the $ORACLE_HOME/inventory /ContentsXML/oraclehomeproperties.xml file. If it does not find an entry there, it takes it from the Oracle Clusterware stack. If it is not able to find it in the stack, the first node of the CLUSTER_NODES is taken as the LOCAL_NODE.

You can pass the REMOTE_NODES variable if you want to specify the list of remote nodes. If you want to set up the Central Inventory in the local node, you need to pass the -local flag, and the REMOTE_NODES variable is empty. The syntax is as follows:

./runInstaller -silent -attachHome -invPtrLoc ./oraInst.loc
ORACLE_HOME="<Oracle_Home_Location>" ORACLE_HOME_NAME="<Oracle_Home_Name>"
"REMOTE_NODES={}" -local

Note:

When you use the -local flag, it performs the action on the local node irrespective of the cluster nodes specified.

For a non-Real Application Clusters setup, you do not need to pass the LOCAL_NODE variable, and the CLUSTER_NODES variable is empty. The syntax is as follows:

./runInstaller -silent -attachHome -invPtrLoc ./oraInst.loc
ORACLE_HOME="<Oracle_Home_Location>" ORACLE_HOME_NAME="<Oracle_Home_Name>"
"CLUSTER_NODES={}"

You can use the -local flag to attach the local Oracle home. If you are using a shared Oracle home with the -local flag, use the -cfs flag. This ensures that the local node information is not populated inside a shared Oracle home.

Verifying the Operation

After attaching the Oracle home, you can verify the success of the operation by verifying the contents of the log file present in the <central_inventory>/logs directory. You can also view the contents of the inventory.xml file under the <central-inventory>/ContentsXML directory to verify if the Oracle home is registered.

Note:

Oracle recommends cloning on Windows operating systems to create the Central Inventory.

Detaching Oracle Homes from the Central Inventory

You can detach an Oracle home from the Central Inventory. When you pass this flag, it updates the inventory.xml file present in the Central Inventory. The syntax is as follows:

./runInstaller -silent -detachHome -invPtrLoc ./oraInst.loc
ORACLE_HOME="<Oracle_Home_Location>" ORACLE_HOME_NAME="<Oracle_Home_Name>"

Using Optional Flags

You can use the -local flag to detach the Oracle home from the inventory of the local node. If you are using a shared Oracle home, use the -cfs flag. This ensures that the local node information is not populated inside a shared Oracle home.

./runInstaller -silent -local -cfs -detachHome -invPtrLoc ./oraInst.loc
ORACLE_HOME="<Oracle_Home_Location>" ORACLE_HOME_NAME="<Oracle_Home_Name>"

./runInstaller -silent -detachHome -invPtrLoc ./oraInst.loc
ORACLE_HOME="<Oracle_Home_Location>" ORACLE_HOME_NAME="<Oracle_Home_Name>"

You can completely clean the Oracle home and remove the home directory by using the -removeallfiles flag. The syntax is as follows:

./runInstaller -silent -deinstall -removeallfiles -invPtrLoc ./oraInst.loc
ORACLE_HOME="<Oracle_Home_Location>" ORACLE_HOME_NAME="<Oracle_Home_Name>"

If you want to disable the warning message that appears when you use the -removeallfiles flag, use the -nowarningonremovefiles flag. The syntax is as follows:

./runInstaller -silent -deinstall -nowarningonremovefiles -invPtrLoc ./oraInst.loc
ORACLE_HOME="<Oracle_Home_Location>" ORACLE_HOME_NAME="<Oracle_Home_Name>"

Removing the Central Inventory

Even after all the Oracle homes on a host are removed, you will find traces of the inventory with certain log files. If you do not want to maintain these files and want to remove the Central Inventory, do the following:

Removing the Central Inventory on UNIX Platforms

You can remove the Central Inventory on UNIX by performing the following steps:

Locate the oraInst.loc file and get the Central Inventory location (inventory_loc parameter) from this file.

For Solaris, this file is located in the /va/opt/oracle folder.

For Linux, this file is located in the /etc folder.

Remove the Central Inventory by executing the following command:

rm -rf <central_inventory_location>

Remove the oraInst.loc file by executing the following command with root privileges:

Solaris:

rm /va/opt/oracle/oraInst.loc

Linux:

rm /etc/oraInst.loc

Removing the Central Inventory on Windows Platforms

You can remove the Central Inventory on Windows by performing the following steps:

Locate the registry key:

\\HKEY_LOCAL_MACHINE\Software\Oracle\inst_loc

Get the Central Inventory location from this key.

Delete the Central Inventory directory and all its contents.

Delete the registry key:

\\HKEY_LOCAL_MACHINE\Software\Oracle\inst_loc

Consolidating Multiple Central Inventories

The following procedure explains how to consolidate multiple central inventories into a single central inventory. For CRS and RAC homes, perform this procedure for each node.

Identify the central inventory to use and ensure that it is the same path on all nodes of the cluster.

Go to this central inventory directory and run orainstRoot.sh to ensure that the oraInst.loc file points to this inventory.

Identify the other central inventories on the system, then identify the Oracle homes for each central inventory.

Do the following for each Oracle home:

Enter cd $ORACLE_HOME/oui/bin.

Run ./attachhome.sh -silent -local "CLUSTER_NODES={<List of nodes>}" LOCAL_NODE=<nodename>

For single instance homes, run ./attachhome.sh -silent.

Verify the inventory updates by going to the ORACLE_HOME/OPatch directory and running opatch lsinventory -detail.

Verify that the overall inventory is being updated by running ./runInstaller and clicking on 'Installed Products...' to bring up the contents of the central inventory. Ensure that the inventory shows the new home and the nodes.

Upgrading and Patching the Oracle Home

You can apply patchsets and upgrade an existing Oracle home. You can apply patchsets using Oracle Universal Installer. For more information on upgrading or applying patchsets for an Oracle product, refer to the respective Oracle product installation guide of the product that you want to upgrade.

Cloning Oracle Homes

You can clone an Oracle home using Oracle Universal Installer. For more information on cloning, see Chapter 6, "Cloning Oracle Software".

Backing up the Inventory

You can back up the Oracle home using your preferred method. You can use any method such as zip, tar, and cpio to compress the Oracle home.

It is highly recommended to back up the Oracle home before any upgrade or patch operation. You should also back up the Central Inventory when Oracle home is installed or deinstalled.

Example:

Consider a scenario where you have a Database Oracle home called DBHome that is registered with the default Central Inventory in the /product directory. You want to patch this database but decide to back up the database before patching.

Enter the following to back up the database:

cd /product/DBHome
tar cf - * | gzip > /product/archive/DBHome.tar.gz

If you are using a Win32 system, you could use WinZip to zip up the Oracle home. Do not use the jar command to zip the Oracle home, as this causes the file permissions to become lost.

Suppose you apply the patch and something goes wrong. You decide to delete the Oracle home from the Central Inventory and restore the original Oracle home. To delete the Oracle home from the Central Inventory, use the following command:

./runInstaller -silent -detachHome ORACLE_HOME="/product/DBHome"
ORACLE_HOME_NAME="DBHome"

On Win32 systems, the command would be:

setup.exe -silent -detachHome ORACLE_HOME="C:\product\DBHome"
ORACLE_HOME_NAME="DBHome"

Delete the Oracle home:

cd /product
rm -rf /product/DBHome

Restore the original Oracle home and update the Central Inventory. Restore the Oracle home to its original location using the following commands:

mkdir -p /product/DBHome
gunzip  <  /product/archive/DBHome.tar.gz | tar xf -

Attach this Oracle home to the Central Inventory:

./runInstaller -silent -attachHome ORACLE_HOME="/product/DBHome"
ORACLE_HOME_NAME="DBHome"

On Win32 systems, the command would be:

setup.exe -silent -attachHome ORACLE_HOME="C:\product\DBHome"
ORACLE_HOME_NAME="DBHome"

Recovering from Inventory Corruption

The inventory (Central and the Oracle home inventory) is critically important in the Oracle software life-cycle management. The following section explains what you need to do in case of inventory corruption.

Diagnosing and Recovering from Central Inventory Corruption

When you execute opatch lsinventory -detail or when you click Installed Products, the Oracle home does not appear.

Cause: The Oracle home may be missing from the Central Inventory, or the Central Inventory could be missing or corrupted.

Action: Do the following:

If the Oracle home is missing from the Central Inventory, perform an attach home operation on the missing Oracle home. The Central Inventory will be restored.

If the Central Inventory is missing or corrupted, restore the Central Inventory. If you have not backed up the Central Inventory, perform an attach home operation.

For more information on the attach home operation, see "Creating the Central Inventory".

If multiple entries are in the inventory.xml file for a given Oracle home, Inventory Collection from the Grid Control perspective would have issues. In this event, you should remove these duplicate entries manually.

Here are some examples of the kind of incorrect entries that could be there:

<HOME NAME="db11g" LOC="/product/db11g" TYPE="O" IDX="1"/>
<HOME NAME="oms11g" LOC="/product/em/oms11g" TYPE="O" IDX="2"/>
<HOME NAME="db11g" LOC="/product/db11g" TYPE="O" IDX="3"/>

In the above example, the first and third entries are duplicates. The Oracle home name and Oracle home location are identical. In this example, remove the third line.

Note that all duplicate inventory issues are caused by manual updates to the inventory.xml file. Use the OUI APIs to change the inventory.

Diagnosing and Recovering from Oracle Home Inventory Corruption

When you execute opatch lsinventory -detail or when you click Installed Products, the Oracle home appears, but the products and components within the Oracle home are not listed.

Cause: This may result because of a missing or corrupted Oracle home inventory.

Action: If the Oracle home inventory is missing or corrupted, restore the Oracle home inventory. If you have not backed up the Oracle home inventory, you may have to install the software on a different node with the same platform and install the same patch levels including interim patches. After that, you can simply copy the inventory directory from the patched Oracle home to the location of the affected Oracle home.

Note:

For Oracle Universal Installer version 10.2.0.2.0 and above, you can use the following scripts in Oracle home to recover from Oracle home inventory corruption:

detachHome.bat / detachHome.sh: Use this script if the Oracle home is corrupted or needs to be updated.

attachHome.bat / attachHome.sh: Use this script if the Oracle home needs to be added to the inventory.

For information on recovering from RAC Oracle home inventory corruption, see "Diagnosing and Recovering from RAC Oracle Home Inventory Corruption".

Real Application Clusters

In a Real Application Clusters environment, the inventory also contains a list of nodes associated with an Oracle home. It is important that during upgrade and patching, the inventory is correctly populated with the list of nodes.

For more information, see Chapter 5, "Installing Cluster Environments".

Updating the Nodes of a Cluster

When you use the -updateNodeList flag with the Oracle Universal Installer, it retrieves the list of nodes and updates the inventory.xml file. If the CRS tag is set to TRUE, the Oraclehomeproperties.xml file is updated with the Oracle Clusterware home information. For shared Oracle homes, you need to use this with the -cfs flag. The syntax is as follows:

./runInstaller -updateNodeList "CLUSTER_NODES={Node1,Node2}"
ORACLE_HOME="<Oracle_Home_Location>" ORACLE_HOME_NAME="<Oracle_Home_Name>"
LOCAL_NODE="Node_Name"

Note:

You update the nodes of a cluster only under exceptional circumstances. Oracle recommends that you perform this operation with the help of Oracle support.

Diagnosing and Recovering from RAC Oracle Home Inventory Corruption

When you execute opatch lsinventory -detail or when you click Installed Products, the Oracle home appears, but the products and components within the Oracle home are not listed.

Cause: This may result because of a missing or corrupted Oracle home inventory.

Action: Do the following:

Back up the Central and Local inventories of both CRS and RDBMS for all nodes.

Rename or remove the Central Inventory on all nodes.

Copy the Local Inventory from the node that is not corrupted to the node that is corrupted.

Recreate the Central Inventory with the attachhome option as in MetaLink note 413939.1, Steps to Recreate the Central Inventory in Real Application Clusters.

Verify that opatch lsinventory functions correctly in both the CRS and RDBMS homes.

Note:

Copying the Local Inventory is supported only when patch sets and one-off patches applied are the same across all nodes.

For information on recovering from non-RAC Oracle home inventory corruption, see "Diagnosing and Recovering from Oracle Home Inventory Corruption".

Home Selector (Available on Win32 Platforms)

The following sections describe the Home Selector, which is installed as part of Oracle Universal Installer on Windows computers.

To view the Home Selector, click the Environment tab of the Inventory dialog, which appears when you click the Installed Products button on several Oracle Universal Installer screens.

Home Selector Overview

The Home Selector is a part of the installation software. The Home Selector enables you to easily change your primary Oracle home (the one that appears first in the PATH environment variable). If you need to switch the active home or need to perform batch work which requires a "default home" to be active, you can use the Home Selector to change the Windows NT system settings.

When using the Home Selector to make a specific Oracle home the active one, the software installation in question is moved to the front of the PATH variable, making it the first directory to be scanned for executable and library files.

Use the GUI in the Environment tab of the Inventory dialog to establish the order of Oracle homes in your PATH variable.

How Home Selector Works

When you perform an installation on a system, Oracle Universal Installer runs the selectHome.bat file to register the Oracle home you selected. In silent mode, you perform this outside Oracle Universal Installer. The first Oracle home is named the "DEFAULT_HOME" and registers itself in the Windows NT registry under the key:

HKEY_LOCAL_MACHINE

   Software

      Oracle

This is the default Windows NT registry hive which contains all the "generic" Oracle settings. Also the PATH variable is adjusted and the BIN directory of the $ORACLE_HOME is added to the environment variable.

Some additional parameters is also written to the key:

HKEY_LOCAL_MACHINE

   Software

      Oracle

         KEY_<ORACLE_Home_Name>

With Oracle Universal Installer, you can change the "DEFAULT_HOME" name to something else. Also, it registers all Oracle settings in the "KEY_<Home_NAME>" sub-key of the ORACLE key.

When an additional Oracle home is added to the system, the PATH variable is adjusted again to add the new BIN directory of the newly installed Oracle software. The registry variables are written to a key named "KEY_<HOME_NAME>".

Oracle Home Directory Structure for Windows Platforms

A typical Oracle home on Windows platforms contains the files and directories shown in Table 2-4.

Table 2-4 Oracle Home Directory for Windows Platforms

Oracle Home Directory
Contents

\BIN

Product executable and DLLs

\LIB

DLL files

\JLIB

All JAR files

\DBS

Common message files

\PROD1

PROD1 product files

\PROD2

PROD2 product files

Optimal Flexible Architecture Directory Structure (on UNIX)

The Optimal Flexible Architecture (OFA) standard is a set of configuration guidelines for fast, reliable Oracle databases that require little maintenance.

OFA is designed to:

Organize large amounts of complicated software and data on disk to avoid device bottlenecks and poor performance

Facilitate routine administrative tasks such as software and data backup functions, which are often vulnerable to data corruption

Alleviate switching among multiple Oracle databases

Adequately manage and administer database growth

Help eliminate fragmentation of free space in the data dictionary, isolate other fragmentation, and minimize resource contention

The OFA directory structure is described in the following sections.

ORACLE_BASE Directory

ORACLE_BASE specifies the BASE of the Oracle directory structure for OFA-compliant databases. A typical ORACLE_BASE directory structure is described in Table 2-5. When installing an OFA-compliant database using Oracle Universal Installer, ORACLE_BASE is set to /pm/app/oracle by default.

Table 2-5 Sample ORACLE_BASE Directory Structure and Content

Directory
Content

admin

Administrative files

doc

online documentation

local

Sub-tree for local Oracle software

product

Oracle software

ORACLE_HOME Directory

Table 2-6 shows an example of the Oracle home directory structure and content for an Oracle Server Installation.

If you install an OFA-compliant Oracle Server, the Oracle home directory is /mount_point/app/oracle/product/release_number. Under UNIX, the Oracle home directory might contain the following subdirectories, as well as a subdirectory for each Oracle product selected.

Note:

The directory and content information in this table are only samples. The directories that appear in your own Oracle home depend on whether the corresponding products are installed and the version of the Oracle Database you are running.

Table 2-6 Sample Oracle Home Directory Structure and Content

Directory
Content

assistants

configuration Assistants

bin

binaries for all products

ctx

interMedia Text cartridge

dbs

initsid.ora, lksid

install

install related files

lib

Oracle product libraries

jlib

Java classes

md

Spatial cartridge

mlx

Xerox Stemmer (for interMedia Text cartridge)

network

Net8

nlsrtl

NLS run-time loadable data

ocommon

common files for all products

odg

data gatherer

opsm

Parallel Server Manager Components

oracore

core libraries

ord

data cartridges

otrace

Oracle TRACE

plsql

PL/SQL

precomp

precompilers

rdbms

server files and libraries required for the database

slax

SLAX parser

sqlplus

SQL*Plus

3 Customizing and Creating Response Files

This chapter introduces you to Oracle Universal Installer's availability of response files for silent and suppressed installations. This chapter also describes how to modify or create a response file so you can customize and standardize the installation of Oracle products in your organization.

This chapter is organized into the following sections:

About Response Files

Modifying a Response File

Creating a Response File With Record Mode

Response File Format

Installing with a Response File

About Response Files

This section answers the following questions:

What Is a Silent Installation?

What Is a Response File?

Why Perform a Silent Installation?

What Is a Silent Installation?

A silent installation runs in the console and does not use the GUI. The interactive dialogs you normally see are not displayed in a silent installation.

Instead of prompting you to select a series of installation options, Oracle Universal Installer installs the software using a predefined set of options stored in a response file or passed on the command line. You can view the progress of a silent installation in the console.

What Is a Response File?

A response file is a specification file containing information you normally through the Oracle Universal Installer user interface during an interactive installation session. Each answer is stored as a value for a variable identified in the response file.

For example, values for Oracle home or installation type can be set automatically within the response file.

The response file template for the installation of your product can be found on your stage (CD-ROM) under the <root of CD>/response directory, with pre-populated values. For example:

<Products.xml_Location>/Response/<product>.<installtype>.rsp

Note:

Check the installation guide for the product that you are installing to get the correct list of required files.

Why Perform a Silent Installation?

Silent installations can be useful if you have to install an Oracle product multiple times on multiple computers. If the options you select while installing on each computer are always the same, you save the time of reviewing each installation screen and selecting the various installation options.

Silent installations can also ensure that multiple users in your organization use the same installation options when they install your Oracle products. This makes supporting those users easier because you already know what components and options have been installed on each computer.

Before you perform a silent installation, you should review the settings in the response file template provided with your Oracle product.

Note:

If you attempt to perform a silent installation on a UNIX computer where no Oracle products have been installed, Oracle Universal Installer uses the default inventory location, then prompts you to run the oraInstRoot.sh script with root privileges upon successful installation.

The script is saved in the _*Central Inventory - oraInventory *_ directory. This script sets up the Central Inventory on a clean host. You can override the default location by setting it in INVENTORY_LOCATION. Note that this location is ignored if a Central Inventory already exists and is pointed to by /var/opt/oracle/oraInst.loc (or /etc/oraInst.loc for Linux, AIX, and Sequent).

See "Oracle Universal Installer Inventory" for more information on the Central Inventory.

The remainder of this chapter describes the various parameters and settings you can modify within an Oracle Universal Installer response file.

Modifying a Response File

If your product installation includes a response file template, you can find it on your stage (CD-ROM) under the <root of CD>/response directory.

If your product installation does not include a response file template, you can create a response file based on the installation options you select. See "Creating a Response File With Record Mode" for more information.

To modify the response file:

Make a copy of the product's response file and open it in a text editor.

Review any information provided in the response file or in the product installation guide.

Many software products use settings in the response file to customize the installation of their particular product. See the response file template for suggestions or guidelines on how to set up the file for your installation.

Get familiar with the organization and content of the response file using the information in the section "Response File Format".

Modify the response file to meet the needs of your organization and save the modified version.

See the section "Installing with a Response File" for information on starting Oracle Universal Installer using your modified response file.

Creating a Response File With Record Mode

You can create a new response file, based on the installation options you select, by using Oracle Universal Installer's record mode.

When you use record mode, Oracle Universal Installer records the installation session into a response file. You specify the name of the response file on the command line. The recorded response file is generated immediately after the Summary page, so you do not need to actually install your Oracle product to create the response file. That is, you can start the installation in Record mode and proceed through the installation options until you get to the Summary page. In the Summary Page, click Exit to stop the installation from proceeding with the installation. However, all the options you selected will be saved in the resulting response file.

You can use the newly created response file to run identical installation sessions on other computers in your organization.

Record mode can be also used during a silent installation. In those cases, the variable values specified in the original source response file will be recorded into the new response file.

The following sections describe how to use record mode on Windows and UNIX systems.

Using Record Mode

To record a new response file:

At the command prompt, use the cd command to change to the directory that contains the Oracle Universal Installer executable file (setup.exe or runInstaller.sh) for your installation.

Enter the following command:

setup -record -destinationFile <response_file_name> (on Windows)
./runInstaller -record -destinationFile <response_file_name> (on UNIX)

Replace the <response_file_name> with the complete path for the new response file. For example:

setup -record -destinationFile C:\response_files\install_oracle11g.rsp (on Windows)
./runInstaller -record -destinationFile /private/temp/install_oracle11g.rsp (on UNIX)

Use the Oracle Universal Installer user interface to select your installation options. These will be recorded.

When Oracle Universal Installer displays the Summary page, you can either continue with the installation or exit.

Oracle Universal Installer saves your new response file using the path and file name you specified on the command line.

Response File Format

The following sections describe the organization and content of an Oracle Universal Installer response file.

Variable Values

Comments

Headers

Response File Parameters

Note:

Oracle recommends using an absolute path for the file name. However, if the file name is a relative path, it should be relative to the directory where the oraparam.ini file is present.

Variable Values

This section contains information on how variables are populated with values.

Variable Lookup Order

All variable values within a response file are in the name-value format. If two components have a variable with the same name, the expression should be written as follows to preserve each variable's uniqueness:

<component>:<variable>=<value>

If two components have the same internal name, but different versions, resolve the ambiguity by specifying the expression as follows:

<component>:<version>:<variable>=<value>

Oracle Universal Installer looks for command line variables in the following order:

<component>:<version>:<variable>=<value>
<component>:<variable>=<value>
<variable>=<value>

If command line variables are not found, then Oracle Universal Installer looks for variables in the response file in the same order:

<component>:<version>:<variable>=<value>
<component>:<variable>=<value>
<variable>=<value>

Note:

Oracle Universal Installer treats incorrect context, format, or type values within a response file as if no value were specified.

Setting the Recommendation Value

Values for variables are specified as:

<variable> = <recommendation> : <value>

The values that are given as <value_required> must be specified for a silent installation to be successful.

For values that are given as <value_unspecified>, you can optionally specify a value, where <value> can be one of the following types listed in Table 3-1.

Table 3-1 Variable Types and Representations

Type
Representation

Number

10

Boolean

TRUE or FALSE (case insensitive)

String

"Value"

String List

{"value1", "value2"}

The <recommendation> parameter can be specified as Forced or Default.

If you specify Forced, no dialog appears during installation. The value is automatically used. You cannot change the value.

If you specify Default, the dialog appears during installation with the value as the default. You can choose another value if desired.

If nothing is specified for <recommendation>, Forced is used as the default.

Comments

Comments begin with a "#" (hash or pound) symbol. They contain information about the type of the variable, state whether the variable appears in dialog, and describe the function of the variable. A variable and a value are associated with a comment.

For example:

#TopLevelComponent;StringList;Used in Dialog
TopLevelComponent={"Demo", "1.0"}

Headers

The header is a comment that describes the different formats and comment conventions used in a response file.

For example:

#Parameter : UNIX_GROUP_NAME
#Type : String
#Description : UNIX group to be set for the inventory directory.
#Valid only on UNIX platforms.
#Example : UNIX_GROUP_NAME = "install"
UNIX_GROUP_NAME=<Value Unspecified>

Response File Parameters

The following are parameters for Oracle Universal Installer. All products installed using Oracle Universal Installer have these parameters in addition to product-specific variables.

INCLUDE

This parameter specifies the list of response files to be included in this response file. If you want to include other response files in your main response file, you must use this parameter. Note that the values in the main response file have priority over the included response files.

INCLUDE={"file1.rsp","file2.rsp",............."filen.rsp"}

You should specify the absolute path in the INCLUDE statement for each response file to be included. If you wish to specify a relative path, note that the location is relative to the current working directory (the location of the oraparam.ini file).

RESPONSEFILE_VERSION

This parameter specifies the version number of the response file.

RESPONSEFILE_VERSION = <version_number>

FROM_LOCATION

The location of the source of the products to be installed. The default generated value for this parameter is a path relative to the location of the runInstaller file oraparam.ini. Relative paths are necessary for shared response files used by multiple users over a network. Since people may be mapping to different drives, absolute paths will not work for shared response files.

Notes:

You must enter a value for FROM_LOCATION for a complete silent installation. You may want to use the command line to set this parameter. If the location is a relative path, remember that the path should be relative to the location of the oraparam.ini file.

Make sure that /var/opt/oracle/oraInst.loc (or /etc/oraInst.loc for Linux, AIX, and Sequent) exists. The response file for UNIX has a public variable, setunixinstallgroup, that only becomes effective when it is the first Oracle Universal Installer installation and the oraInst.loc file is not already present in the location mentioned above.

FROM_LOCATION_CD_LABEL

This parameter is used in multiple-CD installations. It includes the label of the compact disk where the file products.jar exists. You can find the label in the disk.label file in the same directory as products.jar.

LOCATION_FOR_DISK2

This parameter is for the complete path to other disks.

LOCATION_FOR_DISK2="F:\teststage\cd\Disk2"

If there are more than two disks, more variables will be added as LOCATION_FOR_DISK3, and so on.

The CD location for a silent installation is located by two mechanisms:

Oracle Universal Installer looks for the Location_For_Disk{DiskNumber} variable in the response file and uses that location.

If the variable does not have a value or does not have the required files, it looks for the components under ../../Disk{DiskNumber}/stage (from products.jar).

Therefore, you can either specify the location to look for it in the response file or you can copy them into the disk. For example:

<Product_Shiphome_Location>/stage

RESTART_SYSTEM

Set this boolean variable to TRUE if you want to restart the system without the user's confirmation. This is the force value for restarting the system.

NEXT_SESSION

Set this boolean variable to TRUE if the installer needs to go to the File Locations page for another installation or to another response file if you are performing a silent installation.

NEXT_SESSION = TRUE

NEXT_SESSION_ON_FAIL

Set this boolean variable to TRUE to allow users to invoke another installation session even if the current installation session fails. This variable is used only if the NEXT_SESSION variable is set to TRUE.

NEXT_SESSION_ON_FAIL = TRUE

NEXT_SESSION_RESPONSE

Use this string variable to enter the complete path of the next session's response file if you want to automatically begin another silent installation when the current installation is complete. If you specify only a file name, the Installer looks for the response file in the <TEMP>/orainstall directory. This variable is only used if NEXT_SESSION is set to TRUE; otherwise, Oracle Universal Installer ignores the value of this variable.

NEXT_SESSION_RESPONSE="/private/usr2/nextinstall.rsp"

ORACLE_HOME

The location where products are to be installed. You must enter a value for ORACLE_HOME for a complete silent installation.

ORACLE_HOME_NAME

The name of the current Oracle home. You must enter a value for ORACLE_HOME_NAME for a complete silent installation.

SHOW_COMPONENT_LOCATIONS_PAGE

The location page, which appears in a custom installation type, can be suppressed by setting this value to FALSE. If you set the value to FALSE, the user is prevented from specifying alternate directories. If there are products with installed directories which can be changed, you may want to set the value to TRUE.

SHOW_CUSTOM_TREE_PAGE

Set SHOW_CUSTOM_TREE_PAGE to TRUE if the custom tree page in the installer must be shown. In the Custom Tree page, dependencies can be selected or deselected. This page appears only in a custom installation type.

SHOW_END_SESSION_PAGE

The installation success/failure page, which appears at the end of an installation, can be suppressed by setting this value to FALSE.

SHOW_EXIT_CONFIRMATION

Set to TRUE if you need to show the confirmation when exiting the installer.

SHOW_EXIT_CONFIRMATION = TRUE

SHOW_INSTALL_PROGRESS_PAGE

The installation progress page, which appears during the installation phase, can be suppressed by setting the value to FALSE.

SHOW_OPTIONAL_CONFIG_TOOL_PAGE

Set to TRUE if you must show the Optional Configuration Tools page in the installer. The Optional Configuration Tools page shows the list of optional configuration tools that are part of this installation and the status of each tool, including detailed information on why the tool has failed.

SHOW_ROOTSH_CONFIRMATION

Set to TRUE if you need to show the Confirmation dialog asking to run the root.sh script in the installer. This variable is valid only on UNIX platforms.

SHOW_ROOTSH_CONFIRMATION = TRUE

SHOW_SPLASH_SCREEN

Set to TRUE if the initial splash screen in the installer needs to be shown.

SHOW_SPLASH_SCREEN = TRUE

SHOW_SUMMARY_PAGE

The Summary page can be suppressed by setting this value to FALSE.

SHOW_WELCOME_PAGE

Set to TRUE if you need to show the Welcome page in the installer.

SHOW_WELCOME_PAGE = FALSE

SHOW_RELEASE_NOTES

Set this parameter to TRUE if you want the release notes for this installation to be shown at the end of the installation. A dialog box lists the available release notes. Note that the SHOW_END_SESSION parameter must be set to TRUE before you can use this parameter.

TOPLEVEL_COMPONENT

This parameter is the name of the component (products) and the version as a string list. You must enter a value for TOPLEVEL_COMPONENT.

Usually, the components are represented with a pair of strings: the first one representing the internal name, the second representing the version.

For example, RDBMS 11.1. may be represented as {"oracle.rdbms","11.1.0.0.0"}.

UNIX_GROUP_NAME

This parameter is the UNIX group name to be set for the inventory on UNIX platforms.

Note: The UNIX group name is used for first-time installations only.

REMOVE_HOMES

Use this parameter to identify the Oracle homes you want to remove from the inventory during a deinstallation session. For each home, specify the home name using the full path information.

REMOVE_HOMES={"/home/oracle/ora9i","/home/oracle/ora8i"}

DEINSTALL_LIST

Use this parameter to enter a list of components to be removed during a silent deinstall session. For each component, specify the internal component name and version.

DEINSTALL_LIST={"sample1","1.0.0.0.0"}

SHOW_DEINSTALL_CONFIRMATION

Set this parameter to FALSE if you want to hide the deinstall confirmation dialog box during a silent deinstallation.

SHOW_DEINSTALL_PROGRESS

Set this parameter to FALSE if you want to hide the deinstallation progress dialog box during a silent deinstallation.

DEPENDENCY_LIST

The DEPENDENCY_LIST is the list of dependents on which the component depends. These dependent components represent the list of components that appear as "selected" during installation. Following is a list of some of this parameter's characteristics:

The DEPENDENCY_LIST variable is only generated when dependencies are present and if the dependency is not a required one.

You cannot list components to appear as deselected items in a dialog.

Specifying required dependents is redundant since they will be selected anyway. The dependents selection can have the other two types of dependents: optional and one-or-more.

The list of components is specified by an internal name and version number.

A typical example is listed here:

DEPENDENCY_LIST={"oracle.netclt","9.2.0.4.0","oracle.netmgr","9.2.0.4.0"}

CLUSTER_NODES

This parameter lists the nodes on the cluster on which the Oracle home is installed or would be installed. For new installations, this would be the node list on which the installation needs to be done (including the local node). For patching or upgrades, this is the node list on which the Oracle home is already installed.

"CLUSTER_NODES={alpha-1, alpha-2}"

REMOTE_NODES

This parameter lists the remote nodes (apart from the local node) on the cluster on which to install during a silent installation. Oracle Universal Installer installs on all named nodes.

"REMOTE_NODES={alpha-1, alpha-2}"

LOCAL_NODE

This parameter specifies the current node on which the installation occurs.

LOCAL_NODE={}

OPTIONAL_CONFIG_TOOLS

While all the required configuration tools are launched by the installer, you can control the optional configuration tools you would want to launch by specifying the tool's internal names in the OPTIONAL_CONFIG_TOOLS section.

Note:

The OPTIONAL_CONFIG_TOOLS variable is only generated when at least one optional configuration tool is available.

You can call the Net Configuration Assistant or the Database Configuration Assistant at the end of a database installation in silent mode also. For example, to launch the Net Configuration Assistant in silent mode, you can pass the parameter s_responseFileName="netca.rsp".

You can specify both the Auto-launch optional tools and User-launch optional tools in a string list.

#Example : OPTIONAL_CONFIG_TOOLS = {"configtool2 ", "configtool3"}
OPTIONAL_CONFIG_TOOLS=<Value Unspecified>

If no value is specified for this variable, all the tools are run by default. If there is a value specified, only those optional tools are run while the rest of the tools are ignored.

Suppress the configuration tool by mentioning only the tools that you want to run as part of the OPTIONAL_CONFIG_TOOLS variable added for each component. You should use the internal names of the configuration tool. The response file generator generates these internal names also as part of the options provided for the variable.

For example, if oracle.server has Tool1 and Tool2 and you want to run only Tool1 in the response file, you can specify it as follows:

oracle.server:11.1.0.0.0:OPTIONAL_CONFIG_TOOLS={"Tool1"}

INSTALL_TYPE

You can set the installation type variable to determine the installation type of the currently selected top level component.

The installation type variable is only generated for the top level components and only when there is more than one installation type available.

Note:

You must enter a value for INSTALL_TYPE.

SELECTED_LANGUAGES

You can set the languages in which the components will be installed. You must use the internal name while specifying the value:

en,   : English
fr,   : French
de,   : German
ja,   : Japanese

For example, to specify Japanese:

SELECTED_LANGUAGES = {"ja"}

For more information on the languages Oracle Universal Installer supports, see "Product Language Selections".

Note:

The SELECTED_LANGUAGES variable is only generated when more than one language is available.

ACCEPT_LICENSE_AGREEMENT

Set this Boolean variable to TRUE if you agree with the license agreement. This parameter requires you to set this variable to TRUE to indicate your acceptance of the license agreement normally accepted in the GUI. This variable is used only in silent installations. Installation cannot continue until this variable is set to TRUE.

Installing with a Response File

Many Oracle software products provide tools and procedures for running Oracle Universal Installer from the command line without displaying Oracle Universal Installer screens or responding to questions during the installation.

These are called silent installations. Instead of prompting you to select a series of installation options, Oracle Universal Installer installs the software using a predefined set of options. These options are stored in a response file (.rsp).

Consider the following information about response files:

If your product installation includes a response file, you can find it on your stage (CD-ROM) under the <root of CD>/response directory.

You can modify the response file for your Oracle product to customize an installation for your organization. See "Modifying a Response File" for more information.

You can create your own response files using record mode. See "Creating a Response File With Record Mode" for more information.

If you start Oracle Universal Installer from the command line, see "Using Oracle Universal Installer Exit Codes".

The following sections describe how to specify a response file when you start Oracle Universal Installer.

Note:

If you attempt to perform a silent installation on a UNIX computer where no Oracle products have been installed, you will receive an error message. Before you can perform a silent installation on such a computer, you must first run the script oraInstRoot.sh, which is saved in the /oraInventory directory. You must run this script with root privileges. This enables Oracle Universal Installer to set up the Central Inventory on a clean host.

See "Oracle Universal Installer Inventory" for more information on the Central Inventory.

Specifying a Response File

To start Oracle Universal Installer and specify the response file, enter the following command at the command line in the directory where the executable file is installed:

setup.exe -responseFile <filename> <optional_parameters> (on Windows)
./runInstaller -responseFile <filename> <optional_parameters> (on UNIX)

Note:

You must specify the complete responseFile path. If you do not, Oracle Universal Installer assumes the location to be relative to the oraparam.ini associated with the launched Oracle Universal Installer.

For help on command line usage, enter the following at the command line in the directory where the executable file is stored:

setup -help (on Windows)
./runInstaller -help (on UNIX)

In Windows, when you execute setup -help, a new command window appears, with the "Preparing to launch..." message. A moment later, the help information appears in that window.

Optional Parameters When Specifying a Response File

Optional parameters you can use with the -responseFile flag are:

-nowelcome — Use the -nowelcome flag with the -responseFile flag to suppress the Welcome dialog that appears during installation.

-silent — Use the -silent flag with the -responseFile flag to run Oracle Universal Installer in complete silent mode. Note that the Welcome dialog is suppressed automatically.

-formCluster — Use the -formCluster flag for Oracle Clusterware installations to specify the cluster.

Note that when you specify the -silent flag, but no values are specified to a particular variable in a dialog, the installer stops. The success or failure of the installation when you specify this flag is generated as follows:

In a file named silentInstall<timestamp>.log for hosts without an Oracle inventory. This file is generated in the /tmp directory on UNIX and the directory specified by the variable TEMP on Windows platforms.

In the inventory logs directory for hosts that already had an inventory.

Note:

Using the -nowelcome option with the -silent option is unnecessary since the Welcome screen does not appear when you use the -silent option.

Setting Response File Variables From the Command Line

With Oracle Universal Installer 2.1 and higher, you can specify the value of certain variables when you start Oracle Universal Installer from the command line. Specifically, you can specify session and component variables. For specific information about the format and organization of response files, see "Modifying a Response File".

When you specify the value of a variable on the command line, that value overrides the value of the variable if it is defined in the response file.

Specifying the Value of a Session Variable

To specify the value of a session variable, use the following command syntax:

./runInstaller session:<variable_name>=<value> (on UNIX)
setup.exe session:<variable_name>=<value> (on Windows)

For example, to prevent the Universal Welcome page from displaying:

./runInstaller session:SHOW_WELCOME_PAGE=false (on UNIX)
setup.exe session:SHOW_WELCOME_PAGE=false (on Windows)

Note that the "session:" tag is optional and is used mainly to remove any possible ambiguity.

Specifying the Value of a Component Variable

To specify the value of a component variable, use the following command syntax:

./runInstaller <component_name>:<component_version>:<variable_name>=<value> (on UNIX)
setup.exe <component_name>:<component_version>:<variable_name>=<value> (on Windows)

For example, to modify the value of a variable VAR1 in version 1.1 of a component called COMP2:

./runInstaller COMP2:1.1.0.0.0:VAR1="test" (on UNIX)
setup.exe COMP2:1.1.0.0.0:VAR1="test" (on Windows)

Note that the "<component_name>:" and "<component_version>:" optional tags are used mainly to remove any possible ambiguity. If two variables exist with the same name for different components/versions, use these tags to distinguish between them.

4 Installing Products

This chapter includes the following sections:

Checking Prerequisites Before Installation

Installing Oracle Products

Deinstalling Oracle Products

Running Oracle Universal Installer After Installation

About Oracle Universal Installer Log Files

Checking Prerequisites Before Installation

Before installation, Oracle Universal Installer checks the environment to see whether it meets the requirements for successful installation. Early detection of problems with the system setup reduces the chances of encountering problems during installation; for instance, problems with insufficient disk space, missing patches, inappropriate hardware, and so on.

Oracle Universal Installer is required to perform all prerequisite checks defined for the installation before installing any software, whether they are Oracle Universal Installer-specific tests, or tests defined for a specific product. Specific prerequisite checks are defined for each operating system on which Oracle Universal Installer runs. All prerequisite check parameters must be defined in the oraparam.ini file (or another *.ini file that you define). All the results are logged in the install Actions<timestamp>.log file.

You can perform prerequisite checking in the following ways:

Automatically: Checks are performed automatically when you run the Oracle Universal Installer executable during an installation. Simply run Oracle Universal Installer to perform all predefined prerequisite checks.

Silent Mode: You can run and manage checks from the command line for a silent installation. For silent installations, Oracle Universal Installer performs as many prerequisite checks as possible, alerts you for all errors (if any), and provides the location of the installActions<timestamp>.log file before exiting.

Standalone: You can run checks without completing an installation. See Table 4-1 for a description of the flags to use.

Table 4-1 Command Line Parameters for Prerequisite Checks

Command
Description

-paramFile <file name>

Use this flag to specify the location of the oraparam.ini file to be used. For example, you can create your own parameters file and use that to operate Oracle Universal Installer. Note that Oracle Universal Installer uses the file you specify for all operations, including the prerequisite checks.

-executeSysPrereqs

Use this flag on the command line to perform only the prerequisite check, without continuing the installation. This can be used to verify that the basic prerequisites have been met before deciding to perform an installation.

-ignoreSysPrereqs

Use this flag on the command line to ignore all prerequisite checks. This may be useful when you know that the checks are faulty or the environment has already been verified.This is an optional flag, though not recommended by Oracle.

Inputs to the checker are listed in the prerequisite.xml file. After running the checker, you can find the results, along with the predefined inputs, in the prerequisite_results.xml file. These files are located in the oraInventory/logs directory. You can reuse the prerequisite_results.xml file as an input file for subsequent executions of the checker.

Installing Oracle Products

The following sections describe how to start Oracle Universal Installer and install an Oracle product. Specifically, this section describes:

Getting Help While Installing Oracle Products

About the ORAPARAM.INI File

Modes of Installation

Installation Media

Special Instructions for UNIX Users

Getting Help While Installing Oracle Products

At any time while installing your product, click Help for information about the screens specific to your installation.

Oracle Universal Installer provides two kinds of online help

Generic online help provided with every copy of Oracle Universal Installer

These topics describe the screens and dialog boxes that all Oracle Universal Installer users see, regardless of the product they are installing.

Online help specific to a particular installation

These topics are created by the product developer and describe the screens and dialog boxes specific to the product you are installing. For example, the help topic for the Installation Types page is often a custom help topic the installation developer creates that describes the specific installation types for the product you are installing.

After you view an online help topic, choose Navigator from the Tools menu to display the navigator pane. From the navigator pane, you can browse the table of contents, select other topics, or search for a particular word or phrase in the online help.

Note:

Only generic help topics are available in the navigator or table of contents. You can only access custom help topics by clicking the Help button on the dialogs or windows they describe.

About the ORAPARAM.INI File

The oraparam.ini file is the initialization file for Oracle Universal Installer. This file includes information that defines the behavior of certain Oracle Universal Installer features. Each product installation possesses a unique oraparam.ini file.

Generally, you should not have to edit the contents of this file, but in certain situations, understanding the contents of this file can help you troubleshoot problems and understand certain aspects of the Oracle Universal Installer product.

For example, for most installations, Oracle Universal Installer provides a default value on the File Locations page that points to the location of the product's installation kit or stage. This default value is stored in the oraparam.ini file. The oraparam.ini file also identifies the location of the Java Runtime Environment (JRE) required for the installation.

In the staging area, it is located in the same directory as the executable file. For example:

For UNIX systems:

cd/<Product_Shiphome_Location>/install/solaris/runInstaller
cd/<Product_Shiphome_Location>/install/solaris/OraParam.ini

For Windows systems:

cd\<Product_Shiphome_Location>\install\win32\setup.exe
cd\<Product_Shiphome_Location>\install\win32\OraParam.ini

In the staging area, the default OUI_LOCATION is relative to the location of the oraparam.ini file, as follows:

../../stage/

Once installed, the oraparam.ini file is located in the /oui directory.

Table 4-2 describes the parameters in the oraparam.ini file and how to use them.

Table 4-2 Parameters in oraparam.ini

Section/Parameter
Description

[Oracle]

This section contains various parameters related to your installation.

DISTRIBUTION

Set to TRUE if the oraparam.ini file is on a distribution medium. A distribution medium can be a CD-ROM or a Web server. Once installed, this parameter is set to FALSE.

SOURCE

Location of your staging area (the products.xml file). This location is relative to the directory where oraparam.ini exists.

LICENSE_LOCATION

Location of a text file for License information. This location is relative to the directory where oraparam.ini exists. The legal terms file should be a plain text file.If you specify the LICENSE_LOCATION variable, Oracle Universal Installer asks for license acceptance after you click the Next button on the "Welcome" screen. Oracle Universal Installer lets you proceed only after the license is accepted. This parameter is ignored if the file is not found.

LICENSE_TITLE

The value of this variable displays as the title of the license agreement. Oracle Universal Installer only reads this value if the license dialog is displayed; that is, if the LICENSE_LOCATION variable has a valid value.

JRE_LOCATION

Location of the Java Runtime Environment (JRE) that the Oracle Universal Installer uses.

Note: For a single installation to point to two different JRE versions, move the oraparam.ini file one level below its original location and then specify the individual platform's JRE location. For example, if the original location is in the Disk1/install directory, move it to the Disk1/install/win32 or the Disk1/install/solaris directory, and then specify the individual platform's JRE location.

OUI_LOCATION

Points to the location of Oracle Universal Installer files used for interactive mode (GUI-based). This parameter is optional; if DISTRIBUTION=TRUE, Oracle Universal Installer computes this value using the OUI_VERSION parameter.Use this parameter if you want to override the default value:

../../stage/Components/oracle.swd.oui/<version>/1/DataFiles/Expanded

OUI_CORE_LOCATION

Points to the location used for silent mode. This parameter is optional; If DISTRIBUTION=TRUE, then Oracle Universal Installer computes this value using the OUI_VERSION parameter.Use this parameter if you want to override the default value:

../../stage/Components/oracle.swd.oui.core/<version>/1/DataFiles/Expanded

OUI_VERSION

Set the version of Oracle Universal Installer that you are using. You must properly set the version for the BOOTSTRAP to work.

DISPLAY_VERSION

Set to FALSE to suppress the display of the version of top-level components in the Installation Type dialog during installation.

JRE_MEMORY_OPTIONS

Set these to increase the initial heap threshold for JRE. For example, -mx48m.

DEFAULT_HOME_LOCATION

Location of the default Oracle home.

DEFAULT_HOME_NAME

The default name for the Oracle home. Use this parameter only if the installation occurs on a host with no previous Oracle installations.

NO_BROWSE

Lists directories that you do not want to browse, which are typically large directories that require a long time to view. For example, /net, /nfs.

NLS_ENABLED

Set to TRUE for Oracle Universal Installer to enable NLS support. Set to FALSE to disable the installation session translations. Oracle Universal Installer displays in English even if you run on a non-English system.

BOOTSTRAP

Set to TRUE or FALSE. This parameter instructs Oracle Universal Installer to attempt a bootstrap. Set to TRUE before cutting CDs, but set to FALSE after you have copied the staging area to the hard disk.

BOOTSTRAP_SIZE

Use this parameter to set the size the temporary space requires when BOOTSTRAP is set to TRUE. For example, when you install Oracle Universal Installer, it sets the value of this parameter to the temporary space required by both Oracle Universal Installer and the JRE.By default, if this entry is not set, Oracle Universal Installer assumes 45 MB for Win32, 52 MB for Win64, and 69 MB for Solaris. However, these values could vary from one major release to the other, based on the space required by newer versions of JRE.If the shiphome contains advertisement images, installation developers should add the space taken by the images to this value. Oracle Universal Installer checks the temp space requirements before starting up and produces an error if there is not enough space for Oracle Universal Installer to run in bootstrap mode.

USE_BUILD_NUMBER

Use this parameter to control whether or not Oracle Universal Installer considers the build number of the component when determining whether or not to overwrite a previous version or copy of a component. Note that this parameter is intended to be used in pre-production shiphomes only.

APPLTOP_STAGE

Use this parameter when you want your users to specify the location of an Oracle Applications top (APPL_TOP) directory. When this parameter is set to TRUE, the File Locations page includes fields for selecting an APPL_TOP directory. This is an optional parameter for use with Apps installs only. If not specified, the default is assumed to be FALSE.

REGISTRATION_URL

This parameter is the URL where the user is directed from the Product Registration page in Oracle Universal Installer. The REGISTRATION_KEY parameter is validated at this site. Set this parameter along with the REGISTRATION_KEY parameter to invoke the Product Registration page. Both are required.

REGISTRATION_KEY

This key is validated against an encrypted key at the REGISTRATION_URL location. Set this parameter along with the REGISTRATION_URL parameter to invoke the Product Registration page. Both are required.

[IMAGES]

This section lists the images associated with an installation. To show advertisements during an installation, specify each image as a separate variable.

Modes of Installation

You can use Oracle Universal Installer to install Oracle products in any of the three following modes:

Interactive: Use Oracle Universal Installer's interactive mode to use the graphical user interface to walk through the installation, providing information in the installation dialogs when prompted. This method is most useful when installing a small number of products in different setups on a small number of hosts.

Suppressed: Use Oracle Universal Installer's suppressed mode to supply the necessary information by using a combination of a response file or command line entries with certain interactive dialogs. You can choose which dialogs to suppress by supplying the information at the command line when you invoke Oracle Universal Installer. This method is most useful when an installation has a common set of parameters that can be captured in a response file, in addition to custom information that must be input by hand.

Silent: Use Oracle Universal Installer's silent installation mode to bypass the graphical user interface and supply the necessary information in a response file. This method is most useful when installing the same product multiple times on multiple hosts. By using a response file, you can automate the installation of a product for which you know the installation parameters. For more information, see Chapter 3, "Customizing and Creating Response Files", for detailed information on using response files and installing in silent mode.

Note:

You can use the -noConsole flag on the Windows platform to suppress the display of messages in the console.

Installation Media

For each of these three installation modes, you can install from three different media:

Installing from a Single CD-ROM

Installing from Multiple CD-ROMs

Installing from a staged HTTP location

Note:

On Windows, when you start the installer from a shared drive, you need to map the shared drive and then invoke the installer from the shared drive.

The following sections discuss these different installation approaches.

Notes:

When you invoke runInstaller (UNIX) or setup.exe (Windows), you should invoke it from the directory where this command is present, or you must specify the complete path to runInstaller (UNIX) or setup.exe (Windows).

Installing from a Single CD-ROM

While installing Oracle products contained on a single CD-ROM, start Oracle Universal Installer by running the executable file, setup.exe or runInstaller.sh, located in:

../install/<platform>

Where <platform> represents Win32, Win64, Solaris, Linux, and so on.

For UNIX systems, run the script by typing ./runInstaller at the command line.

Note:

Oracle Universal Installer for win64 functions like Oracle Universal Installer for win32. However, the startup directory on the CD is "win64" instead of "win32." Launching Oracle Universal Installer from the win32 directory launches Oracle Universal Installer in 32-bit mode, used for installing 32-bit software. Use win64 for installing 64-bit software.

When you install both 32-bit and 64-bit Oracle Universal Installer on a 64-bit machine, two different inventories are created and maintained. However, you cannot install 64-bit software in a 32-bit home, and vice versa.

Installing from Multiple CD-ROMs

If you are creating a multiple-CD installation on UNIX, you might need to launch runInstaller in the background using the following command:

./runInstaller &

By launching runInstaller in the background, you can change your current directory after you launch Oracle Universal Installer, allowing you to eject the CD. (It may also help to launch runInstaller as a foreground process from a different directory.)

You may want to create a shell script that launches Oracle Universal Installer in the background and then exits. If you choose to create a shell script, remember to also pass all parameters that you passed to the shell script to runInstaller in the event that you want to install silently using a response file.

TEMP/TMP Directory

On both UNIX and Windows installations, temporary copies of Oracle Universal Installer and JRE are placed in the TEMP or TMP directory in a subdirectory named /OraInstall<timestamp> so that these applications can be launched when you change CD-ROMs. Note that temporary files are created for single-CD installations as well. On both UNIX and Windows, Oracle Universal Installer looks for %TEMP% then %TMP%. If neither is set, Oracle Universal Installer defaults to /tmp on UNIX and c:\temp on Windows

Note:

.The TEMP/TMP directory should not be a cluster file system or a shared location.

Unmounting a CD

On UNIX, if you have trouble installing a product from multiple CD-ROMs, try using the following procedure to unmount the first CD-ROM and mount the second CD-ROM. If you still have problems, refer to the documentation links at the end of this topic.

In most cases, the following procedure helps with any problems you experience while switching to a second CD-ROM while installing Oracle software. If you inadvertently run the installer while the current working directory is in the CD-ROM, follow these steps to mount the next CD-ROM:

Change to the root directory of your system and log in as the root user by using the following commands:

$ cd /
$ su root

Unmount and remove the CD-ROM from the drive with the following command:

# umount cdrom_mount_point_directory

Insert and mount the next CD-ROM into the drive by using the following command:

# mount options device_name cdrom_mount_point_directory

Enter the correct mount point in the Installation dialog box.

Click OK to continue.

If after attempting this procedure you are still having problems, see the section on installing from multiple CD-ROMs in the Oracle Database Installation Guide, which is available from the Oracle Technology Network:

http://otn.oracle.com/documentation

Installing from a staged HTTP location

With Oracle Universal Installer, you can install products from the Web. You can publish your staging area from a Web server and then in the Oracle Universal Installer's Source location, specify the HTTP location for the products.xml file.

For example, you can enter:

http://www.oracle.com/product/ouiinstall/stage/products.xml

The Oracle Universal Installer recognizes a Web staging area just like a local, network, or CD-ROM stage.

System administrators of large customers who may want to deploy Oracle software to more than one target can use a combination of the Web installation and response file features:

Copy the staging area to a shared file system and make it accessible on the Intranet or a Web server.

Include predetermined response files on the same location. (Different groups of users might rely on different response files.)

Clients run Oracle Universal Installer locally and use the local response file that is mailed or downloaded so they can perform a silent installation.

The Web installation capability relies on some guidelines that must be followed at installation development time. Check the installation guide for your product to see if the installation of your product is certified for Web installation.

To test if your stage is Web-enabled, you can try the following procedure:

Copy the stage to your Web server.

Start the Oracle Universal Installer locally and point to the location of the products.xml file. For example:

http://smpweb.us.oracle.com/product/ouiinstall/stage/products.xml

Special Instructions for UNIX Users

The following sections describe special instructions that apply when you are installing certain products on a UNIX system.

Failed to Connect to Server Error

If you receive an Xlib error or a "Failed to connect to Server" error when you are running Oracle Universal Installer on the Solaris operating system, do the following:

Define the following environment variable on the host computer where you are running Oracle Universal Installer:

%setenv DISPLAY <machine name>:0.0

Replace <machine name> with the name of the computer that will display Oracle Universal Installer.

On the computer that will display Oracle Universal Installer, enter the following command, which allows other computers to display information on the computer's monitor:

%xhost +

Rerun the runInstaller script after you have set the DISPLAY environment variable.

Note:

You can run Oracle Universal Installer without specifying the DISPLAY variable by running in silent mode using a response file.

Providing a UNIX Installer Location with Root Privileges

You must have root privileges to perform various installation operations on the UNIX platform. For example, you must have root privileges to be able to create the Oracle Universal Installer inventory.

If you are installing Oracle Universal Installer for the first time, you are prompted to run a shell script from another terminal window before proceeding with the installation. Oracle Universal Installer prompts you to run root.sh after installation completes only if the script is required to be run as root before configuration assistants are run. Otherwise, you are prompted to run root.sh as root later.

Note:

When running Oracle Universal Installer in silent mode, if root.sh is required prior to configuration assistants, Oracle Universal Installer skips configuration assistants during the installation. You must run root.sh as root and then run the skipped configuration assistants after the silent installation is complete.

To successfully run the required shell script:

Leave the Oracle Universal Installer window open and open another terminal window.

In the new terminal window, use the substitute user command to log in with root privileges:

su -root

Change directory to the Oracle home into which you are currently installing your Oracle software product.

Run the shell script ./root.sh.

When the script is finished and you are returned to the command prompt, exit from the new terminal window and return to Oracle Universal Installer to continue the installation.

Note:

Do not exit the installation to run the shell script. Exiting the installation removes this script.

You are prompted to run the script only the first time you install.

Providing a UNIX Group Name

If you are installing a product on a UNIX system, the Installer also prompts you to provide the name of the group that owns the base directory.

You must choose a UNIX group name that has permissions to update, install, and remove Oracle software. Members of this group must have write permissions to the base directory chosen.

Only users who belong to this group are able to install or remove software on this host.

Deinstalling Oracle Products

The following sections describe how to remove products installed using Oracle Universal Installer. Specifically, these sections describe:

Removing Oracle Products and Oracle Homes

Deinstalling Top-level Products That Have Dependents

Silent Deinstallation

Removing Oracle Products and Oracle Homes

You can deinstall Oracle products before selecting products to install or after a successful installation.

To remove an Oracle product or Oracle home using interactive mode, perform the following steps:

Start Oracle Universal Installer from a CD-ROM or:

For Windows platforms, launch Oracle Universal Installer from the Start menu by selecting Start, Installation Products, Oracle Universal Installer.

For UNIX platforms, at the command line, run the script called runInstaller from the directory where it is stored, which is by default at the same level as the first Oracle home created on that host.

Click Deinstall Products on the "Welcome" screen.

The Inventory panel appears.

Select the product(s) you want to remove from the Contents tab of the Inventory panel and click Remove. You can also remove Oracle homes in the same manner. After you have removed an Oracle home, you can reuse its name and location to install other products.

The Remove Confirmation Dialog appears, asking if you want to remove the products and their dependent components. Click Yes.

Oracle Universal Installer warns you of any product dependencies that might cause problems if particular products are removed, and prompts you to confirm the deinstallation.

Pay special attention to the full list of products being removed before proceeding. Oracle Universal Installer computes this list based on the dependencies of each component.

Note:

You can also remove products by using the Installed Products button on Oracle Universal Installer as long as you perform this action before making your selection of products to install.

Deinstalling Top-level Products That Have Dependents

A top-level component is the most important component of an installation. It is the installable product you see at the first installation screen. You can only install one top-level component for each installation session.

When you select a specific component for removal, Oracle Universal Installer analyzes the dependency information to determine if other components should be removed along with it. Generally, if a component is selected for removal, the following components are removed with it:

All components that have a required dependency on the selected component.

Dependents of the selected component that have no other dependents. A dependent is a component on which the top-level component (dependent) has a dependency.

Silent Deinstallation

Not only can you perform command line installations, as described in section "Installing with a Response File", you can also perform command line deinstallations. A command line deinstallation enables you to remove Oracle products or Oracle homes from your system without using the Oracle Universal Installer graphical user interface.

You can choose to display no dialog boxes or prompts, or you can selectively avoid displaying certain dialog boxes that are normally used during a deinstallation.

Immediately Displaying the Inventory Dialog Box

Use the following commands to immediately display the Inventory dialog box, which allows you to select items for removal without navigating the Oracle Universal Installer startup screen:

setup.exe -deinstall -silent (on Windows)
./runInstaller -deinstall -silent (on UNIX)

Hiding the Inventory Dialog Box

If you want to hide the inventory dialog box during a deinstallation, you can specify the products to be removed in the DEINSTALL_LIST parameter of the response file; specify Oracle homes to be removed with the REMOVE_HOMES variable. For more information about response files, see "Installing with a Response File" .

See Chapter 3, "Customizing and Creating Response Files" for information about the DEINSTALL_LIST parameter.

As with other response file parameters, you can also specify the DEINSTALL_LIST parameter on the Oracle Universal Installer command line. For example, on a UNIX machine, enter:

./runInstaller -deinstall -silent DEINSTALL_LIST={"component1","1.0.1.2"}

To remove Oracle homes from the inventory, use the REMOVE_HOMES variable.

For more information about specifying response file parameters, see "Setting Response File Variables From the Command Line" .

Hiding the Deinstallation Confirmation and Progress Dialog Boxes

Use the following commands to hide the deinstallation confirmation and progress dialog boxes during a command line deinstallation:

On a Windows system:

setup.exe -deinstall -silent session:SHOW_DEINSTALL_PROGRESS=false
   session:SHOW_DESINSTALL_CONFIRMATION=false

On a UNIX system:

./runInstaller -deinstall -silent session:SHOW_DEINSTALL_PROGRESS=false
   session:SHOW_DESINSTALL_CONFIRMATION=false

Running Oracle Universal Installer After Installation

The following sections describe the different ways that Oracle Universal Installer can be used after installation. Specifically, this section describes:

Starting Oracle Universal Installer

Command Line Arguments

Using Oracle Universal Installer Exit Codes

Cloning Considerations

Starting Oracle Universal Installer

Oracle Universal Installer is installed on your system during the installation of your Oracle products:

\Program Files\Oracle\oui (on Windows)
At the same level as <oraInventory> (on UNIX)

For all platforms, the executable file (setup.exe or runInstaller.sh) is located in the following directory:

<oui_location>/bin

A new version of Oracle Universal Installer replaces its older version.

Oracle Universal Installer is placed under "Independent Products" in the Inventory panel as a "non-Oracle home" product.

To start Oracle Universal Installer:

On Windows platforms, select Start, Programs, Oracle Installation Products, Oracle Universal Installer.

On UNIX, execute ./runInstaller from the directory where it is installed.

For example: if the <oraInventory> is /u01/oracle/oraInventory, Oracle Universal Installer will be located at /u01/oracle/oui.

A runInstaller.sh script is also available, so that you can launch Oracle Universal Installer directly from a different directory.

When Oracle Universal Installer is first installed and run, it checks for the JRE path (the location from which it runs), using the location specified in the oraparam.ini file's JRE_LOCATION parameter. If Oracle Universal Installer cannot find the JRE specified, an error is returned.

Command Line Arguments

Following is the output from the runInstaller -help command, which gives you the full list of command line options and their descriptions, as well as command line variables usage:

Usage:
runInstaller [-options] [(<CommandLineVariable=Value>)*]
Where options include:
-clusterware oracle.crs,<crs version> Version of Cluster ready services installed.
-crsLocation <Path> Used only for cluster installs, specifies the path to the crs home
location. Specifying this overrides CRS information obtained from central inventory.
-invPtrLoc <full path of oraInst.loc> Unix only. To point to a different inventory location.The orainst.loc file contains:

inventory_loc=<location of central inventory>
inst_group=<>
-jreLoc <location> Path where Java Runtime Environment is installed. OUI cannot be run
 without it.
-logLevel <level> To filter log messages that have a lesser priority level than <level>.
 Valid options are: severe, warning, info, config, fine, finer, finest, basic, general,
 detailed, trace. The use of basic, general, detailed, trace is deprecated.
-paramFile <location of file> Specify location of oraparam.ini file to be used by OUI.
-responseFile <Path> Specifies the response file and path to use.
-sourceLoc  <location of products.xml> To specify the shiphome location.
-addLangs To add new languages to an already installed product.
-addNode For adding node(s) to the installation.
-attachHome For attaching homes to the OUI inventory.
-cfs Indicates that the Oracle home specified is on cluster file system
(shared). This is mandatory when '-local' is specified so that Oracle
Universal Installer can register the home appropriately into the inventory.
-clone For making an Oracle Home copy match its current environment.
-debug For getting the debug information from OUI.
-deinstall For deinstall operations.
-detachHome For detaching homes from the OUI inventory without deleting
inventory directory inside Oracle home.
-enableRollingUpgrade Used in cluster environment, to enable upgrade of a product on a
subset of nodes (on which the product was installed).
-executeSysPrereqs Execute system prerequisite checks and exit.
-force Allowing silent mode installation into a non-empty directory.
-help Displays above usage.
-ignorePatchConflicts Ignore all conflicts with existing interim patches during an
upgrade. The conflicting interim patches are removed from the home.
-ignoreSysPrereqs For ignoring the results of the system prerequisite checks.
-local Performs the operation on the local node irrespective of the
cluster nodes specified.
-printdiskusage Log debug information for disk usage.
-printmemory Log debug information for memory usage.
-printtime Log debug information for time usage.
-record -destinationFile <Path> For record mode operation, information is recorded in the
destination file path.
-removeallfiles For removing the home directory after deinstallation of all the components.
-removeAllPatches Remove all interim patches from the home
-silent For silent mode operations, the inputs can be a response file or a
list of command line variable value pairs.
-updateNodeList For updating node list for this home in the OUI inventory.
-waitforcompletion For windows. setup.exe will wait for completion instead of
spawning the java engine and exiting.
-nobackground Do not show background image
-noclusterEnabled No cluster nodes specified.
-noconsole For suppressing display of messages to console. Console is not
allocated.
-nowarningonremovefiles To disable the warning message before removal of home directory.
-nowait For windows. Do not wait for user to hit Enter on the console
after the task (install etc.) is complete.
-formCluster To install the Oracle clusterware in order to form the cluster.
-remotecp <Path> Unix specific option. Used only for cluster installs, specifies
the path to the remote copy program on the local cluster node.
-remoteshell <Path> Unix specific option. Used only for cluster installs, specifies
the path to the remote shell program on the local cluster node.

Command Line Variables Usage
Command line variables are specified using <name=value>; for example:
[ session: | compName: | compName:version: ]variableName="valueOfVariable"]

Session/Installer variables are specified using:
[session:]varName=value
Ex 1: session:ORACLE_HOME_NAME="OraHome"
Ex 2: ORACLE_HOME_NAME="OraHome"
The lookup order is session:varName then just varName).
The session prefix is used to avoid ambiguity.

Component variables are specified using:
[compInternalName:[Version:]]varName
Ex 1: oracle.comp1:1.0.1:varName="VarValue"
Ex 2: oracle.comp1:varName="VarValue"
Ex 2: oracle.comp1:varName="VarValue"
The lookup order is compInternalName:Version:varName, then compInternalName:varName, then just varName.

Using Oracle Universal Installer Exit Codes

If you are starting and stopping Oracle Universal Installer programmatically (for example, by invoking Oracle Universal Installer using a response file), you may need to consider the exit codes Oracle Universal Installer generates, and perform a particular action depending on the code Oracle Universal Installer returns.

Oracle Universal Installer returns one of the following exit codes:

Code | Description
0 | All installations were successful.
1 | All installations were successful, but some optional configuration tools failed.
2 | Local installations were successful, but some remote operations failed.
-1 | At least one installation failed.

Note that:

This feature does not work if Oracle Universal Installer is running in "bootstrap" mode. In this case, setup.exe/runInstaller just launches the JRE process and returns immediately without waiting for the exit code. Oracle Universal Installer runs in "bootstrap" mode if the following line exists in the oraparam.ini file:

BOOTSTRAP=TRUE

If you exit without installing any products (for example if you exit from the "Welcome" screen), the exit code is -1.

Cloning Considerations

You can copy an existing Oracle home, then configure it for its new environment. This process is called "cloning."

Note:

Patching and deinstallation on a cloned Oracle home act the same as a regularly installed Oracle home. You can directly patch a cloned installation.

Invoke Oracle Universal Installer in clone mode using the following command:

./runInstaller -clone ORACLE_HOME="<target location>" ORACLE_HOME_NAME="<unique name on node>" [-responseFile <full path>]

Use setup.exe instead of runInstaller for Windows machines. The -responseFile parameter is optional. You can supply clone-time parameters on the command line or through the response file named on the command line.

Clone-time activity is logged in the cloneActions<timestamp>.log file at installation time.

For more information on cloning see Chapter 6, "Cloning Oracle Software".

Note:

Because most cloning is done in silent mode, when cloning an Oracle home onto a "clean" host (one that has no oraInst.loc file), Oracle Universal Installer creates a Central Inventory in the location specified by the INVENTORY_LOCATION variable. If this variable is not specified, Oracle Universal Installer creates the Central Inventory in the <cloned_home>/oraInventory directory.

After cloning is finished, you must run oraInstRoot.sh as root to move oraInventory to the final, desired location.

About Oracle Universal Installer Log Files

When you install or deinstall products using Oracle Universal Installer, important information about each installation is saved not only in the inventory, but also in a series of log files, located in the following directory:

$ORACLE_HOME/cfgtoollogs

You can use these log files to troubleshoot installation problems. These files are also crucial for removing and configuring the various software components you install on your Windows or UNIX computer. Oracle Universal Installer displays the name and location of the current session's log file on the Install page. Each installation or configuration utility provides a separate folder containing the logs inside the $ORACLE_HOME/cfgtoollogs folder.

Note that the logs used to remove products are different from the installActions<timestamp>.log generated during the install process. The installActions<timestamp>.log is easier to read and can be used to view the operations performed at installation time.

For more information about the log files generated by Oracle Universal Installer, see the online help. For more information about using the online help, see "Getting Help While Installing Oracle Products".

5 Installing Cluster Environments

A cluster installation uses Oracle Universal Installer to install software on the nodes of a cluster that are network reachable and bound together by Oracle Clusterware. You can use Oracle Universal Installer to extend the Oracle home of a product installation to include additional nodes on the cluster.

This chapter includes the following sections:

Oracle Universal Installer and Real Application Clusters

General System Installation Requirements for Real Application Clusters

Cluster Setup and Pre-installation Configuration Tasks for Real Application Clusters

Pre-installation Tasks for Real Application Clusters on UNIX

Pre-installation Tasks for Real Application Clusters on Windows

Configuring Storage for Oracle Clusterware

Installing Oracle Clusterware on UNIX

Installing Oracle Clusterware on Windows

Adding More Nodes to the Cluster for Mass Deployment

Installing Product Software on a Cluster

Command Line Options for Cluster Installations (UNIX Only)

Patchsets and Upgrades

Post-installation Tasks

Deinstalling Real Application Clusters Software

Converting Single-instance Nodes to Real Application Clusters

Troubleshooting Real Application Clusters / Oracle Clusterware Installation

Oracle Universal Installer and Real Application Clusters

The Oracle Universal Installer facilitates the installation of Oracle Clusterware. In most cases, you use the graphical user interface (GUI) provided by the Oracle Universal Installer to install the software. However, you can also use the Oracle Universal Installer to complete non-interactive (or "silent") installations, without using the GUI.

The Oracle inventory maintains records of Oracle software versions and patches. Each installation has a Central Inventory where the Oracle home is registered. Oracle software installations have a local home directory, whose path location is recorded in the Central Inventory. The local inventory directory for each Oracle software installation contains a list of components and applied interim patches associated with that software. Because faulty inventory information can corrupt your Oracle software installation, the Oracle Universal Installer must perform all read and write operations on Oracle inventories. Ensure that you do not modify files in the Central Inventory or the Oracle home inventory.

When you install Oracle Clusterware or Real Application Clusters, the Oracle Universal Installer copies the Oracle software onto the node from which you are running it. If your Oracle home is not on a shared file system, the Oracle Universal Installer propagates the software onto the other nodes that you have selected to be part of your Oracle Universal Installer installation session. The Oracle inventory maintains a list of each node that is a member of the Real Application Clusters database, and lists the paths to each node's Oracle home. This is used to maintain patches and updates for each member node of the Real Application Clusters database.

When the Oracle Universal Installer installs the Oracle software, Oracle recommends that you select a preconfigured database, or use the Database Configuration Assistant (DBCA) interactively to create your cluster database. You can also manually create your database as described in procedures posted on the Oracle Technical Network, which is at the following URL:

http://www.oracle.com/technology/index.htm

Oracle recommends that you use Automatic Storage Management (ASM). If you are not using ASM, or if you are not using a cluster file system, then configure shared raw devices before you create your database.

Oracle software provides additional components to operate Real Application Clusters. Some of the Real Application Clusters-specific components include:

Oracle Clusterware

Installed Real Application Clusters Components

Oracle Clusterware

The Oracle Universal Installer installs Oracle Clusterware on each node on which the Oracle Universal Installer detects that third-party vendor clusterware is present. If third-party vendor clusterware is not present, you must use the Oracle Universal Installer to enter the nodes on which you want the Oracle Clusterware to be installed. The Oracle Clusterware home can be either shared by all nodes, or private to each node, depending on your responses when you run the Oracle Universal Installer.

When third-party vendor clusterware is present, Oracle Clusterware can interact with the third-party vendor clusterware. In using third-party vendor clusterware, note that Oracle Clusterware can integrate with third-party vendor clusterware for all operating systems except Linux and Windows. You need to have Oracle Cluster Registry and Voting Disks shared across all nodes.

Installed Real Application Clusters Components

All instances in Real Application Clusters environment share the control file, server parameter file, redo log files, and all data files. These files reside on a shared cluster file system or on shared disks. Either of these types of file configurations are accessed by all the cluster database instances. Each instance also has its own set of redo log files. During failures, shared access to redo log files enables surviving instances to perform recovery.

General System Installation Requirements for Real Application Clusters

Each node that is going to be part of your Real Application Clusters installation must meet the following hardware and software requirements. You will perform step-by-step tasks for hardware and software verification for the platform-specific pre-installation procedures.

Hardware Requirements for Real Application Clusters Setup

Each node in a cluster requires the following hardware:

External shared disks for storing the Oracle Clusterware files.

See the Oracle Real Application Clusters Installation Guide 11g Release 1 (11.1) for information on the available disk configuration options. Review these options before you decide which storage option to use in your Real Application Clusters environment.

One private Internet protocol (IP) address for each node to serve as the private interconnect. The following must be true for each private IP address:

– It must be separate from the public network.– It must be accessible on the same network interface on each node.– It must have a unique address on each node.The private interconnect is used for inter-node communication by both Oracle Clusterware and Real Application Clusters. If the private address is available from a network name server (DNS), you can use that name. Otherwise, the private IP address must be available in each node's /etc/hosts file on UNIX and %SystemRoot%\system32\drivers\etc\hosts on Windows.

During Oracle Clusterware installation, the information you enter as the private IP address determines which private interconnects are used by Real Application Clusters database instances.

One public IP address for each node to be used as the Virtual IP address for client connections and for connection failover.

This public Virtual IP address (VIP) must be associated with the same interface name on every node that is part of your cluster. Additionally, the IP addresses that you use for all of the nodes that are part of a cluster must be from the same subnet. If you have a domain name server (DNS), register the host names for the VIP with DNS. The Virtual IP address should not be in use at the time of the installation, because this is a Virtual IP address that Oracle manages.

One public fixed host name address for each node, typically assigned by the system administrator during operating system installation. If you have a DNS, register both the fixed IP and the VIP address with DNS. If you do not have DNS, you must make sure that both public IP addresses are in the node host file.

Software Requirements for Real Application Clusters Setup

Each node in a cluster requires a supported interconnect software protocol to support Cache Fusion, and to support Oracle Clusterware polling. Your interconnect must be certified by Oracle for your platform. You should also have a Web browser, both to enable Oracle Enterprise Manager, and to view online documentation. For Oracle Database 11g requirements, Oracle Clusterware provides the same functionality as third-party vendor clusterware. Using Oracle Clusterware also reduces installation and support complications. However, you may require third-party vendor clusterware if you use a non-ethernet interconnect, or if you have deployed clusterware-dependent applications on the same cluster where you deploy Real Application Clusters.

Cluster Setup and Pre-installation Configuration Tasks for Real Application Clusters

Before installing Real Application Clusters, perform the following procedures:

Ensure that you have a certified combination of operating system and Oracle software version by referring to the OracleMetaLink certification information, which is located at the following Web site:

http://metalink.oracle.com

Click Certify & Availability, and select 1.View Certifications by Product.

Note:

The layout of the OracleMetaLink site and the site's certification policies are subject to change.

Configure a high-speed interconnect that uses a private network. Some platforms support automatic failover to an additional interconnect.

Determine the storage option for your system and configure the shared disk.

Ensure that the directory structure is similar in all nodes.

Ensure that all nodes in the cluster have the same time zone settings.

Install the operating system patches for the Oracle software. For more information, see the Oracle Real Application Clusters Installation Guide 11g Release 1 (11.1).

Pre-installation Tasks for Real Application Clusters on UNIX

You need to complete the following pre-installation tasks before you start the Oracle Universal Installer:

Logging In to the System as root

Before you install the Oracle software, you must complete several tasks as the root user. To log in as the root user, complete one of the following procedures:

If you are installing the software from an X Window System workstation or X terminal, then:

Start a local terminal session, for example, an X terminal (xterm).

If you are not installing the software on the local system, enter the following command to enable remote hosts to display X applications on the local X server:

$ xhost +

If you are not installing the software on the local system, use the ssh, rlogin, or telnet command to connect to the system where you want to install the software:

$ telnet remote_host

If you are not logged in as the root user, enter the following command to switch user to root:

$ su - root
password:
#

If you are installing the software from a PC or other system with X server software installed:

Start the X server software.

Configure the security settings of the X server software to permit remote hosts to display X applications on the local system.

Connect to the remote system where you want to install the software and start a terminal session on that system, for example, an X terminal (xterm).

If you are not logged in as the root user on the remote system, enter the following command to switch user to root:

$ su - root
password:
#

Creating Required UNIX Groups and Users

Depending on whether it is the first time an Oracle software product is being installed on a system and on the products that you are installing, you may need to create several UNIX groups and a UNIX user account. The following UNIX group and users are required for all installations:

The Oracle Inventory group (oinstall)

You must create this group the first time you install Oracle software on the system. The usual name chosen for this group is oinstall. This group owns the Oracle inventory, which is a catalog of all Oracle software installed on the system.

Note:

If Oracle software is already installed on the system, the existing Oracle Inventory group must be the primary group of the UNIX user that you use to install new Oracle software. The following sections describe how to identify an existing Oracle Inventory group.

The Oracle software owner user (oracle)

You must create this user the first time you install Oracle software on the system. This user owns all of the software installed during the installation. The usual name chosen for this user is oracle. This user must have the Oracle Inventory group as its primary group.

You need to create other groups and users in addition to the ones created above. For more information on creating the required groups and users, see the Oracle Real Application Clusters Installation Guide 11g Release 1 (11.1).

Creating Identical Users and Groups on Other Cluster Nodes

The Oracle software users and groups must exist and be identical on all cluster nodes. To create these identical users and groups, you must identify the user ID and group IDs assigned to them on the node where you created them, then create the user and groups with the same name and ID on the other cluster nodes. You must create identical users and groups on other cluster nodes only if you are using local users and groups. If you are using users and groups defined in a directory service such as NIS, they are already identical on each cluster node.

Identifying the User and Group IDs

To determine the user ID (UID) and the group IDs (GID) for the groups, follow these steps:

Enter following command:

# id oracle

The output from this command is similar to the following:

uid=440(oracle) gid=200(oinstall) groups=201(dba),202(oper)

From the output, identify the user identity (UID) for the Oracle user and the group identities (GIDs) for the groups to which it belongs.

Creating the User and Groups on the Other Cluster Nodes

To create the user and groups on the other cluster nodes, repeat the following procedure on each node:

Log in to the cluster node in which you want to create the user and groups as root.

Enter commands as per the syntax to create the respective groups. Use the -g option to specify the correct GID for each group:

# /usr/sbin/groupadd -g <group_id> <group_name>

Configuring SSH on all Cluster Nodes

Before you install and use Oracle Real Application Clusters, you must configure secure shell (SSH) for the oracle user on all cluster nodes. Oracle Universal Installer uses the ssh and scp commands during installation to run remote commands on and copy files to the other cluster nodes. You must configure SSH so that these commands do not prompt for a password.

Note:

This section describes how to configure OpenSSH version 3. If SSH is not available, then Oracle Universal Installer attempts to use rsh and rcp instead. However, these services are disabled by default on most Linux systems.

Configuring SSH on Cluster Member Nodes

To configure SSH, complete the following steps on each cluster node:

Log in as the Oracle user.

If necessary, create the .ssh directory in the Oracle user's home directory and set the correct permissions for it:

$ mkdir ~/.ssh
$ chmod 700 ~/.ssh

Enter the following commands to generate an RSA key for version 2 of the SSH protocol:

$ /usr/bin/ssh-keygen -t rsa

At the prompts:

Accept the default location for the key file.

Enter and confirm a different pass phrase from the Oracle user's password.

This command writes the public key to the ~/.ssh/id_rsa.pub file and the private key to the ~/.ssh/id_rsa file. Never distribute the private key to anyone.

Enter the following command to generate a DSA key for version 2 of the SSH protocol:

$ /usr/bin/ssh-keygen -t dsa

At the prompts:

Accept the default location for the key file.

Enter and confirm a pass phrase that is different from the Oracle user's password.

This command writes the public key to the ~/.ssh/id_dsa.pub file and the private key to the ~/.ssh/id_dsa file. Never distribute the private key to anyone.

Copy the contents of the ~/.ssh/id_rsa.pub and ~/.ssh/id_dsa.pub files to the ~/.ssh/authorized_keys file on this node and to the same file on all other cluster nodes.

Note:

The ~/.ssh/authorized_keys file on every node must contain the contents from all of the ~/.ssh/id_rsa.pub and ~/.ssh/id_dsa.pub files that you generated on all cluster nodes.

Change the permissions on the ~/.ssh/authorized_keys file on all cluster nodes:

$ chmod 600 ~/.ssh/authorized_keys

At this point, if you use ssh to log in to or run a command on another node, you are prompted for the pass phrase that you specified when you created the DSA key.

Enabling SSH User Equivalency on Cluster Member Nodes

To enable Oracle Universal Installer to use the ssh and scp commands without being prompted for a pass phrase, follow these steps:

On the system where you want to run Oracle Universal Installer, log in as the Oracle user.

Enter the following commands:

$ exec /usr/bin/ssh-agent $SHELL
$ /usr/bin/ssh-add

At the prompts, enter the pass phrase for each key that you generated.

If you have configured SSH correctly, then you can use the ssh or scp commands without being prompted for a password or a pass phrase.

To test the SSH configuration, enter the following commands from the same terminal session, testing the configuration of each cluster node:

$ ssh nodename1 date
$ ssh nodename2 date
.
.

These commands should display the date set on each node. If any node prompts for a password or pass phrase, verify that the ~/.ssh/authorized_keys file on that node contains the correct public keys.

Note:

The first time you use SSH to connect to a node from a particular system, you might see a message stating that the authenticity of the host could not be established. Enter yes at the prompt to continue. You should not see this message again when you connect from this system to that node.

If you see any other messages or text, apart from the date, the installation can fail. Make any changes required to ensure that only the date is displayed when you enter these commands.

You should ensure that any parts of login scripts that generate any output, or ask any questions, are modified so that they only act when the shell is an interactive shell.

To ensure that X11 forwarding does not cause the installation to fail, create a user-level SSH client configuration file for the Oracle software owner user, as follows:

Using any text editor, edit or create the ~oracle/.ssh/config file.

Make sure that the ForwardX11 attribute is set to no. For example:

Host *
ForwardX11 no

You must run Oracle Universal Installer from this session or remember to repeat steps 2 and 3 before you start Oracle Universal Installer from a different terminal session.

Preventing Oracle Clusterware Installation Errors Caused by stty Commands

During an Oracle Clusterware installation, the Oracle Universal Installer uses SSH (if available) to run commands and copy files to the other nodes. During the installation, hidden files on the system (for example, .bashrc or .cshrc) can cause installation errors if they contain stty commands.

To avoid this problem, Oracle recommends that you modify these files to suppress all output on STDERR, as in the following examples:

Bourne, Bash, or Korn shell:

if [ -t 0 ]; then
stty intr ^C
fi

C shell:

test -t 0
if ($status == 0) then
stty intr ^C
endif

Note:

When SSH is not available, the Installer uses the rsh and rcp commands instead of ssh and scp. This error can also occur if the remote shells load hidden files that contain stty commands.

Configuring the Oracle User Environment

You run Oracle Universal Installer from the oracle account. However, before you start Oracle Universal Installer you must configure the environment of the oracle user. For more information on configuring the environment, see the Oracle Real Application Clusters Installation Guide 11g Release 1 (11.1).

Checking the Hardware Requirements

Each system must meet certain minimum hardware requirements. For more information on hardware requirements, see the Oracle Real Application Clusters Installation Guide 11g Release 1 (11.1).

Checking the Network Requirements

There are some minimum networking hardware and Internet protocol (IP) address requirements. Check that you have the networking hardware and Internet protocol (IP) address required for an Oracle Real Application Clusters installation.

Network Hardware Requirements

Each node in the cluster must meet the following requirements:

Each node must have at least two network adapters: one for the public network interface and one for the private network interface (the interconnect).

The interface names associated with the network adapters for each network must be the same on all nodes.

For increased reliability, you can configure redundant public and private network adapters for each node.

For the public network, each network adapter must support TCP/IP.

For the private network, the interconnect must support the user datagram protocol (UDP) using high-speed network adapters and switches that support TCP/IP (Gigabit Ethernet or better recommended).

Note:

UDP is the default interconnect protocol for Real Application Clusters and TCP is the interconnect protocol for Oracle Clusterware. Token-Ring is not supported for the interconnect.

For the private network, the end points of all designated interconnect interfaces must be completely reachable on the network.

Network Parameter Requirements

If you are using NFS, then you must set the values for the NFS buffer size parameters rsize and wsize to at least 16384. Oracle recommends that you use the value 32768.

IP Address Requirements

Before starting the installation, you must identify or obtain the following IP addresses for each node:

An IP address and an associated host name registered in the domain name service (DNS) for each public network interface.

One unused virtual IP address and an associated virtual host name registered in DNS, or resolved in the host file, or both, that you will configure for the primary public network interface.

The virtual IP address must be in the same subnet as the associated public interface. After installation, you can configure clients to use the virtual host name or IP address. If a node fails, then its virtual IP address fails over to another node.

A private IP address and optional host name for each private interface.

Oracle recommends that you use non-routable IP addresses for the private interfaces; for example: 10.*.*.* or 192.168.*.*. You can use the /etc/hosts file on each node to associate private host names with private IP addresses.

Node Time Requirements

Before starting the installation, ensure that each member node of the cluster is set as closely as possible to the same date and time. Oracle strongly recommends using the Network Time Protocol feature of most operating systems for this purpose, with all nodes using the same reference Network Time Protocol server.

Checking Software Requirements

The Oracle Universal Installer performs checks on your system to verify that it meets the requirements listed for your platform. To ensure that these checks pass, verify the requirements before you start the Installer.

Depending on the Oracle products that you intend to install, verify that the required software is installed on the system. For more information on software requirements, see the Oracle Real Application Clusters Installation Guide 11g Release 1 (11.1).

Configuring Kernel Parameters

Each cluster node must meet the recommended kernel values. For information on verifying and setting the kernel parameters, see the Oracle Real Application Clusters Installation Guide 11g Release 1 (11.1).

Identifying Required Software Directories

You must identify or create the following directories for the Oracle software as follows:

Oracle Base Directory

Oracle Inventory Directory

Oracle Clusterware Home Directory

Oracle Home Directory

The following subsections describe the requirements for these directories.

Oracle Base Directory

The Oracle base directory acts as a top-level directory for Oracle software installations. It is analogous to the C:\Oracle directory used for Oracle software installations on Windows systems. On UNIX systems, the Optimal Flexible Architecture (OFA) guidelines recommend that you use a path similar to the following for the Oracle base directory:

/mount_point/app/oracle_sw_owner

In this example:

mount_point is the mount point directory for the file system that will contain the Oracle software.

The examples in this guide use /u01 for the mount point directory. However, you could choose another mount point directory, such as /oracle or /opt/oracle for example.

oracle_sw_owner is the operating system user name of the Oracle software owner, for example oracle.

You can use the same Oracle base directory for more than one installation, or you can create separate Oracle base directories for different installations. If different operating system users install Oracle software on the same system, each user must create a separate Oracle base directory. The following example Oracle base directories could all exist on the same system:

/u01/app/oracle

/u01/app/orauser

/opt/oracle/app/oracle

Regardless of whether you create an Oracle base directory or decide to use an existing one, you must set the ORACLE_BASE environment variable to specify the full path to this directory.

Note:

The Oracle base directory can be on a local file system or on an NFS file system on a certified NAS device. Do not create the Oracle base directory on an OCFS version 1 file system.

Oracle Inventory Directory

The Oracle Inventory directory (oraInventory) stores an inventory of all software installed on the system. It is required by, and shared by, all Oracle software installations on a single system. The first time you install Oracle software on a system, Oracle Universal Installer prompts you to specify the path to this directory. If you are installing the software on a local file system, Oracle recommends that you choose the following path:

oracle_base/oraInventory

If the Oracle base directory is on a cluster file system, or on an NFS file system on a NAS device, you must specify a path for the Oracle Inventory directory on a local file system. The Oracle base directory must be on a local file system to enable all of the nodes to have separate inventories.

Oracle Universal Installer creates the directory that you specify, and sets the correct owner, group, and permissions for it. You do not need to create it.

Note:

All Oracle software installations rely on the Oracle base directory. Make sure that you back it up regularly.

Do not delete the Oracle base directory unless you have completely removed all Oracle software from the system.

Oracle Clusterware Home Directory

The Oracle Clusterware home directory is the directory where you choose to install the software for Oracle Clusterware. You must install Oracle Clusterware in a separate home directory. When you run Oracle Universal Installer, it prompts you to specify the path to this directory, as well as a name that identifies it. Oracle recommends that you specify a path similar to the following for the Oracle Clusterware home directory:

/u01/crs/oracle/product/11.1.0/app

Note:

Because you must change the permissions of all of the parent directories of the Oracle Clusterware home directory after installing the software to grant write access only to the root user, the Oracle Clusterware home directory must not be a subdirectory of the Oracle base directory.

Oracle Home Directory

The Oracle home directory is the directory where you choose to install the software for a particular Oracle product. You must install different Oracle products, or different releases of the same Oracle product, in separate Oracle home directories. When you run Oracle Universal Installer, it prompts you to specify the path to this directory, as well as a name that identifies it. The directory that you specify must be a subdirectory of the Oracle base directory. Oracle recommends that you specify a path similar to the following for the Oracle home directory:

oracle_base/product/11.1.0/db_1

Oracle Universal Installer creates the directory path that you specify under the Oracle base directory. It also sets the correct owner, group, and permissions on it. You do not need to create this directory.

Identifying or Creating an Oracle Base Directory

Before starting the installation, you must either identify an existing Oracle base directory or, if required, create one. For more information on identifying or creating an Oracle Base Directory, see the Oracle Real Application Clusters Installation Guide 11g Release 1 (11.1).

Creating the Clusterware Home Directory

Oracle Universal Installer creates the Oracle Clusterware home directory for you. Ensure before you start the installation that you provide sufficient disk space on a file system for the Oracle Clusterware directory, and the parent directory of the Oracle Clusterware directory space is writable by the Oracle user.

To create the Oracle Clusterware home directory and specify the correct owner, group, and permissions for it, follow these steps:

Enter commands similar to the following to create the recommended subdirectories in the mount point directory that you identified, and set the appropriate owner, group, and permissions on them:

# mkdir -p /mount_point/crs/oracle_sw_owner/product/11.1.0/crs
# chown -R root:oinstall /mount_point/crs
# chmod -R 775 /mount_point/crs/oracle_sw_owner

If the mount point you identified is /u01, the recommended Oracle Clusterware home directory path is as follows:

/u01/crs/oracle/product/11.1.0/crs

If necessary, repeat the commands listed in the previous step to create the same directory on the other nodes in the cluster.

Enter commands similar to the following to set the ORACLE_BASE and ORACLE_HOME environment variables in preparation for the Oracle Clusterware installation:

Bourne, Bash, or Korn shell:

$ ORACLE_BASE=/u01/app/oracle
$ ORACLE_HOME=/u01/crs/oracle/product/11.1.0/crs
$ export ORACLE_BASE
$ export ORACLE_HOME

C shell:

% setenv ORACLE_BASE /u01/app/oracle
% setenv ORACLE_HOME /u01/crs/oracle/product/11.1.0/crs

Enter the following commands to ensure that the TNS_ADMIN environment variable is not set:

Bourne, Bash, or Korn shell:

$ unset TNS_ADMIN

C shell:

% unsetenv TNS_ADMIN

To verify that the environment has been set correctly, enter the following commands:

$ umask
$ env | more

Verify that the umask command displays a value of 22, 022, or 0022, and the environment variables that you set in this section have the correct values.

Pre-installation Tasks for Real Application Clusters on Windows

You need to complete the following pre-installation tasks before you start the Oracle Universal Installer to install Oracle Clusterware and Oracle Real Application Clusters on Microsoft Windows systems.

Checking Hardware and Software Certification

Oracle recommends you to review the certification matrix on the OracleMetaLink Web site for the most up-to-date list of certified hardware platforms and operating system versions for Oracle software. This Web site also provides patches and workaround information for bugs. For more information on accessing the OracleMetaLink site, see "Download and Install Patches".

Checking the Hardware Requirements

Each system must meet minimum hardware requirements. For more information on hardware requirements and the steps involved to check them, see the Oracle Real Application Clusters Installation Guide 11g Release 1 (11.1).

Hard Disk Space Requirements

Each system must meet certain hard disk space requirements. For more information on hard disk space requirements, see the Oracle Real Application Clusters Installation Guide 11g Release 1 (11.1).

Checking the Software Requirements

Each system must meet minimum software requirements. For more information on software requirements and the steps involved to check them, see the Oracle Real Application Clusters Installation Guide 11g Release 1 (11.1).

Checking the Network Requirements

There are some minimum networking hardware and Internet protocol (IP) address requirements. Check that you have the networking hardware and Internet protocol (IP) address required for an Oracle Real Application Clusters installation. For more information on the steps involved in checking these requirements, see the Oracle Real Application Clusters Installation Guide 11g Release 1 (11.1).

Network Hardware Requirements

Each node in the cluster must meet the following requirements:

Each node must have at least two network adapters: one for the public network interface and one for the private network interface (the interconnect).

The private and public network interface names must be different from each other and cannot contain any multibyte language characters. The names are case-sensitive.

The private network interface name must be the same on all nodes.

The public network interface name must be the same on all nodes.

The public interface must be listed first in the ipconfig list.

Oracle supports the TCP/IP protocol for the public and private networks.

IP Address Requirements

Before starting the installation, you must identify or obtain the following IP addresses for each node:

An IP address and an associated host name registered in the domain name service (DNS) for each public network interface.

One unused virtual IP address and an associated virtual host name registered in DNS that you will configure for the primary public network interface.

The virtual IP address must be in the same subnet as the associated public interface. After installation, you can configure clients to use the virtual host name or IP address. If a node fails, then its virtual IP address fails over to another node.

A private IP address and optional host name for each private interface.

Oracle recommends that you use private network IP addresses for the private interfaces; for example: 10.*.*.* or 192.168.*.*. You can use the %SystemRoot%\system32\drivers\etc\hosts file on each node to associate private host names with private IP addresses.

Checking Individual Component Requirements

Depending on the Oracle products that you intend to install, verify the required components for the Oracle software you are installing and ensure they are installed on the system. You can find more information on the components in the Oracle Real Application Clusters Installation Guide 11g Release 1 (11.1).

Configuring Storage for Oracle Clusterware

You need to perform certain storage configuration tasks before you start Oracle Universal Installer. For detailed information on the storage configuration tasks, see the Oracle Real Application Clusters Installation Guide 11g Release 1 (11.1).

Installing Oracle Clusterware on UNIX

This section provides you with information about how to use the Oracle Universal Installer to install Oracle Clusterware on UNIX.

Running the Oracle Universal Installer to Install Oracle Clusterware

Complete the following steps to install Oracle Clusterware on your cluster. At any time during installation, if you have a question about what you are being asked to do, click Help in the Oracle Universal Installer page.

Start the runInstaller command with the -formCluster option from the main directory on the Oracle Clusterware 11g Release 1 (11.1) CD-ROM. This is a separate CD that contains the Oracle Clusterware software. When the Oracle Universal Installer displays the Welcome page, click Next.

Oracle Universal Installer displays the Installation Prerequisite Checks page. This screen shows the name, type, and status for all prerequisite checks designed for the installation. Click Next.

Oracle Universal Installer displays the Specify Cluster Nodes for Node Addition page. Specify public, private, virtual IPs in this page and click Next.

Oracle Universal Installer displays the Specify Local Host Name page. Specify at least one public and one private interface in this page and click Next.

Specify the Oracle Cluster Registry location option to provide a redundant OCR location and click Next.

Specify the VD (Voting Disk Location) location option to provide redundant VD locations and click Next.

Oracle Universal Installer displays the Summary page. Click Install and proceed.

After the installation is done, Oracle Universal Installer prompts you to run orainstRoot.sh and root.sh. You need to run these scripts and click OK.

After you run root.sh on all of the nodes, the Oracle Universal Installer runs the Oracle Notification Server Configuration Assistant and Oracle Private Interconnect Configuration Assistant. These assistants run without user intervention.

Oracle Universal Installer displays the End of Installation page. Click Exit.

Running the Oracle Universal Installer in Silent Mode to Install Oracle Clusterware

You can run the Oracle Universal Installer in silent mode to install Oracle Clusterware by entering the following command:

./runInstaller -silent -responseFile <response file path>

For Oracle Clusterware, you need to use the -formCluster flag. You can pass session variables like nodelist, ocr, voting disk location, and so forth from the command line for silent installation.

Oracle Clusterware Background Processes

The following processes must be running in your environment after the Oracle Clusterware installation for Oracle Clusterware to function:

oprocd — Process monitor for the cluster.

evmd — Event manager daemon that starts the racgevt process to manage call-outs.

ocssd — Manages cluster node membership and runs as the Oracle user; failure of this process results in node restart.

crsd — Performs high availability recovery and management operations such as maintaining the OCR. Also manages application resources and runs as the root user and restarts automatically upon failure.

Installing Oracle Clusterware on Windows

This section provides you with information about how to use the Oracle Universal Installer to install Oracle Clusterware on Windows.

Running the Oracle Universal Installer to Install Oracle Clusterware

Complete the following steps to install Oracle Clusterware on your cluster. At any time during installation, if you have a question about what you are being asked to do, click Help in the Oracle Universal Installer page.

Log in to Windows with Administrative privileges and run the setup.exe command on the Oracle Clusterware media. This opens the Oracle Universal Installer Welcome page.

After you click Next in the Welcome page, the Specify File Locations page allows you to accept the displayed path name for the Oracle Clusterware products or select a different one. You can also accept default directory and path name for the location of your Clusterware home or browse for an alternate directory and destination. You must select a destination that exists on each cluster node that is part of this installation. Click Next to confirm your choices and proceed to the Language Selection page.

Select the language or languages for your Oracle Clusterware installation in the Language Selection page, then click Next for the Cluster Configuration page.

The Cluster Configuration page contains predefined node information if the Oracle Universal Installer detects that your system has the Oracle 10g Release 2 Clusterware. Otherwise, the Oracle Universal Installer displays the Cluster Configuration page without predefined node information.

Provide your own cluster name if you do not want to use the name provided by the Oracle Universal Installer. Note that the selected cluster name must be globally unique throughout the enterprise, and its allowable character set is the same as that for host names; that is, underscores (_), hyphens (-), and single-byte alphanumeric characters (a to z, A to Z, and 0 to 9).

Enter a public and a private host name for each node. Neither the public nor the private name should have a domain qualifier. When you enter the public host name, use the primary host name of each node; that is, the name displayed by the hostname command. The private node refers to an address that is only accessible by the other nodes in this cluster, and which Oracle uses for Cache Fusion processing. You can enter either a private host name or a private IP address for each node.

Click Next after you have entered the cluster configuration information. This saves your entries and opens the Specify Network Interface Usage page.

In the Specify Network Interface Usage page, the Oracle Universal Installer displays a list of cluster-wide interfaces. Use the drop-down menus on this page to classify each interface as Public, Private, or Do Not Use. The default setting for each interface is Do Not Use. You must classify at least one interconnect as Public and one as Private. Click Next when you have made your selections to open the Select Disk Formatting Options page.

In the Select Disk Formatting Options page, you indicate what OCFS you want the Oracle Universal Installer to format for you.

The formatting options are as follows:

Format two logical drives for data and software storage. In this case, the Oracle Universal Installer creates two cluster file systems, one for the database files and one for the Oracle home. The OCR and voting disk are created in the data file directory.

Format one logical drive for software storage. In this case, the Oracle Universal Installer creates one cluster file system for the Oracle home and requires two additional partitions, one for the OCR and one for the voting disk. If you select this option, you must have already configured the partitions before proceeding with the installation. These partitions are stamped with "ocrcfg" for the OCR and "votedsk" for the voting disk.

Format one logical drive for data file storage. In this case, the Oracle Universal Installer creates one cluster file system for the database files which is also used to store the OCR and voting disk.

Do not format any logical drives. In this case, the Oracle Universal Installer requires two partitions: one for the OCR and one for the voting disk. If you select this option, you must have already configured the partitions before proceeding with the installation. These partitions are stamped with "ocrcfg" for the OCR and "votedsk" for the voting disk.

Click Next after making your selection in the Select Disk Formatting Options page. The next page that the Oracle Universal Installer displays depends on your selection on the Select Disk Formatting Options page, as described in the following step.

If you selected the "Format two logical drives for data and software storage" option on the Select Disk Formatting Options page, you must complete the Select Software Storage Drive page and the Select Data Storage Drive page as described in Steps a and b, respectively.

If you selected the "Format one logical drive for software storage" option on the Select Disk Formatting Options page, you must complete the Select Software Storage Drive page, the Disk Configuration - Oracle Cluster Registry (OCR) page, and the Disk Configuration - Voting Disk page as described in Steps a, c, and d, respectively.

If you selected the "Format one logical drive for data file storage" option on the Select Disk Formatting Options page, you must complete the Select Data Storage Drive page as described in Step b.

If you selected the "Do not format any logical drives" option on the Select Disk Formatting Options page, you must complete the Disk Configuration - Oracle Cluster Registry (OCR) page and the Disk Configuration - Voting Disk page as described in Steps c and d, respectively.

On the Select Software Storage Drive page, choose a shared drive to see a list of available partitions on that drive. Choose a partition with sufficient space to hold your Oracle home and select the partition's disk number and partition number from the list. Click Next to proceed.

On the Select Data Storage Drive page, choose a shared drive to see a list of available partitions on that drive. Choose a partition with sufficient space to hold your database files and select the partition's disk number and partition number from the list. Click Next to proceed.

On the Disk Configuration - Oracle Cluster Registry (OCR) page, choose a partition with sufficient space to hold your OCR and select the partition's disk number and partition number from the list. Click Next to proceed.

On the Disk Configuration - Voting Disk page, choose a partition with sufficient space to hold your voting disk and select the partition's disk number and partition number from the list. Click Next to proceed.

Note:

The Oracle Universal Installer pages described in this step displays logical drives from which you must make your selections. To be valid for selection, a logical drive must be located on a disk without a primary partition.

After you click Next, the Oracle Universal Installer checks whether the remote inventories are set. If they are not set, the Oracle Universal Installer sets up the remote inventories by setting registry keys. The Oracle Universal Installer also verifies the permissions to enable writing to the inventory directories on the remote nodes. After completing these actions, the Oracle Universal Installer displays a Summary page that shows the cluster node information along with the space requirements and availability. Verify the installation that the Oracle Universal Installer is about to perform and click Finish.

When you click Finish, the Oracle Universal Installer installs the OCFS and Oracle Clusterware software on the local node and validates the installation again. The Oracle Universal Installer also creates any required OCFS file systems. After validating the installation, the Oracle Universal Installer completes the Oracle Clusterware software installation and configuration on the remote nodes.

Running the Oracle Universal Installer in Silent Mode to Install Oracle Clusterware

You can run the Oracle Universal Installer in silent mode to install Oracle Clusterware by entering the following command:

./setup.exe -silent -responseFile <response file path>

For Oracle Clusterware, you need to use the -formCluster flag. You can pass session variables like nodelist, ocr, voting disk location, and so forth from the command line for silent installation.

Oracle Clusterware Background Processes

The following processes must be running in your environment after the Oracle Clusterware installation for Oracle Clusterware to function:

oprocd — Process monitor for the cluster.

evmd — Event manager daemon that starts the racgevt process to manage call-outs.

ocssd — Manages cluster node membership and runs as the Oracle user; failure of this process results in node restart.

crsd — Performs high availability recovery and management operations such as maintaining the OCR. Also manages application resources and runs as the root user and restarts automatically upon failure.

Adding More Nodes to the Cluster for Mass Deployment

If you want to add more nodes to the cluster by copying the Oracle Clusterware home to another node in the cluster, complete the following procedure:

Perform a single-node cluster Oracle Clusterware installation on node1. In the following steps, the variable $CRS_HOME represents the Oracle Clusterware home directory of the successfully installed Oracle Clusterware software.

Go to the directory $CRS_HOME/oui/bin, and run the script addNode.sh.

The node selection page appears. Select the nodes to be added and click Next.

The Summary page opens. Verify if the Summary page contains the correct node information, and click Next.

When prompted, run the script rootaddnode.sh on your local node.

If prompted to do so, run the script orainstroot.sh on the node on which you are creating another Oracle Clusterware home directory.

Run the root.sh script on the node on which you are creating another Oracle Clusterware home directory.

From the Oracle Clusterware home directory you created on the additional node in the path $CRS_HOME/bin, run the following command:

./racgons add_config node2:4948

In the preceding syntax example, the variable node2 is the name of the node on which you are configuring the additional Oracle Clusterware home directory.

Installing Product Software on a Cluster

After you have installed clusterware and completed pre-installation tasks, you are ready to install the cluster-ready product on the cluster. To do this, you can use Oracle Universal Installer in interactive mode, command line mode, or silent mode using a response file.

See Also:

See "Modes of Installation" for more information on the different modes.

Cluster Detection

When Oracle Universal Installer detects that the destination you entered on the File Locations page is part of a cluster, one of two dialogs appear:

If the Oracle home name entered is new, the Specify Hardware Installation Mode page appears. Use this page to select between cluster and non-cluster installation:

Cluster installation: Select the nodes for your installation from the list of nodes on which clusterware has been installed.

Non-cluster installation: Install on a single-node only, even though that node is part of a cluster.

If the Oracle home name entered is a pre-existing home, the Selected Nodes page appears. This is an information-only page that displays the nodes associated with the Oracle home. The installation is performed on all selected nodes. If any of the selected nodes are down, the installation is not allowed to proceed.

Note:

In Oracle Universal Installer, click Installed Products to display the Inventory panel, which lists all installed Oracle homes. Clustered Oracle homes, which are homes installed on multiple cluster nodes, have an attribute called Cluster Nodes, which lists all the nodes associated with that home.

Availability Checking

When the user clicks Next on the Specify Hardware Installation Mode page or Selected Nodes page, Oracle Universal Installer performs the following availability checks on the nodes:

Network reachability: Tests whether the remote cluster nodes are up and running.

Network configuration: Tests whether the remote cluster nodes are properly network-configured.

Inventory setup: Tests whether the inventory is set up on the remote nodes. If not set up on UNIX, Oracle Universal Installer prompts you to run root scripts on the remote nodes to set up the inventory. On Windows, Oracle Universal Installer sets up the inventory location in the Windows registry.

Inventory permission: Tests whether you can write to the Central Inventory location.

Oracle home permission: Tests whether you can write to the Oracle home.

If all selected nodes are available, the installation process continues to the next step. If a node (or nodes) is not available, the page redisplays with a Status column indicating the results of the check. You must fix the problem or choose another set of nodes in order to proceed.

If any of the remote nodes is unreachable, check if those nodes are up and running and if they are properly network-configured. If either the inventory or the Oracle home is not writable, check for the appropriate permissions on the remote nodes for these directories.

Cluster Installation

In a typical cluster installation, when clusterware is present, Universal Installer installs the Oracle software onto the node on which Oracle Universal Installer is running, then propagates the Oracle home from the local node installation to the other nodes that are part of the installation. Then Universal Installer runs -attachHome on the remote nodes to update the inventory. After this, you need to run orainstRoot.sh (if required) and root.sh on the local and remote nodes. After the scripts are run, the configuration steps are executed.

If the cluster is Cluster File System (CFS) or Network File System (NFS) mounted, Oracle Universal Installer does not propagate the Oracle home to other nodes, as files are shared across nodes and the installation will exist on the shared disk.

Note:

For cluster installations, you must run oraInstRoot.sh on each node of the cluster to set up the inventory.

Cluster Installation in Silent Mode

For Real Application Clusters installation, you can specify the -local flag, CLUSTER_NODES, REMOTE_NODES, and LOCAL_NODE session variables to indicate the nodes on which the installation needs to be done.

When you use the -local flag in a cluster installation, it means that the installation or inventory operation needs to be performed only on the local node. The CLUSTER_NODES session variable indicates that the specified nodes are part of the cluster.

./runInstaller -local "CLUSTER_NODES={a,b,c,d}"

In the above example, the installation would be performed in the local node, and nodes a, b, c, and d would be taken as the part of the cluster.

When you use the REMOTE_NODES session variable in a cluster installation, it means that the installation or the inventory operation needs to be performed on the local node and the other nodes apart from the local node.

./runInstaller "REMOTE_NODES={c,d}" "CLUSTER_NODES={a,b,c,d}"

In the above example, the installation would be performed on the local node a and nodes c and d. The nodes a, b, c, and d would be taken as the part of the cluster.

Cluster Deinstallation

When removing a clustered Oracle home, Oracle Universal Installer first removes software from the node from which you are deinstalling, then removes software from the other cluster nodes associated with the Oracle home.

Command Line Options for Cluster Installations (UNIX Only)

When using Oracle Universal Installer in suppressed or silent mode, specify the path to the remote copy or shell program on the local node to use for cluster installations using the following optional flags:

-remoteShell <path to program>
-remoteCopy <path to program>

The default for remoteShell is /usr/local/bin/ssh. The default for remoteCopy is /usr/local/bin/scp. If these are not present, Oracle Universal Installer defaults to rsh and rcp, respectively.

Patchsets and Upgrades

Oracle Universal Installer enables you to upgrade a product from one version to another version. An upgrade is a major product enhancement that often requires installation of the upgraded software. For example, if you convert your Oracle 10g Database to Oracle 11gR1 Database, then it is called an upgrade.

A group of patches form a patchset. For example, if you convert your Oracle 11gR1 from version 11.1.1 to version 11.1.2, then it is called applying a patchset.

Post-installation Tasks

After completing a Real Application Clusters installation, it is advisable that you perform the following tasks:

Verification

After your Oracle product with Real Application Clusters installation is complete, go to $ORACLE_HOME/Opatch on each node and execute the following command:

$ORACLE_HOME/OPatch/opatch lsinventory -detail

This command lists the components installed inside the Oracle home and also lists the local and remote nodes for the home. Verify this information. You may also want to look at installation logs inventory.xml and oraclehomeproperties.xml.

See "Troubleshooting Real Application Clusters / Oracle Clusterware Installation" in case the check fails.

Back Up Disk after Installation

After your Oracle product with Real Application Clusters installation is complete and after you are sure that your system is functioning properly, make a back-up of the contents of the disk.

Also make a back-up of the disk contents after you complete any node additions or node deletions and after running any de-installation procedures.

Download and Install Patches

Go to the OracleMetaLink Web site for required patches for your installation. To download the required patches:

Use a Web browser to view the OracleMetaLink Web site:

http://metalink.oracle.com

Log in to OracleMetaLink.

On the main OracleMetaLink page, click Patches.

On the Select a Patch Search Area page, click New MetaLink Patch Search.

On the Simple Search page, click Advanced.

On the Advanced Search page, click the search icon next to the Product or Product Family field.

In the Search and Select: Product Family field, enter the Oracle product name in the For field and click Go.

Select the Oracle product under the Results heading and click Select. The product name appears in the Product or Product Family field, and the current release appears in the Release field.

Select your platform from the list in the Platform field and click Go.

Any available patches appear under the Results heading.

Click the number of the patch that you want to download.

On the Patch Set page, click View README and read the page that appears. The README page contains information about the patch set and how to apply the patches to your installation.

Return to the Patch Set page, click Download, and save the file on your system.

Use the unzip utility provided with Oracle software to uncompress the Oracle patches that you downloaded from OracleMetaLink. The unzip utility is located in the $ORACLE_HOME/bin directory.

Note:

By default, the patches would only be applied on the nodes on which the Oracle software installation was done. You can change the node list by using the -enableRollingUpgrade option.

Configure Oracle Products

Many Oracle products and options must be configured before you use them for the first time. Before using individual Oracle products or options, refer to the manual in the product documentation library that is available on the documentation CD-ROM or on the Oracle Technology Network Web site.

Deinstalling Real Application Clusters Software

If you need to deinstall Real Application Clusters software, you must run the Oracle Universal Installer to deinstall the software on the same node from which you performed the installation. You must first deinstall the Oracle product before deinstalling the Oracle Clusterware software.

Perform the following procedures as described in the following sections to deinstall Oracle product and Oracle Clusterware software.

Deinstalling Oracle Product Software on UNIX

The following steps describe how to use Oracle Universal Installer to remove Oracle software from an Oracle home on UNIX systems:

Note:

Always use Oracle Universal Installer to remove Oracle software. Do not delete any Oracle home directories without first using Oracle Universal Installer to remove the software.

If necessary, log in as the oracle user:

$ su - oracle

Set the ORACLE_HOME environment variable to specify the path of the Oracle home directory that you want to remove:

Bourne, Bash, or Korn shell:

$ ORACLE_HOME=/u01/app/oracle/product/11.1.0/db_1
$ export ORACLE_HOME

C shell:

$ setenv ORACLE_HOME /u01/app/oracle/product/11.1.0/db_1

Stop all processes running in this Oracle home.

Start Oracle Universal Installer with the -deinstall flag. When you use this flag only, the deinstallation occurs on the specified components. The Oracle home is not removed from the Central Inventory. This is equivalent to selecting only the components and clicking Deinstall in the GUI. The syntax is as follows:

./runInstaller -deinstall ORACLE_HOME=<LOCATION_OF_ORACLE_HOME>

You can use the REMOVE_HOMES variable to specify the location of the Oracle home to be removed. When you use this variable, the deinstallation occurs for the specified components, and the Oracle home is removed from the Central Inventory. This is equivalent to selecting an Oracle home and clicking Deinstall in the GUI. The syntax is as follows:

./runInstaller -deinstall ORACLE_HOME=<LOCATION_OF_ORACLE_HOME> "REMOVE_
HOMES={<LOCATION_OF_ORACLE_HOME_TO_BE_REMOVED>}"

You can also use the -removeallfiles flag with the REMOVE_HOMES variable to completely deinstall the components, remove the Oracle home from the Central Inventory, and delete the Oracle home directory. The syntax is as follows:

./runInstaller -deinstall ORACLE_HOME=<LOCATION_OF_ORACLE_HOME> "REMOVE_
HOMES={<LOCATION_OF_ORACLE_HOME_TO_BE_REMOVED>}" -removeallfiles

For detailed instructions on deinstalling an Oracle product, see the respective Oracle product installation guide.

Deinstalling Oracle Product Software on Windows

The following steps describe how to use Oracle Universal Installer to remove Oracle software from an Oracle home on Windows systems:

Note:

Always use Oracle Universal Installer to remove Oracle software. Do not delete any Oracle home directories without first using Oracle Universal Installer to remove the software.

Stop all the Oracle services running in this Oracle home.

Start Oracle Universal Installer: from the Start menu, select Programs, then ORACLE_ HOME_NAME, then Oracle Installation Products, then Oracle Universal Installer.

The Welcome screen for Oracle Universal Installer appears.

Click Deinstall Products.

The Inventory screen appears.

Expand the tree of installed components until you find the components to remove. For example, if you installed a database with the Enterprise Edition option and later installed additional components with the Custom option, expand the Oracle home component to display all the components installed in the Oracle home.

Select the components to remove.

Click Remove.

The Confirmation screen appears.

Click Yes to remove the selected components to initiate the removal process.

After the components are removed from your computer, the Inventory screen appears without the removed components.

Click Close to close the Inventory screen.

Click Cancel to exit Oracle Universal Installer.

Click Yes to confirm that you want to exit.

For detailed instructions on deinstalling an Oracle product, see the respective Oracle product installation guide.

Deinstalling Oracle Clusterware

Before deinstalling Oracle Cluster software, ensure that you have removed the respective Oracle product's home in each node by following the steps in the preceding section. The following section explains deinstallation on Windows and UNIX.

Deinstalling Oracle Clusterware from a UNIX Environment

Deinstall each Oracle product Real Application Clusters home by running the procedure in the previous section. Then complete the deinstallation by removing the Oracle Clusterware software using the following procedure:

Run the command $CRS_HOME/install/rootdelete.sh to disable the Oracle Clusterware applications running on the cluster node. The rootdelete.sh script requires three arguments. If you are running this command on a remote node of the cluster, use remote as the first argument; otherwise, use local as the first argument. If the ocr.loc file is on a shared file system, use sharedvar. Otherwise, use nosharedvar as the second argument. If the Oracle Clusterware home is on a shared file system, use sharedhome; otherwise, use nosharedhome as the third argument. Repeat this step on each node of the cluster from which you want to deinstall Oracle Clusterware.

Run the script $CRS_HOME/install/rootdeinstall.sh on a local node to remove the OCR. You only need to run this script once.

Start Oracle Universal Installer. In the Welcome page, click Deinstall Products to display the list of installed products. Select the Oracle Clusterware home to deinstall.

Deinstalling Oracle Clusterware from a Windows Environment

Deinstall each Oracle product Real Application Clusters home by running the procedure in the previous section. Then complete the deinstallation by removing the Oracle Clusterware software using one of the following procedures:

Deinstalling Oracle Clusterware with No Previous Cluster Software Versions.

Deinstalling Oracle Clusterware with Clusterware Downgrade to 10.2.

Deinstalling Oracle Clusterware with No Previous Cluster Software Versions

Perform the following steps to deinstall Oracle 11g Clusterware software from a Windows environment:

Click Start and navigate to Settings, then to Control Panel, then to Administrative Tools, and then to Services. Stop the service oracleremexec.

Start the Oracle Universal Installer. On the Welcome page, click Deinstall Products to display the list of installed products. Select the Oracle Clusterware home you want to deinstall.

If you have services with names such as OracleCRSTokenname, remove them by running the following command:

crsuser remove user_name
where user_name is a user name.

Shut down and restart each node that is a member of your cluster.

If you are not using a cluster file system, on each node use Windows Explorer to delete the Oracle directory, its subdirectories, and their contents.

Deinstalling Oracle Clusterware with Clusterware Downgrade to 10.2

Perform the following steps to deinstall Oracle 11g Clusterware software from a Windows environment that also has 10.2 Real Application Clusters:

Run $CRS_HOME\bin\GuiOracleOBJManager.exe to make sure that the symbolic link named srvcfg exists and points to a disk partition, if you are not using OCFS to store the OCR.

If Oracle10g release 10.2 Clusterware uses Oracle CFS (Cluster File System), ensure the following is true for all nodes:

The registry key HKLM\SOFTWARE\Oracle\osd9i\ocr exists.The registry key HKLM\SOFTWARE\Oracle\osd9i\ocr has a string value CfsOcrRoot that points to a release 10.2 OCR (CFS) location.

Run $CRS_HOME\bin\ocrconfig -downgrade to downgrade the Cluster Registry to a release 10.2 OCR.

On each node, copy $CRS_HOME\cfs\OcfsFindVol.exe to %SYSTEMROOT%\system32\osd9i\cfs.

Run $CRS_HOME\oui\bin\setup.exe to start Oracle Universal Installer. On the Welcome page, click Deinstall Products to list all the installed products. Select the Oracle Clusterware home name from the displayed products, and click Remove to deconfigure and deinstall the product.

On each node, run %SYSTEMROOT%\system32\osd9i\olm\OracleOBJService.exe /install to reinstall the Oracle 10.2 object service. Then start Oracle Object Service.

On each node, run %SYSTEMROOT%\system32\osd9i\cfs\OcfsFindVol.exe /i:%SYSTEMROOT%\system32\osd9i\cfs\OcfsFindVol.exe to reinstall the Oracle Cluster Volume service. Then start the Oracle Cluster Volume service.

From a 10.2 Real Application Clusters Oracle home on each node, run the command ORACLE_HOME\bin\gsdservice.exe -install. Then start the OracleGSDService.

On each node, copy %SYSTEMROOT%\system32\osd9i\orafencedrv.sys %SYSTEMROOT%\system32\drivers\orafenceservice.sys.

Converting Single-instance Nodes to Real Application Clusters

You can convert single-instance nodes to Real Application Clusters using Oracle Universal Installer. For details on converting single instance nodes to Real Application Clusters, see the Oracle Real Application Clusters Installation Guide 11g Release 1 (11.1). for your platform.

Troubleshooting Real Application Clusters / Oracle Clusterware Installation

The following flowchart explains how you can solve problems associated with the Real Application Clusters or Oracle Clusterware installation.

Figure 5-1 Troubleshooting Real Application Clusters / Oracle Clusterware Installation

6 Cloning Oracle Software

This chapter provides information about Oracle cloning using Oracle Universal Installer (OUI). This chapter contains the following topics:

About Cloning

Overview of the Cloning Process

Locating and Viewing Log Files

Cloning an Oracle Database 11.1 Oracle Home

Cloning Oracle Clusterware and Oracle Real Application Clusters Homes

About Cloning

Cloning is the process of copying an existing Oracle installation to a different location and updating the copied bits to work in the new environment. The changes made by applying one-off patches on the source Oracle home are also present after the clone operation. The source and the destination path (host to be cloned) need not be the same. During cloning, OUI replays the actions that were run to install the home. Cloning is similar to installation, except that OUI runs the actions in a special mode referred to as clone mode. Some situations in which cloning is useful are:

Creating an installation that is a copy of a production, test, or development installation. Cloning enables you to create a new installation with all patches applied to it in a single step. This contrasts with going through the installation process by performing separate steps to install, configure, and patch the installation.

Rapidly deploying an instance and the applications that it hosts.

Preparing an Oracle home and deploying it to many hosts.

The cloned installation behaves the same as the source installation. For example, the cloned Oracle home can be removed using OUI or patched using OPatch. You can also use the cloned Oracle home as the source for another cloning operation. You can create a cloned copy of a test, development, or production installation by using the command-line cloning scripts. The default cloning procedure is adequate for most usage cases. However, you can also customize various aspects of cloning, for example, to specify custom port assignments, or to preserve custom settings.

The cloning process copies all of the files from the source Oracle home to the destination Oracle home. Thus, any files used by the source instance located outside the source Oracle home's directory structure are not copied to the destination location.

The size of the binaries at the source and the destination may differ because these are relinked as part of the clone operation, and the operating system patch levels may also differ between these two locations. Additionally, the number of files in the cloned home would increase because several files copied from the source, specifically those being instantiated, are backed up as part of the clone operation.

OUI cloning is more beneficial than using the tarball approach, because cloning configures the Central Inventory and the Oracle home inventory in the cloned home. Cloning also makes the home manageable and allows the paths in the cloned home and the target home to be different.

Overview of the Cloning Process

The cloning process uses the OUI cloning functionality. This operation is driven by a set of scripts and add-ons that are included in the respective Oracle software. The cloning process has two phases:

Source Preparation Phase

Cloning Phase

Source Preparation Phase

To prepare the source Oracle home to be cloned, perform the following steps:

At the source, run a script called prepare_clone.pl. This is a Perl script that prepares the source for cloning by recording the information required for cloning. This script is generally found in the following location:

$ORACLE_HOME/clone/bin/prepare_clone.pl

During this phase, prepare_clone.pl parses files in the source Oracle home to extract and store the required values.

Note:

The need to perform the preparation phase depends on the Oracle product you are installing. This script needs to be executed only for the Application Server Cloning. Database and CRS Oracle home cloning does not require this.

Archive and compress the source Oracle home using your preferred archiving tool. For example, you can use WinZip on Microsoft Windows system computers and tar or gzip on UNIX. Make sure that the tool that you use preserves the permissions and file timestamps. When archiving the home, also ensure that you skip the *.log, *.dbf, listener.ora, sqlnet.ora, and tnsnames.ora for archiving. Also ensure that you do not archive the following folders:

$ORACLE_HOME/<Hostname>_<SID>
$ORACLE_HOME/oc4j/j2ee/OC4J_DBConsole_<Hostname>_<SID>

The following sample shows an exclude file list:

$ cat excludedFileList.txt
./install/make.log
./cfgtoollogs/cfgfw/CfmLogger_2007-07-13_12-03-16-PM.log
./cfgtoollogs/cfgfw/oracle.server_2007-07-13_12-03-17-PM.log
./cfgtoollogs/cfgfw/oracle.network.client_2007-07-13_12-03-18-PM.log
./cfgtoollogs/cfgfw/oracle.has.common_2007-07-13_12-03-18-PM.log
./cfgtoollogs/cfgfw/oracle.assistants.server_2007-07-13_12-03-18-PM.log
./cfgtoollogs/cfgfw/OuiConfigVariables_2007-07-13_12-03-18-PM.log
./cfgtoollogs/cfgfw/oracle.sysman.console.db_2007-07-13_12-03-18-PM.log
./cfgtoollogs/cfgfw/oracle.sqlplus.isqlplus_2007-07-13_12-03-18-PM.log
./cfgtoollogs/oui/cloneActions2007-07-13_11-52-19AM.log
./cfgtoollogs/oui/silentInstall2007-07-13_11-52-19AM.log

The following example shows how to archive and compress the source for various platforms:

To archive and compress:
tar cpf - . | compress -fv > temp_dir/archiveName.tar.Z  ( for "aix" or $^O eq "hpux")
tar cpfX - excludeListFile . | compress -fv > temp_dir/archiveName.tar.Z (for remaining UNIX based systems)

Note:

Do not use the jar utility to archive and compress the Oracle home.

Cloning Phase

On the destination system, you unarchive the Oracle home and run the clone.pl script. This Perl script performs all parts of the cloning operation automatically by running OUI and various other utilities. This script uses the cloning functionality in OUI. When you run the clone.pl script, it handles the specifics that OUI may have missed. The Central Inventory of the box where the home is being cloned is updated as is the Oracle home inventory ($ORACLE_HOME/inventory).

The following example shows how to unarchive and decompress the source for various platforms:

To unarchive:
mkdir  Destination_oracle_homecd   Destination_oracle_homezcat temp_dir/archiveName.tar.Z | tar xpf - (for "hpux")zcat temp_dir/archiveName.tar.Z | tar xBpf -  (for remaining UNIX based systems)

You must have Perl 5.6 or higher installed on your system to enable cloning. Also ensure that you set the path environment variable to the correct Perl executable.

Note:

The cloned home and source home will not be identical in size, because the cloned home will have additional files created during the cloning operation.

Locating and Viewing Log Files

The cloning script runs multiple tools, each of which may generate its own log files. However, the following log files that OUI and the cloning scripts generate are the key log files of interest for diagnostic purposes:

<Central_Inventory>/logs/cloneActions timestamp.log: Contains a detailed log of the actions that occur during the OUI part of the cloning.

<Central_Inventory>/logs/oraInstall timestamp.err: Contains information about errors that occur when OUI is running.

<Central_Inventory>/logs/oraInstall timestamp.out: Contains other miscellaneous messages generated by OUI.

$ORACLE_HOME/clone/logs/clone timestamp.log: Contains a detailed log of the actions that occur during the pre-cloning and cloning operations.

$ORACLE_HOME/clone/logs/error timestamp.log: Contains information about errors that occur during the pre-cloning and cloning operations.

To find the location of the Oracle inventory directory:On all UNIX system computers except Linux and IBM AIX, look in the /var/opt/oracle/oraInst.loc file. On IBM AIX and Linux-based systems, look in the /etc/oraInst.loc file.

On Windows system computers, you can obtain the location from the Windows Registry key: HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\INST_LOC.

After the clone.pl script finishes running, refer to these log files to obtain more information about the cloning process.

Cloning an Oracle Database 11.1 Oracle Home

There are two steps involved in cloning an Oracle Database 11.1 Oracle home:

Preparing the 11.1 Oracle Database Source

Cloning an 11.1 Oracle Database

Preparing the 11.1 Oracle Database Source

To prepare the source Oracle home to be cloned, perform the following steps:

Ensure that the Oracle Database installation whose home you want to clone has been successful.

For Windows system computers, you can check the status of the installation by reviewing the installActionsdate_time.log file for the installation session, where date_time represents the date and time when the file was created; for example, installActions2007-05-30_10-28-04PM.log. This log file is normally located in the c:\Program Files\Oracle\Inventory\logs directory.

For Linux-based systems, the logs are kept in the <inventory location>/logs directory. To determine the location of the Central Inventory, see"Locating and Viewing Log Files".

If you have installed patches, you can check their status by running the following commands:

For Windows-based system computers:

c:\ORACLE_BASE\ORACLE_HOME\OPatch> set ORACLE_HOME = ORACLE_HOME_using_patch
c:\ORACLE_BASE\ORACLE_HOME\OPatch> opatch lsinventory

For Linux-based and UNIX-based systems:

/ORACLE_BASE/ORACLE_HOME/OPatch> setenv ORACLE_HOME ORACLE_HOME_using_patch
/ORACLE_BASE/ORACLE_HOME/OPatch> ./opatch lsinventory

Archive and compress the source Oracle home, using your preferred tool for archiving. For more information on this, see "Source Preparation Phase".

Cloning an 11.1 Oracle Database

To clone the 11.1 Oracle Database, perform the following steps:

Copy the compressed zip or archive file to the target computer.

Extract the contents of the compressed zip or archive file in the target computer. For more information on extracting the contents, see "Cloning Phase".

On the target computer, go to the $ORACLE_HOME/clone/bin directory and run clone.pl. This is a Perl script that performs all parts of the cloning operation automatically by calling various utilities and OUI. This script uses the cloning functionality in OUI.

Note:

The clone.pl script clones the software only and not the database instance.

The following command shows the syntax for the clone.pl script:

For Windows-based systems:

perl <Oracle_Home>\clone\bin\clone.pl ORACLE_HOME=<Path to the Oracle_Home being_cloned> ORACLE_HOME_NAME=<Oracle_Home_Name for the Oracle_Home being cloned> [-command_line_arguments]

For Linux-based and UNIX-based systems:

perl <Oracle_Home>/clone/bin/clone.pl ORACLE_HOME=<Path to the Oracle_Home being_cloned> ORACLE_HOME_NAME=<Oracle_Home_Name for the Oracle_Home being cloned> [-command_line_arguments]

The preceding command uses the <command_line_arguments> variable. Table 6-1 describes the command-line arguments.

Table 6-1 Command-line arguments in the clone.pl script

Command-line Argument
Description

-O

If you use this argument, anything following it is passed to the OUI clone command line. For example, you can use this option to pass the location of the oraparam.ini file to be used by OUI:

'-O -paramFile C:\OraHome_1\oui\oraparam.ini'

-debug

If you use this argument, the script runs in debug mode.

-help

If you use this argument, the script prints the help for the clone script.

You can also pass values in the command line by using the $ORACLE_HOME/clone/config/cs.properties file. You can enter values in the line clone_command_line=<value>. The values entered here are appended to the OUI command line, which is run to perform the clone operation.

For example, to specify a non-default location for the Oracle inventory file on UNIX system computers, you can add the following line to the cs.properties file:

clone_command_line= -invptrloc /private/oracle/oraInst.loc

Note:

To specify multiple arguments, separate each argument with a space.

Locate the log file, if desired, after OUI starts and records the cloning actions in the cloneActionstimestamp.log file:

For Windows-based systems, this log file is normally located in the following directory:

c:\Program Files\Oracle\Inventory\logs

For Linux-based and UNIX-based systems, this log file is normally located in the following directory:

 c:\Program Files\Oracle\Inventory\logs

To configure the connection information for the new database, run the Net Configuration Assistant:

On Windows-based systems, select Start > Programs > Oracle - HOME_NAME > Configuration and Migration Tools > Net Configuration Assistant.

On Linux-based and UNIX-based systems, set the ORACLE_HOME variable and run $ORACLE_HOME/bin/netca.

To create a new database for the newly cloned Oracle home, run the Oracle Database Configuration Assistant:

On Windows-based systems, select Start > Programs > Oracle - HOME_NAME > Configuration and Migration Tools > Database Assistant.

On Linux-based and UNIX-based systems, run $ORACLE_HOME/bin/dbca.

Viewing Log and Error Files

After cloning, you can view the status of the clone operation by navigating to the $ORACLE_HOME/clone/log directory and by reviewing the *.log and *.err files. For more information, see the section "Locating and Viewing Log Files".

Cloning Oracle Clusterware and Oracle Real Application Clusters Homes

For procedures to clone Oracle Clusterware and Oracle Real Application Clusters homes, refer to the following documentation:

Oracle® Real Application Clusters Administration and Deployment Guide 11g Release 1 (11.1) (B28254-04)

Chapter 7, "Using Cloning to Add ASM and Oracle RAC to Nodes in a New Cluster"

Chapter 8, "Using Cloning to Extend Oracle RAC to Nodes in the Same Cluster"

Oracle® Clusterware Administration and Deployment Guide 11g Release 1 (11.1) (B28255-03)

Chapter 3, "Cloning Oracle Clusterware"

7 Patching Oracle Software with OPatch

OPatch is an Oracle-supplied utility that assists you with the process of applying interim patches to Oracle's software and rolling back interim patches from Oracle's software. This chapter provides information on using OPatch for these purposes.This chapter includes the following topics:

About OPatch

Requirements for OPatch

Prerequisite Checks for OPatch

Backup and Recovery Considerations for Patching

OPatch Utility for OUI-based Oracle Homes

Standalone Patching

Schema Patching

Online Patching

Real Application Clusters Patching

About Patch Conflicts

Problem Resolution

About OPatch

OPatch is a Java-based utility that requires installation of the Oracle Universal Installer. It is platform-independent and runs on all supported operating systems. Another version of OPatch, called standalone OPatch, is also available. It runs on Oracle homes without Oracle Universal Installer

Patches are a small collection of files copied over to an existing installation. They are associated with particular versions of Oracle products. When applied to the correct version of an installed product, patches result in an upgraded version of the product.

Interim patches are bug fixes available to customers in response to specific bugs. They require a particular base release or patchset to be installed before you can apply them. They generally address specific bugs for a particular customer. These patches are not versioned and are generally available in a future patchset as well as the next product release.

OPatch Features

The OPatch 11.1 utility has the following features:

Scalability — OPatch is scalable to support a large number of patches.

Reliability — OPatch is reliable and protects the Oracle home and inventory. It can bring back the Oracle home to a stable state from patch application failures. It can also easily detect patch conflicts.

Availability — Opatch's online patching improves system availability by allowing database patches to be applied without needing to shut down databases.

Portability — OPatch is compatible with all operating systems for which Oracle releases software.

Robust — OPatch is very robust. It is very easy to apply a patch as well as remove it.

Easy to maintain — OPatch is easy to maintain and is also extensible.

Support for Silent Operation — OPatch supports silent operation. This mode allows you to run the software without any user interaction.

Support for Real Application Clusters — OPatch supports Real Application Clusters and works well in that setup. It is easy to extend it to Enterprise Manager Grid Control.

Easy to debug — OPatch has various levels of logging and tracing mechanisms. It also has a debug option that helps to easily diagnose software problems.

OPatch supports the following tasks:

Applying an interim patch.

Rolling back the application of an interim patch.

Detecting a conflict when applying an interim patch after previous interim patches have been applied. It also suggests the best options to resolve a conflict.

Reporting on installed products and interim patches.

Getting Interim Patches

Oracle releases interim patches frequently to fix a bug or a set of bugs. You can get the interim patches by specifying the patch ID in OracleMetalink from the following location:

http://www.oracle.com/support/metalink/index.html

Environment Variables OPatch Uses

OPatch uses the following environment variables:

ORACLE_HOME — Oracle home location.

PATH — Path information.

OPATCH_DEBUG — Log level that specifies the amount of logging OPatch should perform.

Requirements for OPatch

The OPatch utility requires the following environment:

The Oracle home environment variable (ORACLE_HOME) must point to a valid Oracle home directory and match the value used during installation of the Oracle home directory.

JRE version 1.4 or higher, Java commands for Windows, and ar, cp, fuser, and make commands for UNIX must be made available.

The library path must be set correctly for Oracle Real Application Clusters environments. OPatch uses some APIs to detect if the system is a Real Application Clusters system. Ensure that the library path is set correctly as follows:

For Solaris:
LD_LIBRARY_PATH = $ORACLE_HOME/lib32:$ORACLE_HOME/lib

For HP-UX:
SHLIB_PATH=$ORACLE_HOME/lib32:/usr/lib

See Also:

For the latest information about the OPatch utility, to check for updates, and to get the latest versions, go to OracleMetaLink at:

http://www.oracle.com/support/metalink/index.html

Prerequisite Checks for OPatch

Before you invoke OPatch, perform the prerequisite checks described in the following sections.

Checks for Single Instances and Real Application Clusters

Check ORACLE_HOME and Environment Variable

OPatch verifies if the Oracle home is present. You must ensure that the ORACLE_HOME environment variable is set to the Oracle home of the product you are trying to patch. Check the respective vendor documentation for details to set the environment variable.

Check for JRE

OPatch requires JRE version 1.4 or higher to work properly.

Check for System Space

When OPatch processes the script for the installation of a patch, it simultaneously generates a Rollback script and saves a copy of every file edited or deleted during the patching. OPatch also backs up the inventory information. Consequently, Oracle recommends that you have sufficient system space to accommodate the patch and the backup information.

Check for Oracle Universal Installer and OPatch Version Compatibility

OPatch 11.1 requires Oracle Universal Installer 11.1 or higher to work properly. If the Oracle Universal Installer version is less than what OPatch requires, OPatch errors out.

Check for Patch Applicable on Operating System

OPatch detects if a particular patch is applicable for an operating system. If it is not applicable, OPatch displays an error message.

Check for System Commands

OPatch supports a set of properties used for various software operations. You can use these properties to control the internal operations of OPatch. By default, OPatch uses the standard Java property format to specify the properties. The following list shows the default properties and their values:

fuser=/sbin:/usr/sbin

ar=/usr/ccs/bin/

make=/usr/bin

You can specify OPatch properties in the following ways:

By using the default OPatch properties.

By specifying the location of the user-defined properties file.

By using the command line. The syntax is as follows:

PROPERTY_NAME=VALUE

Example: fuser=/sbin:/usr/sbin

Additional Checks for Real Application Clusters

For Real Application Clusters, ensure that you perform the following prerequisite checks besides the other checks listed in the preceding section.

Check for User Equivalence

You must ensure that the cluster machines have user equivalence set for the user installing Oracle Clusterware/ Real Application Clusters. On UNIX, this means rsh or ssh or both should be set up on the cluster machines. On Windows, this means the same <domain>\<user> should have administrative privileges on all the cluster machines, and the machines should be a member of the <domain>.

If the user equivalence is set properly, the following command will work properly:

$ rsh <nodename> date

For more information on setting user equivalence, see "Configuring SSH on all Cluster Nodes".

Check for OPatch Lsinventory

Ensure that you are able to invoke the opatch lsinventory -detail command and are able to see the node information being printed out. If you do not find the node information correctly printed out, you need to update the node list. For more information on updating the node list, see "Updating the Nodes of a Cluster".The following example shows the command output for 118 installed products and SQL, PL/SQL, and online patches:

Invoking OPatch 11.1.0.6.5

Oracle Interim Patch Installer version 11.1.0.6.5
Copyright (c) 2008, Oracle Corporation.  All rights reserved.

Oracle Home       : /scratch/userid/oracle/product/11.1.0/db_1
Central Inventory : /home/userid/newDB/oraInventory
   from           : /etc/oraInst.loc
OPatch version    : 11.1.0.6.5
OUI version       : 11.1.0.6.5
OUI location      : /scratch/userid/oracle/product/11.1.0/db_1/oui
Log file location : /scratch/userid/oracle/product/11.1.0/ db_1/cfgtoollogs/opatch/opatch2008-07-17_23-08-20PM.log

Lsinventory Output file location : /scratch/userid/oracle/product/11.1.0/ db_1/cfgtoollogs/opatch/lsinv/lsinventory2008-07-17_23-08-20PM.txt

--------------------------------------------------------------------------------
Installed Top-level Products (1):

Oracle Database 11g                                                  11.1.0.4.0
There are 1 products installed in this Oracle Home.

Installed Products (118):

Agent Required Support Files                                         10.2.1.3.1
Assistant Common Files                                               11.1.0.4.0
Bali Share                                                           1.1.18.0.0
Buildtools Common Files                                              11.1.0.4.0
Character Set Migration Utility                                      11.1.0.4.0
Database Configuration and Upgrade Assistants                        11.1.0.4.0
Database SQL Scripts                                                 11.1.0.4.0
Database Workspace Manager                                           11.1.0.4.0
Enterprise Edition Options                                           11.1.0.4.0
Enterprise Manager Agent                                             10.2.1.3.1
Enterprise Manager Agent Core Files                                  10.2.1.3.1
Enterprise Manager Common Core Files                                 10.2.1.3.1
Enterprise Manager Common Files                                      10.2.1.3.1
Enterprise Manager Database Plugin -- Agent Support                  11.1.0.4.0
Enterprise Manager Database Plugin -- Management Service Support     11.1.0.4.0
Enterprise Manager Database Plugin -- Repository Support             11.1.0.4.0
Enterprise Manager Grid Control Core Files                           10.2.1.3.1
Enterprise Manager plugin Common Files                               11.1.0.4.0
Enterprise Manager Repository Core Files                             10.2.1.3.1
Generic Connectivity                                                 11.1.0.4.0
Generic Connectivity Common Files                                    11.1.0.4.0
HAS Common Files                                                     11.1.0.4.0
HAS Files for DB                                                     11.1.0.4.0
Installation Common Files                                            11.1.0.4.0
Installer SDK Component                                              11.1.0.6.5
JAccelerator (COMPANION)                                             11.1.0.4.0
LDAP Required Support Files                                          11.1.0.4.0
OLAP SQL Scripts                                                     11.1.0.4.0
Oracle 11g Warehouse Builder Server                                  11.1.0.4.0
Oracle Advanced Security                                             11.1.0.4.0
Oracle Application Express                                           11.1.0.4.0
Oracle Call Interface (OCI)                                          11.1.0.4.0
Oracle Clusterware RDBMS Files                                       11.1.0.4.0
Oracle Code Editor                                                   1.2.1.0.0I
Oracle Configuration Manager                                         10.2.5.0.0
Oracle Containers for Java                                           11.1.0.4.0
Oracle Core Required Support Files                                   11.1.0.4.0
Oracle Data Mining RDBMS Files                                       11.1.0.4.0
Oracle Database 11g                                                  11.1.0.4.0
Oracle Database 11g                                                  11.1.0.4.0
Oracle Database 11g interMedia Files                                 11.1.0.4.0
Oracle Database User Interface                                       2.2.13.0.0
Oracle Database Utilities                                            11.1.0.4.0
Oracle Display Fonts                                                  9.0.2.0.0
Oracle Enterprise Manager Console DB                                 11.1.0.4.0
Oracle Extended Windowing Toolkit                                    3.4.42.0.0
Oracle Globalization Support                                         11.1.0.4.0
Oracle Globalization Support                                         11.1.0.4.0
Oracle Help For Java                                                  4.2.9.0.0
Oracle Help for the  Web                                             2.0.11.0.0
Oracle Ice Browser                                                    5.2.3.6.0
Oracle interMedia                                                    11.1.0.4.0
Oracle interMedia Annotator                                          11.1.0.4.0
Oracle interMedia Client Option                                      11.1.0.4.0
Oracle interMedia Java Advanced Imaging                              11.1.0.4.0
Oracle interMedia Locator                                            11.1.0.4.0
Oracle interMedia Locator RDBMS Files                                11.1.0.4.0
Oracle Internet Directory Client                                     11.1.0.4.0
Oracle Java Client                                                   11.1.0.4.0
Oracle JDBC Server Support Package                                   11.1.0.4.0
Oracle JDBC/OCI Instant Client                                       11.1.0.4.0
Oracle JDBC/THIN Interfaces                                          11.1.0.4.0
Oracle JFC Extended Windowing Toolkit                                4.2.36.0.0
Oracle JVM                                                           11.1.0.4.0
Oracle LDAP administration                                           11.1.0.4.0
Oracle Locale Builder                                                11.1.0.4.0
Oracle Message Gateway Common Files                                  11.1.0.4.0
Oracle Net                                                           11.1.0.4.0
Oracle Net Listener                                                  11.1.0.4.0
Oracle Net Required Support Files                                    11.1.0.4.0
Oracle Net Services                                                  11.1.0.4.0
Oracle Notification Service                                          10.1.0.3.0
Oracle ODBC Driver                                                   11.1.0.4.0
Oracle ODBC Driverfor Instant Client                                 11.1.0.4.0
Oracle OLAP                                                          11.1.0.4.0
Oracle OLAP API                                                      11.1.0.4.0
Oracle OLAP RDBMS Files                                              11.1.0.4.0
Oracle One-Off Patch Installer                                       11.1.0.6.5
Oracle Partitioning                                                  11.1.0.4.0
Oracle Programmer                                                    11.1.0.4.0
Oracle RAC Required Support Files-HAS                                11.1.0.4.0
Oracle Recovery Manager                                              11.1.0.4.0
Oracle Security Developer Tools                                      11.1.0.4.0
Oracle Spatial                                                       11.1.0.4.0
Oracle SQL Developer                                                 11.1.0.4.0
Oracle Starter Database                                              11.1.0.4.0
Oracle Text                                                          11.1.0.4.0
Oracle UIX                                                           2.2.20.0.0
Oracle Ultra Search Common Files                                     11.1.0.4.0
Oracle Ultra Search Middle-Tier                                      11.1.0.4.0
Oracle Ultra Search Server                                           11.1.0.4.0
Oracle Ultra Search Server Rdbms                                     11.1.0.4.0
Oracle Universal Installer                                           11.1.0.6.5
Oracle Wallet Manager                                                11.1.0.4.0
Oracle XML Development Kit                                           11.1.0.4.0
Parser Generator Required Support Files                              11.1.0.4.0
Perl Interpreter                                                      5.8.3.0.6
PL/SQL                                                               11.1.0.4.0
PL/SQL Embedded Gateway                                              11.1.0.4.0
Platform Required Support Files                                      11.1.0.4.0
Precompiler Common Files                                             11.1.0.4.0
Precompiler Required Support Files                                   11.1.0.4.0
Provisioning Advisor Framework                                       10.2.1.3.1
RDBMS Required Support Files                                         11.1.0.4.0
RDBMS Required Support Files for Instant Client                      11.1.0.4.0
regexp                                                                2.1.9.0.0
Required Support Files                                               11.1.0.4.0
Sample Schema Data                                                   11.1.0.4.0
Secure Socket Layer                                                  11.1.0.4.0
Secure Socket Layer                                                  11.1.0.4.0
SQL*Plus                                                             11.1.0.4.0
SQL*Plus Required Support Files                                      11.1.0.4.0
SQLJ Runtime                                                         11.1.0.4.0
SSL Required Support Files for InstantClient                         11.1.0.4.0
Sun JDK                                                               1.5.0.0.6
XDK Required Support Files                                           11.1.0.4.0
XML Parser for Java                                                  11.1.0.4.0
XML Parser for Oracle JVM                                            11.1.0.4.0
There are 118 products installed in this Oracle Home.

Interim patches (3) :

Patch  300100       : applied on Tue Jul 10 02:21:40 PDT 2008
   Created on 01 Jan 2007, 04:57:12 hrs US/Eastern
   Bugs fixed:
     300101
   Files Touched:
     test.pch --> ORACLE_HOME/hpatch/test.pch
   Instances Patched:
     online, venkat
   Patch Location in Inventory:
     /scratch/userid/oracle/product/11.1.0/db_1/inventory/oneoffs/300100
   Patch Location in Storage area:
     /scratch/userid/oracle/product/11.1.0/db_1/.patch_storage/300100_Jan_01_2007_04_57_12

Patch  100100       : applied on Thu Jun 21 21:01:35 PDT 2008
   Created on 22 Apr 2008, 23:57:54 hrs PST8PDT
   Bugs fixed:
     100100, 100101
   Files Touched:
     /shof.o --> ORACLE_HOME/lib/libagent10.a
     /oracle/help/AppletWindowManager.class --> ORACLE_HOME/jlib/help4.jar
     dbui2.jar --> ORACLE_HOME/jlib/dbui2.jar
     DummaDummy.class --> ORACLE_HOME/plsql/DummaDummy.class
   Sql scripts Executed:
     /scratch/userid/oracle/product/11.1.0/db_1/scripts/2.sql
   Sql Procedures Touched:
     JAN_300500_1, JAN_300500_2
   Patch Location in Inventory:
     /scratch/userid/oracle/product/11.1.0/db_1/inventory/oneoffs/100100
   Patch Location in Storage area:
     /scratch/userid/oracle/product/11.1.0/db_1/.patch_storage/100100_Apr_22_2008_23_57_54

Patch  300500       : applied on Tue Jun 05 03:06:55 PDT 2008
   Created on 07 Nov 2007, 04:57:14 hrs US/Eastern
   Bugs fixed:
     300500, 300501, 300502
   Files Touched:
     abc1.sql --> ORACLE_HOME/jlib/abc1.sql
     abc.sql --> ORACLE_HOME/jlib/abc.sql
   Patch Location in Inventory:
     /scratch/userid/oracle/product/11.1.0/db_1/inventory/oneoffs/300500
   Patch Location in Storage area:
     /scratch/userid/oracle/product/11.1.0/db_1/.patch_storage/300500_Nov_07_2007_04_57_14

--------------------------------------------------------------------------------

OPatch succeeded.

Backup and Recovery Considerations for Patching

Note:

It is highly recommended that you back up the ORACLE_HOME before any patch operation. You can back up the ORACLE_HOME using your preferred method. You can use any method such as zip, cp -r, tar, and cpio to compress the ORACLE_HOME.

If the ORACLE_HOME does not appear when you execute the opatch lsinventory -detail command, the ORACLE_HOME might be missing from the Central Inventory, or the Central Inventory itself could be missing or corrupted.

If the ORACLE_HOME is listed when you execute the opatch lsinventory -detail command, but the products and components within the ORACLE_HOME are not listed, the inventory within the ORACLE_HOME (local inventory) might be missing or corrupted.

If the local inventory is corrupted or lost for some reason, you can simply restore the ORACLE_HOME/inventory if it was backed up. If a backup does not exist, you may have to reinstall the software.

OPatch Utility for OUI-based Oracle Homes

Note:

OPatch also provides a standalone method of patching that does not require the Oracle Universal Installer (OUI). The options for these commands are a subset of those offered here for the standard method of patching using OUI. For information on standalone patching and the available options for commands, see "Standalone Patching".

You can run the OPatch utility, located in the <Path_to_Oracle_Home>/OPatch directory, with various commands and options. The following string shows the syntax for the OPatch utility:

<Path_to_OPatch>/opatch [-help] [-r[eport]] [command] [-option]

where:

help — Displays the help message for the command.

report — Prints the actions without executing.

command — One of the OPatch commands, described in Table 7-1.

option — One of the OPatch command options, described starting with Table 7-2.

Table 7-1 OPatch OUI-based Commands

Command
Description

apply

Installs an interim patch. See "Apply Command for OUI-based Oracle Homes" for more information.

napply

Installs n number of patches (hence napply) See "Napply Command for OUI-based Oracle Homes" for more information.

lsinventory

Lists what is currently installed on the system. See "Lsinventory Command for OUI-based Oracle Homes" for more information.

query

Queries a given patch for specific details. See "Query Command for OUI-based Oracle Homes" for more information.

rollback

Removes an interim patch. See "Rollback Command for OUI-based Oracle Homes" for more information.

nrollback

Removes n number of patches (hence nrollback). See "Nrollback Command for OUI-based Oracle Homes" for more information.

version

Prints the current version of the patch tool. See "Version Command for OUI-based Oracle Homes" for more information.

To view additional information for any command, use the following command:

<Path_to_OPatch>/opatch command -help

For Perl, use the following command:

perl opatch.pl command -help

Apply Command for OUI-based Oracle Homes

This command applies an interim patch to an Oracle home from the current directory. The ORACLE_HOME environment variable must be set to the Oracle home to be patched.

Syntax

Use the following syntax for this command:

opatch apply  [-delay <value> ] [ -force ]              [-invPtrLoc <Path to oraInst.loc> ]              [-jre <LOC> ] [-local ] [-minimize_downtime ]              [-no_bug_superset ] [-no_inventory ]              [-oh <ORACLE_HOME> ] [-retry <value> ] [-silent ]              [-verbose ]  [-no_relink] [-pre <parameters for the              pre script in escaped double quotes> [-opatch_pre_end] ]              [-post <parameters for the post script in escaped              quotes> [-opatch_post_end] ] [-no_sysmod]              [-property_file <Path to property file>]               [-local_node <Local node name>]              [-remote_nodes <List of remote nodes (node1,node2)>]              [-connectString  <List of connect strings>]               [-runSql] [-sqlScript <path of the sql file>]              [-ptlSchema <portal schema>] [-ptlPassword <portal password>]              [-ptlConnect <portal connect string>]              [-init <parameters for the init script in escaped double               quotes> [-opatch_init_end] ] [-report]
              [<Patch Location>]

Options

Table 7-2 lists the options available for this command.

Table 7-2 Apply Options for OUI Patches

Option
Description

connectString

Specifies the list of database instances on which the patch needs to be applied. Specify the value for this option using the following syntax:

SID:User:Passwd:Node

Example:

oracle:dba:dba:mymachine,oracle1:::

The SID is required, but you can disregard the other parameters if desired, because OPatch provides default values for them.

Note: If the system is not part of a RAC setup and you want to patch just the local node, provide the node name as an empty string.

delay

Specifies how many seconds to wait before attempting to lock the inventory again for a previous failure. You can use this option only if you specify the retry option.

force

Removes conflicting patches from the system. If a conflict exists that prevents the patch from being applied, you can use this option to apply the patch. OPatch removes all the conflicting patches before applying the current patch.

init

Passes parameters to the init script, which executes before prerequisite checks are run. The values for this option must be enclosed in double-quotes.

invPtrLoc

Specifies the location of the oraInst.loc file. The invPtrLoc option is needed when this option is used during installation. Oracle recommends the use of the default Central Inventory for a platform.

jre

Instructs OPatch to use JRE (Java) from the specified location instead of the default location under the Oracle home directory.

local

Specifies that OPatch should patch the local node and update the inventory of the local node. It does not propagate the patch or inventory update to other nodes.

You can use this option on Oracle Real Application Clusters environments and non-clustered environments. If an entire cluster is shut down before patching, you can use this option for non-rolling patches.

local_node

Tells OPatch the local node for this cluster. You can use this option on Oracle Real Application Clusters environments.

minimize_downtime

Specifies the order of nodes that OPatch should patch.

This option only applies to Oracle Real Application Clusters environments. You cannot use it with the -local option with a rolling patch.

no_bug_superset

Specifies to error out if the current patch's bugs-to-fix is a superset (or same set) of an installed patch's bugs-fixed in the Oracle home directory.

no_inventory

Bypasses the inventory for reading and updates. You cannot use this option with the local option. This option places the installation into an unsupported state.

no_relink

This option does not perform any make operations. You can use it during multiple patch applications and to perform the linking step only once. OPatch does not keep track of the make operations it did not perform. You need to make sure to execute OPatch without this option at the end for compilation.

no_sysmod

Specifies that OPatch does not need to update the files in the system. It only updates the inventory. It also does not execute the pre and post scripts.

oh

Specifies the Oracle home directory to use instead of the default. This takes precedence over the environment variable ORACLE_HOME.

opatch_init_end

Marks the end of the init options. You use this option with the init option. If you do not use this option, everything after init until the end of the command is passed into init.

opatch_post_end

Marks the end of the post option. You use this option with the post option. If you do not use this option, everything after post until the end of the command is passed into post.

opatch_pre_end

Marks the end of the pre options. You use this option with the pre option. If you do not use this option, everything after pre until the end of the command is passed into pre.

Patch Location

Indicates the path to the patch location. If you do not specify the location, OPatch assumes the current directory is the patch location.

post

Specifies the parameters to be passed to the post script. This script is executed after the patch is applied. You need to enclose the values for this option in double-quotes.

pre

Specifies the parameters to be passed to the pre script. This script is executed before the patch is applied. You need to enclose the values for this option in double-quotes.

property_file

Specifies the user-defined property file for OPatch to use. The path to the property file should be absolute. This property file takes precedence over the one that OPatch supplies.

ptlConnect

Specifies the connection string credentials of the portal schema.

ptlPassword

Specifies the password of the portal schema.

ptlSchema

Specifies the schema of the portal repository.

remote_nodes

Tells OPatch the list of remote nodes. You can use this option on Oracle Real Application Clusters environments. The node names must be separated with commas, but without spaces.

report

Prints the action to the screen without executing it.

retry

Tells OPatch how many times it should retry when there is an inventory lock failure.

runSql

Tells OPatch to run the SQL script and SQL procedures if they exist in the given patch. For information on SQL and PL/SQL patching, see "Schema Patching".

silent

Suppresses user interaction, and defaults any answers to "yes."

sqlScript

Specifies the custom SQL script that OPatch should run after patching completes. For information on SQL and PL/SQL patching, see "Schema Patching".

verbose

Prints additional OPatch output to the screen as well as to the log file.

Note:

If a patch consists of SQL changes, follow the instructions in the patch readme, which is included with the patch to apply the SQL scripts.

Napply Command for OUI-based Oracle Homes

This command applies interim patches to several Oracle homes at the same time.

Syntax

Use the following syntax for this command:

opatch napply [patch_location] [-id comma-separated list of patch IDs]                          [-delay <value> ] [ -force ]                      [-invPtrLoc <Path to oraInst.loc> ]                      [-jdk <LOC> ] [-jre <LOC> ] [ -local ]                      [-minimize_downtime ] [-no_bug_superset ]                      [-no_inventory ] [-oh <ORACLE_HOME> ]                      [-retry <value> ] [-silent ]                      [-verbose ]  [-no_relink]                       [-pre <parameters for the pre script in                      escaped double quotes> [-opatch_pre_end] ]                      [-post <parameters for the post script in                      escaped double quotes> [-opatch_post_end] ]                      [-no_sysmod]                      [ -property_file <Path to property file> ]                      [ -local_node <Local node name> ]                      [ -remote_nodes <List of remote nodes (node1,node2)> ]                      [ -all_nodes ]                      [ -phBaseFile <Path to the file containing the                        location of the patches to be applied> ]                      [-skip_subset] [-skip_duplicate] [-report]

Examples

The following example applies all patches under the <patch_location> directory:

opatch napply <patch_location>

The following example applies patches 1, 2, and 3 that are under the <patch_location> directory:

opatch napply <patch_location> -id 1,2,3

The following example applies all patches under the <patch_location> directory. OPatch skips duplicate patches and subset patches (patches under <patch_location> that are subsets of patches installed in the Oracle home).

opatch napply <patch_location> -skip_subset -skip_duplicate

See the description for the skip_subset option in Table 7-3 for more information.

The following example applies patches 1, 2, and 3 that are under the <patch_location> directory. OPatch skips duplicate patches and subset patches (patches under <patch_location> that are subsets of patches installed in the Oracle home).

opatch napply <patch_location> -id 1,2,3 -skip_subset -skip_duplicate

See the description for the skip_subset option in Table 7-3 for more information.

Options

Table 7-3 lists the options available for this command.

Table 7-3 Napply Options for OUI Patches

Option
Description

all_nodes

Applies the patch using the all-node mode.

delay

Specifies how many seconds to wait before attempting to lock the inventory again for a previous failure. You can use this option only if you specify the retry option.

force

Removes conflicting patches from the system. If a conflict exists that prevents the patch from being applied, you can use this option to apply the patch. OPatch removes all the conflicting patches before applying the current patch.

invPtrLoc

Specifies the location of the oraInst.loc file. The invPtrLoc option is needed when this option is used during installation. Oracle recommends the use of the default Central Inventory for a platform.

jdk

Instructs OPatch to use JDK (jar) from the specified location instead of the default location under the Oracle home directory. If you do not specify the jre option, JVM is executed from the jdk location.

jre

Instructs OPatch to use JRE (Java) from the specified location instead of the default location under the Oracle home directory. You cannot specify the jdk and jre options together.

local

Specifies that OPatch should patch the local node and update the inventory of the local node. It does not propagate the patch or inventory update to other nodes.

You can use this option on Oracle Real Application Clusters environments and non-clustered environments. If an entire cluster is shut down before patching, you can use this option for non-rolling patches.

local_node

Tells OPatch the local node for this cluster. You can use this option on Oracle Real Application Clusters environments.

minimize_downtime

Specifies the order of nodes that OPatch should patch.

This option only applies to Oracle Real Application Clusters environments. You cannot use it with the -local option with a rolling patch.

no_bug_superset

Specifies to error out if the current patch's bugs-to-fix is a superset (or same set) of an installed patch's bugs-fixed in the Oracle home directory.

no_inventory

Bypasses the inventory for reading and updates. You cannot use this option with the local option. This option places the installation into an unsupported state.

no_relink

This option does not perform any make operations. You can use it during multiple patch applications and to perform the linking step only once. OPatch does not keep track of the make operations it did not perform. You need to make sure to execute OPatch without this option at the end for compilation.

no_sysmod

Specifies that OPatch does not need to update the files in the system. It only updates the inventory. It also does not execute the pre and post scripts.

oh

Specifies the Oracle home directory to use instead of the default. This takes precedence over the environment variable ORACLE_HOME.

opatch_post_end

Marks the end of the post option. You use this option with the post option. If you do not use this option, everything after post until the end of the command is passed into post.

opatch_pre_end

Marks the end of the pre options. You use this option with the pre option. If you do not use this option, everything after pre until the end of the command is passed into pre.

Patch Location

Indicates the path to the patch location. If you do not specify the location, OPatch assumes the current directory is the patch location.

phBaseFile

If you do not specify <patch_location>, use this option to point OPatch to a file containing a list of patches to be n-applied. Each line in the file points to a location of a patch.

post

Specifies the parameters to be passed to the post script. This script is executed after the patch is applied. You need to enclose the values for this option in double-quotes.

pre

Specifies the parameters to be passed to the pre script. This script is executed before the patch is applied. You need to enclose the values for this option in double-quotes.

property_file

Specifies the user-defined property file for OPatch to use. The path to the property file should be absolute. This property file takes precedence over the one that OPatch supplies.

remote_nodes

Tells OPatch the list of remote nodes. You can use this option on Oracle Real Application Clusters environments. The node names must be separated with commas, but without spaces.

report

Prints the action to the screen without executing it.

retry

Tells OPatch how many times it should retry when there is an inventory lock failure.

silent

Suppresses user interaction, and defaults any answers to "yes."

skip_duplicate

Skips patches to be applied that are duplicates of other patches installed in the Oracle home. Two patches are duplicates if they fix the same set of bugs.

skip_subset

Skips patches to be applied that are subsets of other patches installed in the Oracle home. One patch is a subset of another patch if the former fixes a subset of bugs fixed by the latter.

For example, if you used napply yesterday for patch A that fixed bugs 1 and 2, then you use napply today with this option for patch B that fixes bug 1 and patch C that fixes bugs 1, 2, and 3, then subset patch A is skipped, and patch C then becomes a superset of patch A.

verbose

Prints additional OPatch output to the screen as well as to the log file.

Lsinventory Command for OUI-based Oracle Homes

This command lists the inventory for a particular Oracle home, or displays all installations that can be found. This command does not have any required options.

Syntax

Use the following syntax for this command:

opatch lsinventory [-all ][-all_nodes]
               [-bugs_fixed asc|desc]
               [-delay <value> ][-detail ]
               [-group_by_date]
               [-invPtrLoc <Path to oraInst.loc> ][-jre <LOC> ]
               [-oh <ORACLE_HOME> ]
               [-patch asc|desc]
               [-property_file <path to property file>]
               [-retry <value> ]

See Table 7–4 for descriptions of the command options.

-detail Option Example

The following example shows the output of opatch lsinventory -detail:

Oracle interim Patch Installer version 11.1.0.6.5
Copyright (c) 2008, Oracle Corporation.  All rights reserved..
Oracle Home       : /home/oracle_TEST/product/11.1.0/db_1
Central Inventory : /home/OUIHome_Opatch
   from           : /home/oracle_TEST/product/11.1.0/db_1/oraInst.loc
OPatch version    : 11.1.0.6.5
OUI version       : 11.1.0.6.5
OUI location      : /home/oracle_TEST/product/11.1.0/db_1/oui
Log file location : /home/oracle_
TEST/product/11.1.0/db1/cfgtoollogs/opatch/opatch-2008_May_25_11-09-34-IST_Wed.log
Patch history file: /scratch/userid/newDB/cfgtoollogs/opatch/opatch_history.txt
Lsinventory Output file location : /home/oracle_TEST/product/11.1.0/db_
1/cfgtoollogs/opatch/lsinv/lsinventory-2008_May_25_11-09-34-IST_Wed.txt
 --------------------------------------------------------------------------------
Installed Top-level Products (1):
Oracle Database 11g                                                  11.1.0.6.5
There are 1 products installed in this Oracle Home.
Installed Products (10):
Agent Required Support Files                                         11.1.0.6.5
Assistant Common Files                                               11.1.0.6.5
Bali Share                                                           1.1.18.0.0
Buildtools Common Files                                              11.1.0.6.5
Character Set Migration Utility                                      11.1.0.6.5
Database Configuration and Upgrade Assistants                        11.1.0.6.5
Database SQL Scripts                                                 11.1.0.6.5
Database Workspace Manager                                           11.1.0.6.5
DBJAVA Required Support Files                                        11.1.0.6.5
Enterprise Edition Options                                           11.1.0.6.5
There are 10 products installed in this Oracle Home.
Intermin patches (1) :
Patch  111000       : applied on Mon May 23 19:44:08 IST 2008
Created on 27 Jul 2007, 05:43:46 hrs PST8PDT
Bugs fixed: 111000
Files Touched:
/qmtest.o --> ORACLE_HOME/lib/libserver11.a
libmapsym.so --> ORACLE_HOME/lib/libmapsym.so
ins_rdbms.mk --> ORACLE_HOME/rdbms/lib/ioracle
/oracle/xml/jaxb/orajaxb.class --> ORACLE_HOME/lib/xml.jar
Patch Location in Inventory:
/home/oracle_TEST/product/11.1.0/db_1/inventory/oneoffs/111000
Patch Location in Storage area:
/home/oracle_TEST/product/11.1.0/db_1/.patch_storage/111000_Jul_27_2007_05_43_46
 --------------------------------------------------------------------------------
 OPatch succeeded.

-bugs_fixed Option Example

The following example shows the output of opatch lsinventory -bugs_fixed asc:

Oracle interim Patch Installer version 11.1.0.6.5
Copyright (c) 2008, Oracle Corporation.  All rights reserved..
Oracle Home       : /home/oracle_TEST/product/11.1.0/db_1
Central Inventory : /home/OUIHome_Opatch
   from           : /home/oracle_TEST/product/11.1.0/db_1/oraInst.loc
OPatch version    : 11.1.0.6.5
OUI version       : 11.1.0.6.5
OUI location      : /home/oracle_TEST/product/11.1.0/db_1/oui
Log file location : /home/oracle_
TEST/product/11.1.0/db1/cfgtoollogs/opatch/opatch-2008_May_25_11-09-34-IST_Wed.log
Patch history file: /scratch/userid/newDB/cfgtoollogs/opatch/opatch_history.txt
Lsinventory Output file location : /home/oracle_TEST/product/11.1.0/db_
1/cfgtoollogs/opatch/lsinv/lsinventory-2008_May_25_11-09-34-IST_Wed.txt
 --------------------------------------------------------------------------------
Installed Top-level Products (2):

Oracle Database 11g                                                  11.1.0.6.5
Oracle Database 11g Release 2 Patch Set 2                            11.1.0.6.5
There are 2 products installed in this Oracle Home.

List of Bugs fixed by Installed Patches:

Bug        Fixed by          Installed at                   Description
           Patch
---        --------          ------------                   -----------

1000000    6079591   Mon Oct 13 02:03:42 PDT 2008   test bug
6079591    6079591   Mon Oct 13 02:03:42 PDT 2008   MLR BUG FOR 10.2.0:.3 FOR CPU:JUL2:007
300500     300500    Fri Sep 05 02:25:34 PDT 2008   Demo bug for patching files
300501     300500    Fri Sep 05 02:25:34 PDT 2008   Demo bug for patching files
300502     300500    Fri Sep 05 02:25:34 PDT 2008   Demo bug for patching files
6121268    6121268   Tue Aug 19 23:32:33 PDT 2008   DB-10.2.0.3-MOLECULE-007-CPUJUL2007
6121266    6121266   Tue Aug 19 23:32:27 PDT 2008   DB-10.2.0.3-MOLECULE-018-CPUJUL2007
6121264    6121264   Tue Aug 19 23:32:22 PDT 2008   DB-10.2.0.3-MOLECULE-017-CPUJUL2007
6121263    6121263   Tue Aug 19 23:32:14 PDT 2008   DB-10.2.0.3-MOLECULE-016-CPUJUL2007
6121261    6121261   Tue Aug 19 23:32:08 PDT 2008   DB-10.2.0.3-MOLECULE-014-CPUJUL2007
6121260    6121260   Tue Aug 19 23:32:02 PDT 2008   DB-10.2.0.3-MOLECULE-013-CPUAPR2007
6121258    6121258   Tue Aug 19 23:31:56 PDT 2008   DB-10.2.0.3-MOLECULE-012-CPUJUL2007
6121257    6121257   Tue Aug 19 23:31:50 PDT 2008   DB-10.2.0.3-MOLECULE-011-CPUAPR2007
6121250    6121250   Tue Aug 19 23:31:43 PDT 2008   DB-10.2.0.3-MOLECULE-009-CPUAPR2007
6121246    6121246   Tue Aug 19 23:31:25 PDT 2008   DB-10.2.0.3-MOLECULE-005-CPUJAN2007
6121245    6121245   Tue Aug 19 23:30:15 PDT 2008   DB-10.2.0.3-MOLECULE-004-CPUJAN2007
6121244    6121244   Tue Aug 19 23:29:58 PDT 2008   DB-10.2.0.3-MOLECULE-003-CPUJAN2007
6121243    6121243   Tue Aug 19 23:29:42 PDT 2008   DB-10.2.0.3-MOLECULE-002-CPUJAN2007
6121183    6121183   Tue Aug 19 23:29:37 PDT 2008   DB-10.2.0.3-MOLECULE-010-CPUAPR2007
4000000    3000000   Mon Aug 18 08:33:09 PDT 2008   DEMO BUG CONTAINING ALL ACTIONS
6120       90        Tue Aug 05 01:10:26 PDT 2008   OPATCH 11G: Unable to do napply with overlay ands
                                                    superset patches
102345     102345    Tue Jul 15 04:24:33 PDT 2008   Demo Bug Containing All Actions
10         1         Fri Jun 20 02:40:40 PDT 2008   Demo bug for patching files
11         1         Fri Jun 20 02:40:40 PDT 2008   Demo bug for patching files
12         1         Fri Jun 20 02:40:40 PDT 2008   Demo bug for patching files
6121267    6397948   Fri Apr 18 03:41:38 PDT 2008   DB-10.2.0.3-MOLECULE-019-CPUJUL2007
6397948    6397948   Fri Apr 18 03:41:38 PDT 2008   DB-10.2.0.3-MOLECULE-033-CPUOCT2007
6397947    6397947   Fri Apr 18 03:41:32 PDT 2008   DB-10.2.0.3-MOLECULE-032-CPUOCT2007
6397945    6397945   Fri Apr 18 03:41:26 PDT 2008   DB-10.2.0.3-MOLECULE-030-CPUOCT2007
6397943    6397943   Fri Apr 18 03:41:11 PDT 2008   DB-10.2.0.3-MOLECULE-028-CPUOCT2007
6397942    6397942   Fri Apr 18 03:41:05 PDT 2008   DB-10.2.0.3-MOLECULE-027-CPUOCT2007
6397941    6397941   Fri Apr 18 03:40:59 PDT 2008   DB-10.2.0.3-MOLECULE-026-CPUOCT2007
6397940    6397940   Fri Apr 18 03:40:51 PDT 2008   DB-10.2.0.3-MOLECULE-025-CPUOCT2007
6397938    6397938   Fri Apr 18 03:40:43 PDT 2008   DB-10.2.0.3-MOLECULE-023-CPUOCT2007
6397937    6397937   Fri Apr 18 03:40:37 PDT 2008   DB-10.2.0.3-MOLECULE-022-CPUOCT2007
6397929    6397929   Fri Apr 18 03:40:31 PDT 2008   DB-10.2.0.3-MOLECULE-021-CPUOCT2007
6394981    6394981   Fri Apr 18 03:40:26 PDT 2008   MLR BUG FOR 10.2.0.3 FOR CPUOCT2007
6111111    6121249   Fri Apr 18 03:39:21 PDT 2008   dummy
6121249    6121249   Fri Apr 18 03:39:21 PDT 2008   DB-10.2.0.3-MOLECULE-008-CPUAPR2007
6667542    6667542   Tue Feb 12 05:51:00 PST 2008   DB-10.2.0.3-MOLECULE-038-CPUJAN2008
6650105    6650105   Tue Feb 12 05:50:54 PST 2008   DB-10.2.0.3-MOLECULE-037-CPUJAN2008
6121248    6650096   Tue Feb 12 05:50:48 PST 2008   DB-10.2.0.3-MOLECULE-015-CPUJUL2007
6650096    6650096   Tue Feb 12 05:50:48 PST 2008   DB-10.2.0.3-MOLECULE-036-CPUJAN2008
6121247    6650095   Tue Feb 12 05:50:41 PST 2008   DB-10.2.0.3-MOLECULE-006-CPUAPR2007
6397946    6650095   Tue Feb 12 05:50:41 PST 2008   DB-10.2.0.3-MOLECULE-031-CPUOCT2007
6650095    6650095   Tue Feb 12 05:50:41 PST 2008   DB-10.2.0.3-MOLECULE-035-CPUJAN2008
6650081    6650081   Tue Feb 12 05:50:35 PST 2008   DB-10.2.0.3-MOLECULE-034-CPUJAN2008
6646853    6646853   Tue Feb 12 05:50:28 PST 2008   MLR BUG FOR 10.2.0.3 FOR CPUJAN2008
6452863    6452863   Tue Feb 12 05:50:12 PST 2008   TRACKING BUG FOR CPUJUL2007
 --------------------------------------------------------------------------------
 OPatch succeeded.

-patch desc Option Example

The following example shows the output of opatch lsinventory -patch desc:

Oracle interim Patch Installer version 11.1.0.6.5
Copyright (c) 2008, Oracle Corporation.  All rights reserved..
Oracle Home       : /home/oracle_TEST/product/11.1.0/db_1
Central Inventory : /home/OUIHome_Opatch
   from           : /home/oracle_TEST/product/11.1.0/db_1/oraInst.loc
OPatch version    : 11.1.0.6.5
OUI version       : 11.1.0.6.5
OUI location      : /home/oracle_TEST/product/11.1.0/db_1/oui
Log file location : /home/oracle_
TEST/product/11.1.0/db1/cfgtoollogs/opatch/opatch-2008_May_25_11-09-34-IST_Wed.log
Patch history file: /scratch/userid/newDB/cfgtoollogs/opatch/opatch_history.txt
Lsinventory Output file location : /home/oracle_TEST/product/11.1.0/db_
1/cfgtoollogs/opatch/lsinv/lsinventory-2008_May_25_11-09-34-IST_Wed.txt
 --------------------------------------------------------------------------------
Interim patches (39) :

Patch  6079591      : applied on Mon Oct 13 02:03:42 PDT 2008
   Created on 21 Jun 2007, 03:42:18 hrs PST8PDT
   Bugs fixed:
     6079591, 1000000

Patch  300500       : applied on Fri Sep 05 02:25:34 PDT 2008
   Created on 07 Nov 2005, 04:57:14 hrs US/Eastern
   Bugs fixed:
     300500, 300501, 300502
 --------------------------------------------------------------------------------
 OPatch succeeded.

Lsvinventory Options

Table 7-4 lists the options available for this command.

Table 7-4 Lsinventory Options for OUI Patches

Option
Description

all

Reports the name and installation directory for each Oracle home directory found.

all_nodes

Reports the patches installed on the given Oracle home in all nodes of the RAC system. It also prints the Oracle binary's size and checksum on all nodes. You cannot use this option with the all, detail, or patch options.

bugs_fixed

Reports bugs fixed by installed patches in a tabular format. Besides the bugs fixed, the report also displays the installed patches, installed times, and bug descriptions.

The fixed bugs are sorted per installed patch. The report appears in ascending order (asc), which is the default, or you can specify descending order (desc) for the report. Asc sorts fixed bugs in ascending order within a patch, and the most recent patch is listed first, followed by the next most recent, and so forth. Desc sorts fixed bugs in descending order within a patch, and the oldest patch is listed first, followed by the next oldest, and so forth.

You can use this option with the patch option to obtain sort orders with installed patches.

delay

If you specify retry, this option tells OPatch how many seconds it should wait before attempting to lock the inventory again in case of a previous failure.

detail

Reports the installed products and other details. You cannot use this option with the all option.

group_by_date

Specifies that OPatch should group all installed patches by the date they were installed in the Oracle home.

invPtrLoc

Specifies the location of the oraInst.loc file. You need this option if you used the invPtrLoc option during installation. Oracle recommends the use of the default Central Inventory for a platform.

jre

Specifies the location of a particular JRE (Java) for OPatch to use instead of the default location under the Oracle home directory.

oh

Specifies the Oracle home directory to use instead of the default directory. This takes precedence over the ORACLE_HOME environment variable.

patch

Lists the patch IDs installed in the Oracle home in ascending (asc) or descending (desc) order, which is the default, based on installed time. This option also shows the file location for the patch history (opatch_history.txt file).

property_file

Indicates the user-defined property file that OPatch should use. The path to the property should be absolute. This property file takes precedence over the property file that OPatch supplies.

retry

Specifies how many times OPatch should retry when there is an inventory lock failure.

Query Command for OUI-based Oracle Homes

This command queries a specific patch for specific details. It provides information about the patch and the system being patched.

Syntax

Use the following syntax for this command:

opatch query  [-all] [-jre <LOC> ] [-oh <LOC> ]              [-get_component] [-get_os] [-get_date]              [-get_base_bug] [-is_portal_patch]              [-is_rolling_patch] [-is_online_patch]              [-has_sql] [ <Patch Location> ]

Options

Table 7-5 lists the options available for the Query command.

Table 7-5 Query Options

Option
Description

all

Retrieves all information about a patch. This is equivalent to setting all available options.

get_base_bug

Retrieves bugs fixed by the patch.

get_component

Retrieves components the patch affects.

get_date

Retrieves the patch creation date and time.

has_sql

Indicates true if the patch has SQL-related actions. Otherwise, the option is false. For information on SQL and PL/SQL patching, see "Schema Patching".

is_online_patch

Indicates true if the patch is an online patch. Otherwise, the option is false.

is_portal_patch

Indicates true if the patch has portal actions. Otherwise, the option is false.

is_rolling_patch

Indicates true if the patch is a rolling patch. Otherwise, the option is false.

oh

Specifies the Oracle home directory to use instead of the default directory. This takes precedence over the ORACLE_HOME environment variable.

Patch Location

Indicates the path to the patch location. If you do not specify the location, OPatch assumes the current directory is the patch location.

Rollback Command for OUI-based Oracle Homes

This command removes an existing one-off patch from the appropriate Oracle home directory indicated by the reference ID.

Syntax

Use the following syntax for this command:

opatch rollback -id <ID> [-ph <Patch Location>]  [-delay <value>]
              [-invPtrLoc <Path to oraInst.loc> ]
              [-jre <LOC> ] [-local]  [-oh <ORACLE_HOME>]
              [-retry <value>]  [-silent]  [-verbose]
              [-no_relink] [-pre <parameters for the pre
              script in escaped double quotes> [-opatch_pre_end] ]
              [-post <parameters for the post script in escaped
              double quotes>[ -opatch_post_end] ] [-no_sysmod]
              [-property_file <path to property file>]
              [-local_node <Local node name>]
              [-remote_nodes <List of remote nodes (node1,node2)>]
              [-connectString  <List of connect strings>]
              [-ptlSchema <portal schema>] [-ptlPassword <portal password>]
              [-ptlConnect <portal connect string>]
              [-runSql] [-sqlScript <path of the sql file>]
              [-init <parameters for the init script in escaped double
              quotes> [-opatch_init_end] ] [-report]

Options

Table 7-6 lists the options available for the Rollback command.

Table 7-6 Rollback Options for OUI Patches

Option
Description

all_nodes

Rolls back the patch using the all-nodes mode.

connectString

Specifies the list of database instances on which the patch needs to be applied. Specify the value for this option using the following syntax:

SID:User:Passwd:Node

Example:

oracle:dba:dba:mymachine,oracle1:::

The SID is required, but you can disregard the other parameters if desired, because OPatch provides default values for them.

Note: If the system is not part of a RAC setup and you want to patch just the local node, provide the node name as an empty string.

delay

If you use the retry option with the rollback command, specifies how many seconds OPatch should wait before attempting to lock the inventory again if a previous failure occurs.

id

Indicates the patch to be rolled back. Use the lsinventory option to display all patch identifiers. Each one-off patch is indicated by its ID. To successfully roll back a patch, you must provide the patch identifier.

init

Passes parameters to the init script, which executes before prerequisite checks are run. The values for this option must be enclosed in double-quotes.

invPtrLoc

Specifies the location of the oraInst.loc file. You need to use this option if you used the invPtrLoc option during installation. Oracle recommends the use of the default Central Inventory for a platform.

jre

Specifies the location of a particular JRE (Java) for OPatch to use instead of the default location under the Oracle home directory.

local

Specifies that OPatch roll back the local node, then update the inventory of the local node. It does not propagate the patch or inventory update to other nodes.

You can use this option on Oracle Real Application Clusters environments and non-clustered environments. If an entire cluster is shut down before patching, you can use this option for non-rolling patches.

local_node

Specifies to OPatch that this is the local node for the cluster to be used for rollback.

You can use this option for Oracle Real Application Clusters environments.

no_sysmod

Specifies that OPatch need not update the files in the system, only the inventory. It also does not execute the pre and post scripts.

no_relink

This option does not perform any make operation in the patch. You can use this option during multiple patch removals and to perform the compilation step only once.

oh

Specifies the Oracle home directory to use instead of the default directory. This takes precedence over the ORACLE_HOME environment variable.

opatch_init_end

Marks the end of the init options. Use this option with the init option. If you do not use this option, everything after init until the end of the command is passed into init.

opatch_post_end

Marks the end of the post options. Use this option with the post option. If you do not use this option, everything after post until the end of the command is passed into post.

opatch_pre_end

Marks the end of the pre options. Use this option with the pre option. If you do not use this option, everything after pre until the end of the command is passed into pre.

Patch Location

Indicates the path to the patch location. If you do not specify the location, OPatch assumes the current directory is the patch location.

ph

Specifies the valid patch directory area. Rollback uses the command types found in the patch directory to identify which commands are used for the current operating system.

post

Specifies the parameters to be passed inside the post script. This script executes after the patch is removed. You must enclose the value of this option in double-quotes.

pre

Specifies the parameters to be passed inside the pre script. This script executes before the patch is removed. You must enclose the value of this option in double-quotes.

property_file

Specifies the user-defined property file for OPatch to use. The path to the property file should be absolute. This property file takes precedence over the one that OPatch supplies.

ptlConnect

Specifies the connection string credentials of the portal schema.

ptlSchema

Specifies the schema of the portal repository.

ptlPassword

Specifies the password of the portal schema.

remote_nodes

Specifies to OPatch the list of remote nodes to be used for rollback of the patch. The node names must be separated with commas, but without spaces.

You can use this option on Oracle Real Application Clusters environments.

report

Prints the actions to the screen without executing them.

retry

Instructs OPatch how many times it should retry when there is an inventory lock failure.

runSql

Instructs OPatch to run the SQL script and SQL procedures if they exist in the given patch. For information on SQL and PL/SQL patching, see "Schema Patching".

sqlScript

Specifies the custom SQL script that OPatch should run after patching completes. For information on SQL and PL/SQL patching, see "Schema Patching".

silent

Suppresses user interaction, and defaults any yes|no questions to "yes". A Real Application Clusters setup does not support this option.

verbose

Prints additional OPatch output to the screen as well as to the log file.

Nrollback Command for OUI-based Oracle Homes

This command rolls back interim patches from several Oracle homes at the same time.

Syntax

Use the following syntax for this command:

opatch nrollback -id <comma-separated list of patch IDs>                      [-delay <value>] [-invPtrLoc <Path to oraInst.loc> ]                      [-jdk <LOC> ] [-jre <LOC> ] [-local]                       [-minimize_downtime] [-no_relink] [-oh <ORACLE_HOME> ]                      [-retry <value>]  [-silent]  [-verbose]                      [-pre <parameters for the pre script in                       escaped double quotes> [-opatch_pre_end] ]                      [-post <parameters for the post script in                       escaped double quotes>[ -opatch_post_end] ]                      [-no_sysmod] [-property_file <Path to property file>]                      [-local_node <Local node name>]                      [-remote_nodes <List of remote nodes (node1,node2)>]                      [ -all_nodes ] [-report]

Example

The following example rolls back patches 1, 2, and 3 that have been installed in the Oracle home:

opatch nrollback -id 1,2,3

Options

Table 7-7 lists the options available for this command.

Table 7-7 Nrollback Options for OUI Patches

Option
Description

all_nodes

Rolls back the patch using the all-nodes mode.

delay

If you use the retry option with the rollback command, specifies how many seconds OPatch should wait before attempting to lock the inventory again if a previous failure occurs.

id

Indicates the patch to be rolled back. Use the lsinventory option to display all patch identifiers. Each one-off patch is indicated by its ID. To successfully roll back a patch, you must provide the patch identifier.

invPtrLoc

Specifies the location of the oraInst.loc file. You need to use this option if you used the invPtrLoc option during installation. Oracle recommends the use of the default Central Inventory for a platform.

jdk

Instructs OPatch to use JDK (jar) from the specified location instead of the default location under the Oracle home directory. If you do not specify the jre option, JVM is executed from the jdk location.

jre

Specifies the location of a particular JRE (Java) for OPatch to use instead of the default location under the Oracle home directory.

local

Specifies that OPatch roll back the local node, then update the inventory of the local node. It does not propagate the patch or inventory update to other nodes.

You can use this option on Oracle Real Application Clusters environments and non-clustered environments. If an entire cluster is shut down before patching, you can use this option for non-rolling patches.

local_node

Specifies to OPatch that this is the local node for the cluster to be used for rollback.

You can use this option for Oracle Real Application Clusters environments.

minimize_downtime

Specifies the order of nodes that OPatch should patch.

This option only applies to Oracle Real Application Clusters environments. You cannot use it with the -local option with a rolling patch.

no_sysmod

Specifies that OPatch need not update the files in the system, only the inventory. It also does not execute the pre and post scripts.

no_relink

This option does not perform any make operation in the patch. You can use this option during multiple patch removals and to perform the compilation step only once.

oh

Specifies the Oracle home directory to use instead of the default directory. This takes precedence over the ORACLE_HOME environment variable.

opatch_post_end

Marks the end of the post options. Use this option with the post option. If you do not use this option, everything after post until the end of the command is passed into post.

opatch_pre_end

Marks the end of the pre options. Use this option with the pre option. If you do not use this option, everything after pre until the end of the command is passed into pre.

Patch Location

Indicates the path to the patch location. If you do not specify the location, OPatch assumes the current directory is the patch location.

property_file

Specifies the user-defined property file for OPatch to use. The path to the property file should be absolute. This property file takes precedence over the one that OPatch supplies.

remote_nodes

Specifies to OPatch the list of remote nodes to be used for rollback of the patch. The node names must be separated with commas, but without spaces.

You can use this option on Oracle Real Application Clusters environments.

report

Prints the actions to the screen without executing them.

retry

Instructs OPatch how many times it should retry when there is an inventory lock failure.

silent

Suppresses user interaction, and defaults any yes|no questions to "yes". A Real Application Clusters setup does not support this option.

verbose

Prints additional OPatch output to the screen as well as to the log file.

Version Command for OUI-based Oracle Homes

This command shows the current version number of the OPatch utility. Use the following syntax for this command:

<Path_to_OPatch>/opatch version

Standalone Patching

Standalone patching is available for Oracle homes that have not been installed using the Oracle Universal Installer. Standalone patching does not have Central Inventory registration, but still generates inventory files for the one-off inventory and future conflict checking. OPatch uses the presence of the OUI directory under ORACLE_HOME to determine whether it should operate in OUI-based or standalone mode.

The following sections discuss these standalone patching topics:

Unsupported services for standalone patching

Standalone patching requirements

OPatch commands for standalone patching

Use cases

Unsupported Services for Standalone Patching

Standalone patching provides most of the services that OUI-based patching provides. However, standalone patching does not provide the following services that OUI-based patching provides.

Looking up the component inventory

Standalone OPatch enables you to look up which patches have been applied to a standalone Oracle home, but it does not support looking up product components. For example, if you run opatch lsinventory on a JDeveloper Oracle Home, OPatch shows a list of patches applied on the home. It does not show which components the home has, however.

Looking up the Central Inventory

You cannot run opatch lsinventory –all to list all Oracle homes registered on the host (through the Central Inventory repository).

Migrating from standalone to OUI-based patching and vice versa

The assumption is that after you have installed a product as standalone without OUI, it remains standalone. For example, after having installed JDeveloper, you cannot put OUI (through copying or proper installation) onto the Oracle home and expect OPatch to treat the home as an OUI-based Oracle home.

Conversely, the assumption is that after you have installed a product with OUI, it remains OUI-based. For example, after you install Oracle RDBMS, you cannot remove OUI (either by removing or proper deinstallation) and expect OPatch to treat the home as a standalone Oracle home. OPatch will not work properly in this case and will corrupt the home.

Interoperating between standalone and OUI-based patches

Since you cannot migrate a home from standalone to OUI-based and vice versa, OPatch does not support interoperability between standalone and OUI-based Oracle homes.

Seamlessly working on a cloned standalone Oracle home

If you clone a standalone Oracle home S1 to another Oracle home OH2, Opatch will not function properly on the new cloned OH2.

Supporting RAC

OPatch relies on OUI to detect RAC and propagate files. Hence, standalone OPatch does not support RAC; it does not attempt to detect RAC, and its utility will not work. That is, OPatch always runs as opatch apply –local. OPatch does not support any patch propagation from one node to another node. Also, standalone OPatch does not support RAC-related utilities such as opatch util runRemoteMake (invokes relink on remote node).

Performing patch set operations

OPatch does not support patch set operations in either standalone or OUI modes. You need to use OUI for patch set operations.

Standalone Patching Requirements

Standalone patching requires the following environment:

JRE version 1.4 or later

Oracle home without OUI

OPatch that supports standalone patching

All of the required files and directories must exist for OPatch to function correctly. If any of the files are missing, OPatch perceives that the patch has not been applied. You would then have to take corrective action, returning the standalone inventory to a stable state.

OPatch Utility for Standalone Homes

As with OUI-based patching, you can run the OPatch utility, located in the <Path_to_Oracle_Home>/OPatch directory, with various commands and options. The following string shows the syntax for the OPatch utility:

<Path_to_OPatch>/opatch [-help] [-r[eport]] [command] [-option]

where:

help — Displays the help message for the command.

report — Prints the actions without executing.

command — One of the OPatch commands.

option — One of the OPatch command options.

Table 7-8 lists the commands available for standalone patching.

Table 7-8 OPatch Standalone Commands

Command
Description

apply

Installs an interim patch. See "Apply Command for Standalone OPatch" for more information.

lsinventory

Lists what is currently installed on the system. See "Lsinventory Command for Standalone OPatch" for more information.

query

Queries a given patch for specific details. See "Query Command for Standalone OPatch" for more information.

rollback

Removes an interim patch. See "Rollback Command for Standalone OPatch" for more information.

version

Prints the current version of the patch tool. See "Version Command for Standalone OPatch" for more information.

The following sections provide the syntax and options for each of these commands.

Apply Command for Standalone OPatch

The Apply command applies an interim patch to a standalone home from the current directory.

Syntax

Use the following syntax for this command:

opatch apply  [ -force ] [-jre <LOC> ] [-no_bug_superset ] [-no_inventory ]              [-oh <ORACLE_HOME> ][-silent ][-verbose ]                [-no_relink] [-pre <parameters for the              pre script in escaped double quotes> [-opatch_pre_end] ]              [-post <parameters for the post script in escaped              quotes> [-opatch_post_end] ] [-no_sysmod]              [-property_file <Path to property file>]               [-init <parameters for the init script in escaped double              quotes> [-opatch_init_end] ] [-report]              [<Patch Location>]

Options

Table 7-9 lists the options available for the Apply command.

Table 7-9 Apply Options for Standalone Patches

Option
Description

force

Removes conflicting patches from the system by enabling you to change the product and version number of the standalone Oracle home. OPatch removes all the conflicting patches before applying the current patch.

init

Passes parameters to the init script, which executes before prerequisite checks are run. The values for this option must be enclosed in double-quotes.

jre

Instructs OPatch to use JRE (Java) from the specified location instead of the default location under the Oracle home directory.

no_bug_superset

Specifies to error out if the current patch's bugs-to-fix is a superset (or same set) of an installed patch's bugs-fixed in the Oracle home directory.

no_inventory

Bypasses the inventory for reading and updates. You cannot use this option with the local option. This option places the installation into an unsupported state.

no_relink

This option does not perform any make operations. You can use it during multiple patch applications and to perform the linking step only once. OPatch does not keep track of the make operations it did not perform. You need to make sure to execute OPatch without this option at the end for compilation.

no_sysmod

Specifies that OPatch does not need to update the files in the system. It only updates the inventory. It also does not execute the pre and post scripts.

oh

Specifies the Oracle home directory to use instead of the default. This takes precedence over the environment variable ORACLE_HOME.

opatch_init_end

Marks the end of the init options. You use this option with the init option. If you do not use this option, everything after init until the end of the command is passed into init.

opatch_post_end

Marks the end of the post option. You use this option with the post option. If you do not use this option, everything after post until the end of the command is passed into post.

opatch_pre_end

Marks the end of the pre options. You use this option with the pre option. If you do not use this option, everything after pre until the end of the command is passed into pre.

Patch Location

Indicates the path to the patch location. If you do not specify the location, OPatch assumes the current directory is the patch location.

post

Specifies the parameters to be passed to the post script. This script is executed after the patch is applied. You need to enclose the values for this option in double-quotes.

pre

Specifies the parameters to be passed to the pre script. This script is executed before the patch is applied. You need to enclose the values for this option in double-quotes.

property_file

Specifies the user-defined property file for OPatch to use. The path to the property file should be absolute. This property file takes precedence over the one that OPatch supplies.

silent

Suppresses user interaction, and defaults any answers to "yes."

verbose

Prints additional OPatch output to the screen as well as to the log file.

Lsinventory Command for Standalone OPatch

The Lsinventory command lists the inventory for a particular Oracle home, or displays all installations that can be found. This command does not have any required options.

Syntax

Use the following syntax for this command:

opatch lsinventory [-all ]  [-detail ] [-jre <LOC> ]               [-oh <ORACLE_HOME> ] [-patch] [-oh]               [-property_file <path to property file>]

Options

Table 7-11 lists the options available for the Lsinventory command.

Table 7-10 Lsinventory Options for Standalone Patches

Option
Description

all

Reports the name and installation directory for each Oracle home directory found.

detail

Reports the installed products and other details. You cannot use this option with the all option.

jre

Specifies the location of a particular JRE (Java) for OPatch to use instead of the default location under the Oracle home directory.

oh

Specifies the Oracle home directory to use instead of the default directory. This takes precedence over the ORACLE_HOME environment variable.

patch

Specifies the patches installed in the Oracle home.

property_file

Indicates the user-defined property file that OPatch should use. The path to the property should be absolute. This property file takes precedence over the property file that OPatch supplies.

Query Command for Standalone OPatch

This command queries a specific patch for specific details. It provides information about the patch and the system being patched.

Syntax

Use the following syntax for this command:

opatch query  [-all] [-jre <LOC> ] [-oh <LOC> ]              [-get_component] [-get_os] [-get_date]              [-get_base_bug] [-is_portal_patch]              [-is_rolling_patch] [-is_online_patch]              [-has_sql] [ <Patch Location> ]

Options

Table 7-11 lists the options available for the Query command.

Table 7-11 Query Options

Option
Description

all

Retrieves all information about a patch. This is equivalent to setting all available options.

get_base_bug

Retrieves bugs fixed by the patch.

get_component

Retrieves components the patch affects.

get_date

Retrieves the patch creation date and time.

has_sql

Indicates true if the patch has SQL-related actions. Otherwise, the option is false. For information on SQL and PL/SQL patching, see "Schema Patching".

is_online_patch

Indicates true if the patch is an online patch. Otherwise, the option is false.

is_portal_patch

Indicates true if the patch has portal actions. Otherwise, the option is false.

is_rolling_patch

Indicates true if the patch is a rolling patch. Otherwise, the option is false.

oh

Specifies the Oracle home directory to use instead of the default directory. This takes precedence over the ORACLE_HOME environment variable.

Patch Location

Indicates the path to the patch location. If you do not specify the location, OPatch assumes the current directory is the patch location.

Rollback Command for Standalone OPatch

The Rollback command removes an existing one-off patch from the appropriate Oracle home directory indicated by the reference ID.

Syntax

Use the following syntax for this command:

opatch rollback -id <ID> [-ph <Patch Location>]
              [-jre <LOC> ] [-oh <ORACLE_HOME>]
              [-silent]  [-verbose] [-no_relink]
              [-pre <parameters for the pre
              script in escaped double quotes> [-opatch_pre_end] ]
              [-post <parameters for the post script in escaped
              double quotes>[ -opatch_post_end] ] [-no_sysmod]
              [-property_file <path to property file>]
              [-init <parameters for the init script in escaped double
              quotes> [-opatch_init_end] ] [-report]

Options

Table 7-12 lists the options available for the Rollback command.

Table 7-12 Rollback Options for Standalone Patches

Option
Description

id

Indicates the patch to be rolled back. Use the lsinventory option to display all patch identifiers. Each one-off patch is indicated by its ID. To successfully roll back a patch, you must provide the patch identifier.

init

Passes parameters to the init script, which executes before prerequisite checks are run. The values for this option must be enclosed in double-quotes.

jre

Specifies the location of a particular JRE (Java) for OPatch to use instead of the default location under the Oracle home directory.

no_sysmod

Specifies that OPatch need not update the files in the system, only the inventory. It also does not execute the pre and post scripts.

no_relink

This option does not perform any make operation in the patch. You can use this option during multiple patch removals and to perform the compilation step only once.

oh

Specifies the Oracle home directory to use instead of the default directory. This takes precedence over the ORACLE_HOME environment variable.

opatch_init_end

Marks the end of the init options. Use this option with the init option. If you do not use this option, everything after init until the end of the command is passed into init.

opatch_post_end

Marks the end of the post options. Use this option with the post option. If you do not use this option, everything after post until the end of the command is passed into post.

opatch_pre_end

Marks the end of the pre options. Use this option with the pre option. If you do not use this option, everything after pre until the end of the command is passed into pre.

Patch Location

Indicates the path to the patch location. If you do not specify the location, OPatch assumes the current directory is the patch location.

ph

Specifies the valid patch directory area. Rollback uses the command types found in the patch directory to identify which commands are used for the current operating system.

post

Specifies the parameters to be passed inside the post script. This script executes after the patch is removed. You must enclose the value of this option in double-quotes.

pre

Specifies the parameters to be passed inside the pre script. This script executes before the patch is removed. You must enclose the value of this option in double-quotes.

property_file

Specifies the user-defined property file for OPatch to use. The path to the property file should be absolute. This property file takes precedence over the one that OPatch supplies.

report

Prints the actions to the screen without executing them.

silent

Suppresses user interaction, and defaults any yes|no questions to "yes". A Real Application Clusters setup does not support this option.

verbose

Prints additional OPatch output to the screen as well as to the log file.

Version Command for Standalone OPatch

This command shows the current version number of the OPatch utility. Use the following syntax for this command:

<Path_to_OPatch>/opatch version

Use Cases

The following sections provide scenarios that administrators can encounter when implementing standalone patching for the following types of operations:

Inventory

Patching

Utility

Inventory Operations

The following tables explain the purpose of the use case along with preconditions and the process that occurs during the patching process.

Table 7-13 Getting Patch Information

Use Case Category
Description

Purpose

Show a list of interim patches installed on a standalone Oracle home.

Preconditions

$ORACLE_HOME is set and the Oracle home has been patched using the standalone OPatch.

User Input

Enter the following command:

opatch lsinventory

OPatch Response

OPatch detects that this is a standalone Oracle home.

OPatch looks for the standalone inventory file.

OPatch prints out a list of installed interim patches.

Table 7-14 Getting Detailed Patch Information

Use Case Category
Description

Purpose

Show a detailed list of interim patches installed on a standalone Oracle home.

Preconditions

$ORACLE_HOME is set and the Oracle home has been patched using the standalone OPatch.

User Input

Enter the following command:

opatch lsinventory -detail

OPatch Response

OPatch detects that this is a standalone Oracle home.

OPatch looks for the standalone inventory file.

OPatch prints out a list of installed interim patches as well as files affected by each interim patch.

Patching Operations

The following tables explain the purpose of the use case along with preconditions and the process that occurs during the patching process.

Table 7-15 Applying an Interim Patch - Case 1

Use Case Category
Description

Purpose

Apply an interim patch on a standalone Oracle home.

Preconditions

$ORACLE_HOME is set and the Oracle home has been patched using the standalone OPatch. The patch has been downloaded.

User Input

Enter the following command:

opatch apply/patch_loc/123451

OPatch Response

OPatch detects that this is a standalone Oracle home.

OPatch looks for the standalone inventory file and checks for conflicts.

OPatch performs an automatic rollback if there are conflicting patches.

OPatch applies a new patch to the home.

OPatch updates its standalone inventory.

Table 7-16 Applying an Interim Patch - Case 2

Use Case Category
Description

Purpose

Apply an interim patch on a standalone Oracle home that exists within another OUI-based Oracle home.

Preconditions

$ORACLE_HOME is set and the Oracle home has been patched using a new OPatch. The patch has been downloaded.

The standalone Oracle home has a different directory patch than the OUI-based Oracle home. For example, the OUI-based Oracle home path is /path, whereas the standalone Oracle home is /path/dev.

User Input

Enter the following command:

opatch apply/patch_loc/123451

OPatch Response

OPatch detects that this is a standalone Oracle home.

OPatch looks for the standalone inventory file and checks for conflicts.

OPatch performs an automatic rollback if there are conflicting patches.

OPatch applies a new patch to the home.

OPatch updates its standalone inventory.

Table 7-17 Applying an Interim Patch - Case 3

Use Case Category
Description

Purpose

Apply an interim patch on a standalone Oracle. It seems to be a standalone Oracle home, but OPatch detects it as OUI-based.

Preconditions

$ORACLE_HOME is set and the Oracle home has been patched using a new OPatch. The patch has been downloaded.

User Input

Enter the following command:

opatch apply/patch_loc/123451

OPatch Response

OPatch detects ORACLE_HOME/oui and believes it is an OUI-based Oracle home.

OPatch attempts to apply the patch as OUI-based Oracle home patching (if the patch is compatible with the home).

Table 7-18 Rolling Back an Applied Interim Patch

Use Case Category
Description

Purpose

Roll back an interim patch applied earlier on a standalone Oracle home.

Preconditions

$ORACLE_HOME is set and the Oracle home has been patched using a standalone OPatch.

User Input

Enter the following command:

opatch rollback -id 123451

OPatch Response

OPatch detects this is a standalone Oracle home.

OPatch examines the standalone inventory file to determine if patch 123451 was applied.

OPatch rolls back patch 123451.

OPatch updates its standalone directory.

Utility Operations

The following tables explain the purpose of the use case along with preconditions and the process that occurs during the patching process.

Table 7-19 Loading an Arbitrary XML File

Use Case Category
Description

Purpose

Load an XML file, making sure it is XML-parsable.

Preconditions

$ORACLE_HOME is set.

User Input

Enter the following command:

opatch util loadXML

Note that the loadXML utility is often used as a debugging and troubleshooting tool.

OPatch Response

OPatch detects this is a standalone Oracle home.

OPatch prompts for the complete path to the XML file that you want to load.

OPatch opens the file and uses the XML parser to parse it.

OPatch reports that the file is XML-parsable.

Table 7-20 Verifying that the Patch is Applied

Use Case Category
Description

Purpose

Ensure that the patch was applied to the Oracle home.

Preconditions

$ORACLE_HOME is set, and the Oracle home has been patched using the standalone OPatch.

User Input

Enter the following command:

opatch util verify -ph/patch_loc/123451

Note that patch verification is automatically invoked when OPatch applies a patch to an Oracle home. You do not need to rerun verify after applying a patch.

OPatch Response

OPatch detects this is a standalone Oracle home.

OPatch examines /patch_loc/123451 to make sure it is a valid patch area.

OPatch examines the files in /patch_loc/123451 to make sure the Oracle home was patched with the same bits.

OPatch reports that both the patch inventory and patch binary are in the Oracle home.

Schema Patching

There are two types of schema patches:

SQL patch — This patches the Oracle database with updated procedures and schema changes.

PL/SQL patch — This also patches the Oracle database with updated procedures and schema changes, as for the SQL patch. However, a PL/SQL patch also mentions the procedure names in its patch metadata so that these procedures can be backed up for rollback.

The following sections discuss the following topics:

Schema patching options

Standalone SQL execution

Schema Patching Options

Table 7-21 shows the schema patching options that OPatch supports for Apply and Rollback:

Table 7-21 Schema Patching Options

Option
Description

-runSql

Instructs OPatch to read the SQL script from the patch and run it on the specified SIDs. You must specify this option for the patchmd.xml SQL script specification and custom SQL script.

-sqlScript

Specifies OPatch to run this custom SQL script. This is an optional parameter.

-connectString

Provides a list of database instance SIDs, user, and password to be patched. Each entry is separated by a comma ( , ). The value for this option has the following format:

SID1:USER1:PASSWORD1:NODE1, SID2:USER2:PASSWORD2:NODE2

Standalone SQL Execution

OPatch provides a utility to run only the SQL scripts to patch specified database instances. Use this utility only when you cannot apply or roll back SQL procedure actions using normal Apply or Rollback sessions.

The syntax for Apply is as follows:

opatch util applySql –id <patchIDs> -connectString <SID1:USER1:PASSWORD1:NODE1>

The syntax for Rollback is as follows:

opatch util rollbackSql –ph <patchLocation> (or) –phBaseFile <filename> (or) –phBaseDir
         <dirname> -connectString <SID1:USER1:PASSWORD1:NODE1>

Online Patching

Regular patches typically contain .o (object) files and/or .a (archive) libraries, and therefore require a relink of the RDBMS binary. Online patches, however, contain .so files, which are dynamic/shared libraries, and do not require a relink of the RDBMS binary. Consequently, since a relink is not needed, you can apply or roll back online patches while the RDBMS instance is running. This simplifies administration, because no downtime is needed, and also results in a much quicker turnaround time for installing or de-installing Online Patches.

A regular RDBMS patch can require many minutes to install, since it requires instance shutdown, a relink, and instance startup. On the other hand, you can install an online patch in just a few seconds.

Online patches are only applicable for Oracle RDBMS and not any other products. Online patches are currently not supported in Windows, and only supported on the following UNIX platforms:

Linux x86 32-bit

Linux IA64

Linux PPC 64

Solaris 64-bit

Real Application Clusters Patching

A Real Application Clusters environment enables active instances to concurrently execute transactions on a shared database. Patching in a Real Application Clusters environment is slightly different compared to patching a single node.

Interim Patching using OPatch follows a similar approach as that performed by Oracle Universal Installer to detect Oracle home and nodes of a cluster. OPatch interacts with the Oracle Universal Installer inventory through the Oracle Universal Installer Java SDK. If OPatch detects a cluster, it queries the inventory through Oracle Universal Installer to find the local node name and node list. If your node list is not updated, you can update it by using the -updateNodeList flag of Oracle Universal Installer. You can bypass remote actions using the -local flag, as shown below:

$ORACLE_HOME/oui/bin/<runInstaller or setup.exe> -updateNodeList ORACLE_ HOME=<oracle home location>
"CLUSTER_NODES={node1,node2,node3}"
-noClusterEnabled

If you want to specify the local node or remote nodes of a Real Application Clusters setup to OPatch, you can use the LOCAL_NODE or REMOTE_NODES session variable and specify the node name(s), as shown below:

$ORACLE_HOME/oui/bin/<runInstaller or setup.exe> ORACLE_HOME=<oracle home location>
"REMOTE_NODES={node1,node2,node3}"  LOCAL_NODE=<nodelist
for example:node1>

If OPatch does not automatically detect Real Application Clusters or its nodes, you need to investigate the contents of the inventory and ensure that it is complete.

You can patch Real Application Clusters in three different ways:

All Node Patching

Rolling Patching

Minimum Downtime Patching

The following sections provide detailed information for these types of Real Application Clusters patching.

All Node Patching

Figure 7–1 shows a basic example of All Node Patching.

Figure 7-1 All Node Patching

Systems A, B, and C are nodes in this cluster. When you perform All Node Patching in this cluster, you bring down systems A, B, and C, apply patches to all these nodes, then bring systems A, B, and C back up again.

Rolling Patching

In Rolling Patching, you shut down each node, apply the patch, then bring up each node again. You do this separately for each node until you patch all nodes in the cluster. This is the most efficient method of applying an interim patch to a Real Application Clusters setup, because there is absolutely no downtime during the application of patches, as only one system is brought down at any given time. Only some patches can be applied in this mode. The type is generally specified in the patch metadata.

Figure 7–2 shows a basic example of Rolling Patching.

Figure 7-2 Rolling Patching

When you perform Rolling Patching in this cluster, the patches are applied in a rolling fashion. You initially bring down system A, apply a patch to it, then bring it back up. You do the same thing for systems B and C.

Minimum Downtime Patching

In Minimum Downtime Patching, the nodes are divided into sets. Initially, you shut down the first set and apply a patch to it. After this, you shut down the second set. You then bring up the first set and apply a patch to the second set. You now bring up the second set. All the nodes in the cluster are now patched. This method leads to less downtime for the Real Application Clusters when both sets are brought down. This mode is executed by using -minimize_downtime command line option. You can also activate this option from the response file.

Figure 7–3 shows a basic example of Minimum Downtime Patching.

Figure 7-3 Minimum Downtime Patching

Systems A, B, and C are nodes in this cluster. It is divided into two sets: Set 1 contains systems A and B, and Set 2 contains system C. When you perform Minimum Downtime Patching in this cluster, you shut down Set 1 and apply a patch to it. You now shut down Set 2. Then, you bring up Set 1 and apply a patch to Set 2. After you apply the patch, you bring up Set 2 again. Now both Sets 1 and 2 are patched.

About Patch Conflicts

All patches may not be compatible with one another. For example, if you apply a patch, all the bugs the patch fixes could reappear after you apply another patch. This is called a conflict situation. OPatch detects such situations and raises an error when it detects a conflict.

Types of Conflicts

OPatch can detect the following types of conflicts.

Superset

If all the bugs fixed by a patch in the system are also fixed by the patch to be applied, this patch (the patch to be applied) is considered a superset of the patch already applied. If a bug superset condition is detected, it is not considered an error situation. All the subset patches are removed from the system and the new patch is applied.

Example

Consider the following scenario:

Patch A, installed in the Oracle home, fixed bugs 1, 2, and 3.

Patch B, installed in the Oracle home, fixed bugs 10, 11, and 12.

Patch C, to be installed, fixes bugs 1, 2, 3, and 4.

Patch C is considered a superset of Patch A.

Using the -no bug superset Flag

If you want OPatch to error out if the current patch bugs-to-fix is a superset or the same as an installed patch bugs-fixed in the Oracle home directory, you can use the -no_bug_superset flag:

$ OPatch/opatch apply -no_bug_superset <Path_To_Patch>

The following example output shows the message you would see when you use the -no_bug_superset flag:

Oracle interim Patch Installer version 11.2.0.0.0
Copyright (c) 2008, Oracle Corporation.  All rights reserved..
Oracle Home       : /home/oracle_TEST/product/11.1.0/db_1
Central Inventory : /home/OUIHome_Opatch
from           : /home/oracle_TEST/product/11.1.0/db_1/oraInst.loc
OPatch version    : 11.1.0.6.5
OUI version       : 11.1.0.6.5
OUI location      : /home/oracle_TEST/product/11.1.0/db_1/oui
Log file location : /home/oracle_TEST/product/11.1.0/db
_1/cfgtoollogs/opatch/opatch-2008_May_25_14-03-33-IST_Wed.log
ApplySession applying interim patch '111000' to OH '/home/oracle
_TEST/product/11.1.0/db_1'
Apply Session failed: ApplySession failed to prepare the system. Interim patch
 111000 is a superset of the patch(es) [ 111000 ] in OH /home/oracle
_TEST/product/11.1.0/db_1
System intact, OPatch will not attempt to restore the system
OPatch failed with error code 73

Subset

Patches to be applied can be subsets of other patches installed in the Oracle home.

Example

Consider the following scenario:

Patch A, installed in the Oracle home, fixed bugs 1, 2, and 3.

Patch B, installed in the Oracle home, fixed bugs 10, 11, and 12.

Patch D, to be installed, fixes bugs 1 and 2.

Patch D is a subset of Patch A.

Using the skip_subset Option

When you want to skip patches formerly applied in the Oracle home that are now subsets of other patches you want to apply now, you can use the skip_subset option of napply. For example, if you used napply yesterday for patch A that fixed bugs 1 and 2, then you use napply today with the skip_subset option for patch B that fixes bug 1 and patch C that fixes bugs 1, 2, and 3, then subset patch A is skipped, and patch C then becomes a superset of patch A.

Example 7-1 applies all patches under the <patch_location> directory. OPatch skips duplicate patches and subset patches (patches under <patch_location> that are subsets of patches installed in the Oracle home).

Example 7-1

opatch napply <patch_location> -skip_subset -skip_duplicate

Example 7-2 applies patches 1, 2, and 3 that are under the <patch_location> directory. OPatch skips duplicate patches and subset patches (patches under <patch_location> that are subsets of patches installed in the Oracle home).

Example 7-2

opatch napply <patch_location> -id 1,2,3 -skip_subset -skip_duplicate

See the description for the skip_subset option in Table 7-3 for more information.

Duplicate

A duplicate patch fixes the same set of bugs fixed by another patch. For example, if you applied Patch A that fixed bugs 1, 2 and 3, and now apply Patch B that also fixes bugs 1, 2 and 3, then Patch B is a duplicate of Patch A. A patch is always a duplicate of itself.

Using the skip_duplicate Option

If you specify this option, OPatch removes duplicate patches from the list of patches to be applied. For example, if you used napply yesterday for Patch A discussed above, then use napply today with the -skip_duplicate option for Patch A and other patches, duplicate Patch A is skipped.

Bug Conflict

A bug conflict occurs if a set of bugs to be fixed by the current interim patch intersects with some bugs already fixed by one or more previously installed interim patches. You must remove the bug conflict before you proceed with the patching by using the apply command with the -force flag, which rolls back the conflicting patches before applying the new one.

Example

Consider the following scenario:

Patch A, installed in the Oracle home, fixed bugs 1, 2, and 3.

Patch B, installed in the Oracle home, fixed bugs 10, 11, and 12.

Patch E, to be installed, fixes bugs 3 and 4.

Patch E conflicts with Patch A.

File Conflict

A file conflict occurs if a set of files to be patched by the current interim patch includes files already patched by one or more previously installed interim patches, and it is not a bug superset.

Example

Consider the following scenario:

Patch A, installed in the Oracle home, fixed bugs 1, 2, and 3, which modified files a, b, and c.

Patch F, to be installed, fixes bugs 1, 2, 3 and 4, and modifies files a, d, and f.

Patch F conflicts with Patch A.

Patch Conflict Behavior for Apply and Napply

The expected behavior for the Apply and Napply commands is listed in Table 7-22.

Table 7-22 Expected Behavior for Apply and Napply Commands

Command
Superset
Subset
Duplicate
File Conflict or Bug Conflict Patch

Apply

OPatch performs an automatic rollback, then an apply.

After the merge request, OPatch performs an automatic rollback, then performs an apply.

OPatch performs an automatic rollback, then performs a reapply.

OPatch reports the conflict. After the merge request, OPatch performs an automatic rollback, then an apply.

Napply

OPatch performs an automatic rollback, then an apply.

OPatch reports the subset and skips the subset patch. It then continues and applies the other patches.

OPatch performs an automatic rollback, then a reapply.

OPatch reports the conflict, then asks you to run again without applying a bug conflict patch.

You can use the -force option to instruct OPatch to automatically roll back the conflicting patch, then apply the new patch.

Patch Conflict Detection and Resolution

OPatch detects and reports any conflicts encountered when applying an Interim patch with a previously applied patch. The patch application fails in case of conflicts. You can use the -force option of OPatch to override this failure. If you use this option, the installer first rolls back any conflicting patches and then proceeds with the installation of the desired interim patch.

You may encounter a bug conflict and might want to remove the conflicting patch. This process is known as patch rollback. During patch installation, OPatch saves copies of all the files the new patch replaced before the new versions of these files are loaded and stores them in $ORACLE_HOME/.patch_storage. These saved files are called Rollback files and are the key to making patch rollback possible. When you roll back a patch, these Rollback files are restored to the system. You should only override the default behavior by using the -force flag if you completely understand the patch Rollback process. To roll back a patch, execute the following command:

$ OPatch/opatch rollback -id <Patch_ID>

Problem Resolution

The following sections provide information and instructions on the following tasks to resolve problems:

Using logs and traces

Recovering from a failed patching session

Resolving OPatch application errors

Logging and Tracing

Logging and tracing is a common aid for debugging. OPatch maintains logs for all Apply, Rollback, and Lsinventory operations. Each time you execute OPatch, a new log file is created. The log files are located in the <ORACLE_HOME>/cfgtoollogs/opatch directory. Each log file is tagged with the timestamp of the operation. Log files are named as opatch_<date mm-dd-yyyy>_<time hh-mm-ss>.log.

For example, if a log file is created on May 17th, 2008 at 11.55 PM, it will be named as follows:

opatch_05-17-2008_23-55-00.log

Note:

You can set OPatch to debug mode by setting the environment variable OPATCH_DEBUG to TRUE.

Command Index

OPatch also maintains an index of the commands executed with OPatch and the log files associated with it in the history.txt file located in the <ORACLE_HOME>/cfgtoollogs/opatch directory. An example of the history.txt file is as follows:

Date & Time : Tue Apr 26 23:00:55 PDT 2008
Oracle Home : /private/oracle/product/11.1.0/db_1/
OPatch Ver. : 11.1.0.6.5
Current Dir : /scratch/oui/OPatch
Command     : lsinventory
Log File    :
/private/oracle/product/11.1.0/db_1/cfgtoollogs/opatch/opatch-2008_Apr_26_23-00-55-PDT_Tue.log

Levels of Logging

OPatch follows the Oracle Diagnostic Logging (ODL) guidelines. You can set the log level by using the -logLevel <level> option available. This controls the amount of logging OPatch performs, according to the ODL guidelines.

OPatch supports the following log levels:

SEVERE

WARNING

INFO

CONFIG

FINE

FINER

FINEST

Recovering from a Failed Patching Session

During patching, updates can occur in two phases:

System Update — In this phase, the files are replaced in the Oracle home.

Inventory Update — In this phase, the details of the patch applied is recorded in the inventory.

The following scenarios for single instance setups and Real Application Clusters setups explain how you can recover from a failed patching session.

Single Instance Setup

When you apply or roll back a patch, an interim inventory update exception occurs.

Cause: This occurs when the files on the system are patched, but the inventory update has failed. A corrupted inventory may cause this problem.

Action: Perform the following steps:

Ensure that the environment variable ORACLE_HOME is set properly.

Navigate to the $ORACLE_HOME/.patch_storage/<patch-id_timestamp> directory and execute the Restore command.

For UNIX:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.sh

For Windows:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.bat

On UNIX, source $ORACLE_HOME/.patch_storage/<patch-id_timestamp>/make.txt file (if available) as follows:

/bin/sh make.txt

When you apply or roll back a patch, an OiiOneoffException occurs.

Cause: This occurs when the files on the system are patched, but the inventory update has failed. This may occur because the base component of the interim patch may not be present in the inventory.

Action: OPatch tries to restore the Oracle home automatically and displays a message for the same. If OPatch does not display a message stating that it has restored the Oracle home, perform the following steps:

Ensure that the environment variable ORACLE_HOME is set properly.

Navigate to the $ORACLE_HOME/.patch_storage/<patch-id_timestamp> directory and execute the Restore command.

For UNIX:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.sh

For Windows:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.bat

On UNIX, source $ORACLE_HOME/.patch_storage/<patch-id_timestamp>/make.txt file (if available) as follows:

/bin/sh make.txt

When you apply a patch and execute opatch lsinventory, it returns nothing.

Cause: This may occur because all the patches applied before the application of the current patch are lost, or the patches might not have been updated in the inventory.

Action: Perform the following steps:

Navigate to the $ORACLE_HOME/.patch_storage/<patch-id_timestamp> directory and execute the Restore command:

For UNIX:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.sh

For Windows:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.bat

On UNIX, source $ORACLE_HOME/.patch_storage/<patch-id_timestamp>/make.txt file (if available) as follows:

/bin/sh make.txt

If the files are properly patched, but the information is not updated in the inventory, execute the following command:

$ORACLE_HOME/OPatch/opatch apply -no_sysmod <Path_To_Patch>

Ensure that the patch has been applied and recorded properly in the inventory by executing the following command:

$ORACLE_HOME/OPatch/opatch lsinventory -detail

If the files are still not patched properly, but you are able to see the patch in the lsinventory flag, you need to reapply the patch using the no_inventory flag:

$ORACLE_HOME/OPatch/opatch apply -no_inventory <Path_To_Patch>

When you apply a patch and execute opatch lsinventory, it does not return the details of the patch applied.

Cause: OPatch may not have recorded the details of this patch in the inventory.

Action: Perform the following steps:

Navigate to the $ORACLE_HOME/.patch_storage/<patch-id_timestamp> directory and execute the Restore command:

For UNIX:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.sh

For Windows:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.bat

On UNIX, source $ORACLE_HOME/.patch_storage/<patch-id_timestamp>/make.txt file (if available) as follows:

/bin/sh make.txt

If the files are properly patched, but the information is not updated in the inventory, execute the following command:

$ORACLE_HOME/OPatch/opatch apply -no_sysmod <Path_To_Patch>

Ensure that the patch has been applied and recorded properly in the inventory by executing the following command:

$ORACLE_HOME/OPatch/opatch lsinventory -detail

When you press Ctrl + C during the application or roll back of a patch and execute opatch lsinventory, it does not return the details of the patch applied or rolled back.

Cause: This may be because OPatch might have stopped the application or rollback of the patch on pressing Ctrl+c.

Action: Perform the following steps:

Ensure that the environment variable ORACLE_HOME is set properly.

Navigate to the $ORACLE_HOME/.patch_storage/<patch-id_timestamp> directory and execute the Restore command if it is available.

For UNIX:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.sh

For Windows:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.bat

On UNIX, source $ORACLE_HOME/.patch_storage/<patch-id_timestamp>/make.txt file (if available) as follows:

/bin/sh make.txt

When you apply a patch, you quit when OPatch failed to relink and prompted to continue.

Cause: This may occur because of a relink failure.

Action: Perform the following steps:

Ensure that the environment variable ORACLE_HOME is set properly.

Navigate to the $ORACLE_HOME/.patch_storage/<patch-id_timestamp> directory and execute the Restore command.

For UNIX:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.sh

For Windows:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.bat

Resolve the relink failure issue by ensuring that you are able to invoke make manually on a UNIX shell. After this, apply the patch again.

Real Application Clusters Setup

When I apply a patch on a Real Application Clusters setup and execute 'opatch lsinventory' on the local node, the patch is not listed.

Cause: This may occur if OPatch failed to update the inventory.

Action: Perform the following steps:

Ensure that the environment variable ORACLE_HOME is set properly in all the nodes of the cluster.

Navigate to the $ORACLE_HOME/.patch_storage/<patch-id_timestamp> directory of each node in the cluster and execute the Restore command as follows:

For UNIX:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.sh

For Windows:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.bat

On UNIX, source $ORACLE_HOME/.patch_storage/<patch-id_timestamp>/make.txt file (if available) in each node of the cluster as follows:

/bin/sh make.txt

Apply the patch in each node in the cluster using the local flag:

$ORACLE_HOME/OPatch/opatch apply -local <Path_To_Patch>

Note:

Ensure that all the nodes use the same OPatch version.

When I apply a patch on a Real Application Clusters setup and execute 'opatch lsinventory' on the local node, it returns nothing.

Cause: You might have lost all the patches applied earlier.

Action: Perform the following steps:

Ensure that the environment variable ORACLE_HOME is set properly in each node in the cluster.

Navigate to the $ORACLE_HOME/.patch_storage/<patch-id_timestamp> directory and execute the Restore command in each node in the cluster.

For UNIX:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.sh

For Windows:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.bat

On UNIX, source $ORACLE_HOME/.patch_storage/<patch-id_timestamp>/make.txt file (if available) in each node as follows:

/bin/sh make.txt

Apply the patch in each node using the local flag:

$ORACLE_HOME/OPatch/opatch apply -local <Path_To_Patch>

Note:

Ensure that all the nodes use the same OPatch version.

When I roll back a patch on a Real Application Clusters setup, and execute 'opatch lsinventory' on the local node, it shows that the patch was not removed.

Cause: This may occur if OPatch failed to update the inventory.

Action: Perform the following steps:

Ensure that the environment variable ORACLE_HOME is set properly in each node in the cluster.

Navigate to the $ORACLE_HOME/.patch_storage/<patch-id_timestamp> directory in each node in the cluster and execute the restore command as follows:

For UNIX:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.sh

For Windows:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.bat

On UNIX, source $ORACLE_HOME/.patch_storage/<patch-id_timestamp>/make.txt file (if available) in each node in the cluster as follows:

/bin/sh make.txt

Roll back the patch in all the nodes in the cluster using the local flag:

$ORACLE_HOME/OPatch/opatch rollback -local -id <Patch_ID>

Note:

Ensure that all the nodes use the same OPatch version.

When I roll back a patch on a Real Application Clusters setup and execute 'opatch lsinventory' on the local node, it returns nothing.

Cause: You might have lost all the patches applied earlier.

Action: Perform the following steps:

Ensure that the environment variable ORACLE_HOME is set properly in each node in the cluster.

Navigate to the $ORACLE_HOME/.patch_storage/<patch-id_timestamp> directory and execute the Restore command in each node in the cluster:

For UNIX:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.sh

For Windows:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.bat

On UNIX, source $ORACLE_HOME/.patch_storage/<patch-id_timestamp>/make.txt file (if available) as follows:

/bin/sh make.txt

Roll back the patch in the local node using the local flag:

$ORACLE_HOME/OPatch/opatch rollback -local -id <Patch_ID>

Roll back the patch on the other nodes also using the local flag.

Note:

Ensure that all the nodes use the same OPatch version.

When I apply a patch on a Real Application Clusters setup, the patching in one node is fine (both the files and the inventory are fine), but I am not sure about the other nodes.

Cause: This may occur because of a failed system or inventory update.

Action: Perform the following steps:

Copy the Oracle home from the node that is fine to the other nodes.

After copying the Oracle home, make sure that the ORACLE_HOME/inventory/ContentsXML/comps.xml file has the latest timestamp.

Note:

On Unix, use touch to change the timestamp.

Update the nodes of the cluster. For more information on updating the nodes of the cluster, see "Updating the Nodes of a Cluster".

Ensure that all the prerequisite checks pass that are listed in the section "Prerequisite Checks for OPatch".

When I apply a patch on a Real Application Clusters setup, the patching in one node is fine, but when I execute 'opatch lsinventory' on the other nodes, the patch is not listed.

Cause: This may occur because of a failed system or inventory update.

Action: Perform the following steps:

Copy the ORACLE_HOME /inventory directory from the node that is fine to the other nodes.

After copying the ORACLE_HOME /inventory directory, make sure that the ORACLE_HOME/inventory/ContentsXML/comps.xml file has the latest timestamp.

Note:

On Unix, use touch to change the timestamp.

Update the nodes of the cluster. For more information on updating the nodes of the cluster, see "Updating the Nodes of a Cluster".

Ensure that all the prerequisite checks pass that are listed in the section "Prerequisite Checks for OPatch".

When I apply or roll back a patch on a Real Application Clusters setup, I am not able to apply or roll back the patch on all nodes.

Cause: This may occur if the nodes are not properly updated.

Action: Perform any one or more of the following:

Ensure that all the nodes in the cluster are up-to-date. If they are not, update the nodes of the cluster. For more information on updating the nodes of the cluster, see "Updating the Nodes of a Cluster".

Execute the appropriate command on all nodes of the cluster as follows:

opatch apply -local [patch_location]

opatch rollback -local [patch_location]

Execute the appropriate command on the local node of the cluster as follows:

opatch apply [-local_node (node_name)] [-remote_nodes (comma separated node_names)]

opatch rollback [-local_node (node_name)] [-remote_nodes (comma separated node_names)]

Resolving OPatch Application Errors

This section provides solutions to the following errors that may occur during patch application:

Not a valid patch area

Opatch cannot find system commands like fuser, make

Unable to remove a partially-installed interim patch

Not a valid patch area

Cause: The directory that the OPatch utility is using to do the patch does not match the template for what it is checking. This can also occur when you run the utility from an invalid shiphome directory.

Action: When starting the OPatch utility, the directory needs the following:

/etc directory that has the metadata files.

/files directory that has the payload files.

/etc/config/inventory file and the actions file under the same directory.

If you did not start the OPatch utility from the patch_id directory, you can use the following command:

opatch apply /<Patch_Shiphome>

OPatch cannot find system commands like fuser, make

Cause: The OPatch utility uses fuser on UNIX systems to check for active Oracle instances. On certain hp-ux systems, only a super-user can run fuser.

Action: Perform these steps to resolve this problem:

Set /tmp in your PATH.

For more information, see "Checks for Single Instances and Real Application Clusters".

Create an empty file named fuser.

Shut down the Oracle instances.

Run the OPatch utility.

Caution:

Another way to resolve this problem is to give executable permission to other users for fuser. However, this exposes a potential security issue in the system, and is not recommended.

Unable to remove a partially-installed interim patch

Cause: Interruption in the patching process potentially causes this problem. This may occur if you press Ctrl+c during the patching process. If the error is the one that OPatch detects, it automatically resolves it.

Action: Perform the following steps:

Ensure that the environment variable ORACLE_HOME is set properly.

Navigate to the $ORACLE_HOME/.patch_storage/<patch-id_timestamp> directory and execute the Restore command as follows:

For UNIX:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.sh

For Windows:
$ORACLE_HOME/.patch_storage/<patch-id_timestamp>/restore.bat

On UNIX, source $ORACLE_HOME/.patch_storage/<patch-id_timestamp>/make.txt file (if available) as follows:

/bin/sh make.txt

8 Oracle Internationalization and Translation

The following sections describe how Oracle Universal Installer supports multiple languages and internationalization:

Installation Dialogs Language.

Product Language Selections.

Language Add-on

Installation Dialogs Language

Oracle Universal Installer runs in the language of the operating system. Oracle Universal Installer uses the language that Java detects, the system locale value, and sets that to the default language. The Oracle Universal Installer dialogs are displayed in this language if available. If specific Oracle Universal Installer dialogs are not translated in the language of the operating system, these dialogs are shown in English.

Oracle Universal Installer displays the translated GUI only if the variable NLS_ENABLED has been set to TRUE in the oraparam.ini file. If the NLS_ENABLED variable is set to FALSE, all text is shown in English.

Product Language Selections

If multiple languages are defined for the products installed, Oracle Universal Installer allows language selection for all installation types through the Languages button (shown on the Available Products page when there is more than one top-level component).

Note:

If there is only one top-level component, the Languages button is shown on the Install Types page.

If the staging area has only one top-level component with only one installation type, the button is not shown and a Language Selection dialog is displayed later in the installation. You can also control the selected languages by setting the SELECTED_LANGUAGES variable in a response file or through the command line:

setup.exe SELECTED_LANGUAGES={"fr","de"}

The language selections are for the top-level component being installed. A top-level component is the product selected on the Products Selection dialog, one per installation session. If any sub-components (not top-level) do not have files defined for the language you select, only English only is installed. The English files are always installed for all components, regardless of user selection or operating system language.

During installation, Oracle Universal Installer examines the language list of each file and file group to determine which files need to be copied.

The Oracle Universal Installer product is translated into nine languages, as shown in Table 8-1, and includes translations for all generic Oracle Universal Installer dialogs. Note that any custom dialogs and product-specific information that are part of your installations must be translated and staged independently.

Table 8-1 Oracle Universal Installer Translated Languages

Language
Abbreviation

French

fr

Brazilian Portuguese

pt_BR

German

de

Italian

it

Japanese

ja

Korean

ko

Simplified Chinese

zh_CN

Spanish

es

Traditional Chinese

zh_TW

Language Add-on

Oracle Universal Installer 11.1 supports post-installation language translation additions. To get a version of an Oracle product with a particular language up and running, you need to invoke Oracle Universal Installer in -addLangs mode.

Perform the following steps to change the language of an installation using Oracle Universal Installer:

Execute the following command:

./runInstaller -addLangs

A welcome page with a language add-on specific message appears.

Click Next. The Specify Home Details page appears.

Select the name and full path of the home containing the product to which you want to add languages and click Next. The Language Selection page appears.

Select the languages for which you want your Oracle products to be upgraded and click Next. A summary page displaying a snapshot of your preferences appears.

Review your preferences and click Install. After the languages are successfully updated, the End of Language Upgradation page appears.

Click Exit.

A Frequently Asked Questions

This appendix is organized into the following sections:

Oracle Universal Installer

OPatch

Oracle Universal Installer

This section answers the frequently asked questions for Oracle Universal Installer:

On Windows, when I run Oracle Universal Installer setup.exe, it is not invoked.

This may occur because some system resources are being held by some services. If you stop these services, Oracle Universal Installer can be invoked.

To run Oracle Universal Installer again, execute the following command:

setup -J-Dsun.java2d.noddraw=true -Dsun.awt.nopixfmt=true

When I start Oracle Universal Installer from any location, after setting the PATH environment variable, I receive an error that reads "Could not read any NLS message catalogue!". What do I do?

Oracle Universal Installer needs some files in the directory where the runInstaller (UNIX) or setup.exe (Windows) is running. So, when you invoke runInstaller (UNIX) or setup.exe (Windows), you should invoke it from the directory where this command is present, or you must specify the complete path.

I have lost my Central Inventory, but have a valid Oracle home(s). What do I do?

Oracle Universal Installer allows you to set up the Central Inventory or register an existing ORACLE_HOME with the Central Inventory in case of inventory corruption or loss. You need to execute the command with the -attachHome flag. For more information, see the section "Creating the Central Inventory".

I want to deploy multiple Oracle home(s) from an existing Oracle home. How do I do this?

Oracle Universal Installer creates Oracle homes during Oracle software installation. To deploy multiple Oracle homes using an existing one, you need to clone the Oracle home. For more information on cloning and mass deployment, see Chapter 6, "Cloning Oracle Software".

I have lost my Oracle home inventory (comps.xml). What can I do?

Oracle recommends backing up the inventory when an Oracle home is installed or removed. Ensure that you back up the comps.xml that has the latest time-stamp. For more information on backing up the inventory, see "Backing up the Inventory".

When your Oracle home inventory is corrupted or lost, you can restore from the backup or you can install the Oracle home from an identical installation.

When I run the configuration assistants, they fail. What do I do?

To recover from this problem, rename the configToolAllCommands and configToolFailedCommands files as follows:

In UNIX, rename the configToolAllCommands and configToolFailedCommands files located in the OracleHome/cfgtoollogs/ directory to configToolAllCommands.sh and configToolFailedCommands.sh respectively and execute them.

In Windows, rename the configToolAllCommands and configToolFailedCommands files located in the OracleHome/cfgtoollogs/ directory to configToolAllCommands.bat and configToolFailedCommands.bat respectively and execute them.

ConfigToolAllCommands(.sh/.bat) is used when the installation was done with a -noConfig option and you want to run all the configuration assistants in standalone mode, outside the OUI context.

ConfigToolFailedCommands(.sh/.bat) is used when the install was done with failed configuration assistants and you want to run only the failed configuration assistants later in standalone mode, outside the OUI context.

When I apply a patchset or an interim patch, the installer tries to propagate to a node that I disconnected a long time ago. What do I do?

This may occur because the Oracle home is present in the Central Inventory.

Oracle Universal Installer allows you to remove the Oracle home from the Central Inventory in cases where the Oracle home is uninstalled. To remove the Oracle home, you need to execute runInstaller with the -detachHome flag. You can also completely remove the Central Inventory to remove traces of log files. For more information, see the section "Detaching Oracle Homes from the Central Inventory".

When I apply a patchset or an interim patch, the patch is not propagated to some of my Real Application Clusters nodes. What do I do?

In a Real Application Clusters environment, the inventory contains a list of nodes associated with an Oracle home. It is important that during the application of a patchset or an interim patch, the inventory is correctly populated with the list of nodes. If the inventory is not correctly populated with values, the patch is propagated only to some of the nodes in the cluster.

Oracle Universal Installer allows you to update inventory.xml with the nodes available in the cluster using the -updateNodeList flag in Oracle Universal Installer. For more information, see the section "Updating the Nodes of a Cluster".

What if I just want to update the inventory without reapplying a one-off patch?

The OPatch addpatch.pl tool enables you to update the inventory with a given one-off patch without actually reapplying it to the Oracle home. Use this tool if you are certain that the patch is present in the Oracle home but not in the inventory. You can download it from MetaLink at patch number 4321390 to just add the patch to the inventory. After using this option, opatch lsinventory shows the one-off patch information along with other installed one-offs.

On two separate occasions, I experienced a corrupt inventory and a failed installation. Does OUI provide a backup facility I could use before I try to install again?

OUI provides automated backups for the Central Inventory and Oracle home Inventory. For more information, see Automated Inventory Backups in Appendix B, " Troubleshooting and Debugging Oracle Universal Installer".

OPatch

This section answers the frequently asked questions for OPatch.

When I apply a patch I receive an error that reads "Failed to load the patch object. Possible causes are: The specified path is not an interim patchshiphome. Metadata files are missing from the patch area ". What do I do?

This simply means the directory OPatch is using to find the patch doesn't match the template it is checking for. For more information on this error, see "Not a valid patch area".

When I apply a patch, I receive an error that reads "Syntax error.....Patch location not valid." What do I do?

This simply means that the patch location that you specified is invalid. Provide the correct patch location and apply the patch again.

When I apply a patch, I receive an error that reads "Exception in thread "main" java.lang.NoClassDefFoundError: <Class Name>". What do I do?

This may occur because OPatch cannot find the particular class listed in the error, which is supposed to be located inside the $ORACLE_HOME/OPatch/jlib/opatch.jar file. Check if you have the particular class file there. To check this, execute the following command; the missing class file will be printed out:

cd $ORACLE_HOME/OPatch/jlib
jar tf opatch.jar <Class File Name>.class

It is recommended that you contact Oracle support when you encounter this error.

Another reason might be having done a file transfer of OPatch in non-binary mode.

When I apply a patch, I receive an error that reads "OPatch cannot find the required command 'ar' from Property file and your PATH". What do I do?

'ar' is a command OPatch uses. This message may appear if OPatch cannot locate this command.

For more details and a workaround for this problem, see "OPatch cannot find system commands like fuser, make".

When I apply a patch, I receive an error that reads "OPatch cannot find the required command 'fuser' from Property file and your PATH". What do I do?

'fuser' is a command OPatch uses. This message may appear if OPatch cannot locate this command.

For more details and a workaround for this problem, see "OPatch cannot find system commands like fuser, make".

How do I receive the information about a patch that I applied a long time ago?

You can look at the folder $ORACLE_HOME/.patch_storage/<patch-id_timestamp>. It has detailed information about the patch. You can also use opatch lsinventory -detail to see the files that the patch has modified.

Where do I get the OPatch 11.1 log files?

You can look at the folder $ORACLE_HOME/cfgtoollogs/opatch for OPatch 11.1 log files.

How do I find out a list of Oracle home(s) for a host?

To find out the list of Oracle home(s) in a host, use the command lsinventory -all.

How can I minimize the downtime when applying a patch to a Real Application Clusters setup?

You can minimize the downtime when applying a patch to a Real Application Clusters setup by doing Minimum Downtime Patching. For more information, see "Minimum Downtime Patching".

Can I stop applying a patch after applying it to a few nodes? What are the possible issues?

Yes, it is possible to stop applying a patch after applying it to a few nodes. However, Oracle recommends that you do not do this. There is a prompt that allows you to stop applying the patch. This means you cannot apply another patch until the process is restarted and all the nodes are patched or the partially applied patch is rolled back.

Can I run patching in scripted mode?

Yes, it is possible by using the command opatch <option> -silent. For more information, see "OPatch Utility for OUI-based Oracle Homes".

Before applying a patch, I want to know the impact of the patch.

You can use the command opatch <option> -report. For more information, see "OPatch Utility for OUI-based Oracle Homes".

What versions of OPatch can I use with Oracle Universal Installer 11.1?

Oracle recommends using OPatch version 11.1 from the Oracle home with Oracle Universal Installer 11.1. Also note that OPatch is compatible only with the version of Oracle Universal Installer that is installed in the Oracle home.

Is Opatch 11.1 backward compatible? Can I use OPatch 11.1 to apply 9.2, 10.1, and 10.2 patches?

No, OPatch 11.1 is not backward compatible. You can use Opatch 11.1 only to apply 11.1 patches.

When I apply a patch, I receive an error that reads as follows:

"OPatchSession cannot load inventory for the given Oracle home <Home_Location>. Possible causes are:No read or write permission to ORACLE_HOME/.patch_storageCentral Inventory is locked by another OUI instanceNo read permission to Central InventoryThe lock file exists in ORACLE_HOME/.patch_storageThe Oracle home does not exist in Central Inventory"

What do I do?

This error may occur because of any one or more of the following reasons:

The ORACLE_HOME/.patch_storage may not have read/write permissions. Ensure that you provide read/write permissions for this folder and apply the patch again.

Another Oracle Universal Installer instance may be running. Stop the instance and try applying the patch again.

The Central Inventory may not have read permission. Ensure that you provide read permission to the Central Inventory and then apply the patch again.

The ORACLE_HOME/.patch_storage directory might be locked. If this directory is locked, you will find a file named patch_locked inside this directory. This may occur because of a previously failed patch installation. To remove the lock, restore the Oracle home and remove the patch_locked file from the ORACLE_HOME/.patch_storage directory.

The Oracle home may not be present in the Central Inventory. This may occur because of a corrupted or lost inventory, or the inventory may not be registered in the Central Inventory. For more information, see "Diagnosing and Recovering from Central Inventory Corruption".

I am trying to install a patch on Windows, but OPatch is not reading the complete patch location. The patch location is c:\My Patches\300100.

OPatch does not support paths with spaces. The solution is to move the patch to a path that does not have spaces and then provide that location to OPatch. OPatch does not work if there are spaces in paths of the Oracle home, the patch location, and JRE/JDK locations.

What if I want to just update the inventory without reapplying a one-off patch?

The OPatch addpatch.pl tool enables you to update the inventory with a given one-off patch without actually reapplying it to the Oracle home. Use this tool if you are certain that the patch is present in the Oracle home, but not in the inventory. You can download it from MetaLink at patch number 4321390 to just add the patch to the inventory. After using this option, opatch lsinventory shows the one-off patch information along with other installed one-offs.

B Troubleshooting and Debugging Oracle Universal Installer

This appendix is organized into the following troubleshooting sections:

Debugging Mechanisms in Oracle Universal Installer

Oracle Universal Installer Errors

Other Tips

Debugging Mechanisms in Oracle Universal Installer

Oracle provides the following types of debugging mechanisms:

Installation Log

Automated Inventory Backups

The following sections discuss each of these mechanisms.

Installation Log

During the installation, Oracle Universal Installer writes a text file that contains information on:

Variable settings

Action calls

Queries

Exception information

The log of installation actions is written to a file named installActions<date>.log, located in the <oraInventory>\logs directory. The oraInstall<timestamp>.err and oraInstall<timestamp>.out files are also created and stored in the same logs directory. The .log, .err, and .out files for a particular session will be named with the same timestamp.

The installation log is used for debugging purposes only. All actions, queries, everything that happens during the installation, and all modifications to the target host are logged in the file.

A sample file is shown below:

installActions2002-08-16_09-52-16-AM.log
Environment variables:
        ORACLE_HOME =
        PATH = E:\OEM\bin;E:\ORACLE815\bin;C:\Program
 Files\Oracle\jre\1.1.7\bin;C:\ORATST\BIN
        CLASSPATH = C:\Program Files\Exceed.nt\hcljrcsv.zip;
Username is: jdoe

The installer version is 2.2.1.0.0

*** Welcome Page***
Setting value of FROM_LOCATION to E:\bootstrap\cd\Disk1\stage\products.jar
Setting value of INVENTORY_LOCATION to C:\Program Files\Oracle\Inventory
Setting value of UNIX_GROUP_NAME to
Setting value of FROM_LOCATION to E:\bootstrap\cd\Disk1\stage\products.jar
Setting value of ORACLE_HOME to E:\Universal
Setting value of ORACLE_HOME_NAME to Universal

*** File Locations Page***
FromLocation = FROM_LOCATION = E:\bootstrap\cd\Disk1\stage\products.jar
ToLocation = ORACLE_HOME = E:\Universal
ToName = ORACLE_HOME_NAME = Universal
Initializing installer access setup
Setting value of ORACLE_HOME to E:\Universal
Setting value of ORACLE_HOME_KEY to Software\ORACLE\HOME3
Setting value of ORACLE_HOME_FOLDER to Oracle - Universal
Setting value of ORACLE_HOME_SERVICE to Universal
Setting value of ToplevelComp to oracle.swd, 2.2.1.0.0, >0.0, [ 912 453 615 50 601
173 467 295 87 610 198 918 913 162 2 30 21 10021 111 90 168 888 ][OH:0]
Setting value of SELECTED_LANGUAGES to [en]
Doing operation for installer access setup
Initializing inventory setup WCCE
Doing operation in inventory setup WCCE

*** Available Products Page***
TopLevelComp = ToplevelComp = oracle.swd, 2.2.1.0.0, >0.0, [ 912 453 615 50 601
173 467 295 87 610 198 918 913 162 2 30 21 10021 111 90 168 888 ][OH:0]
LangsSel = SELECTED_LANGUAGES = [en]
Setting value of ToplevelComp to oracle.swd, 2.2.1.0.0, >0.0, [ 912 453 615 50 601
173 467 295 87 610 198 918 913 162 2 30 21 10021 111 90 168 888 ][OH:0]
Setting value of DepMode to Complete
Setting value of TLDepModes to Complete,

*** Installation Types Page***
DepMode = DepMode = Complete
TLDepModes = TLDepModes = Complete,
Setting value of DepMode to Complete
Setting value of PROD_HOME to E:\Universal\oracle.swd
Setting value of PROD_HOME to E:\Universal\oracle.swd
Setting value of PRE_REQUISITE to true
Setting value of PROD_HOME to E:\Universal\oracle.swd
Setting value of SHOW_COMPONENT_LOCATIONS_PAGE to true

*** Component Locations Page***
ShowCompLocs = SHOW_COMPONENT_LOCATIONS_PAGE = true
Entering  component: oracle.swd installation

*** Summary Page***
ShowSummary = SHOW_SUMMARY_PAGE = null
        Global Settings
                Source : E:\bootstrap\cd\Disk1\stage\products.jar
                Destination : E:\Universal

Text files are also written in the temp directory:

<temp>\OraInstall\oraInstall<timestamp>.err
<temp>\OraInstall\oraInstall<timestamp>.out

If a problem occurs during the installation, you should look for messages with the SEVERE keyword and Java exceptions in these files.

Automated Inventory Backups

You can recover from a corrupt inventory or failed installations by using the following types of automated inventory backups:

Central Inventory Backup

Oracle Home Inventory Backup

Central Inventory Backup

The Central Inventory is automatically backed up whenever you execute the Oracle Universal Installer in any of the following modes:

- install (new home)

- deinstall (remove home)

- addNode

- attachHome

- detachHome

- updateNodeList

The backed up directory and file are:

Central Inventory Location/ContentsXML

The backup is located here:

Central Inventory Location/backup/time stamp/

Oracle Home Inventory Backup

The Oracle Home Inventory is automatically backed up on an existing Oracle home whenever you execute the Oracle Universal Installer in either of the following modes:

- install (patchsets, upgrades, and one-offs)

- deinstall components (does not remove the Oracle home)

The backed up directories and files are:

ORACLE_HOME/inventory/ContentsXMLORACLE_HOME/inventory/ScriptsORACLE_HOME/inventory/CloneORACLE_HOME/inventory/invDetails.properties

The backup is located here:

ORACLE_HOME/inventory//backup/time stamp/

Oracle Universal Installer Errors

Refer to the release notes for information on any Oracle Universal Installer limitations for a particular version.

The most common Oracle Universal Installer errors are listed below:

Out of "temp" space

Make sure you have enough space in the default TEMP or TMP directory. Otherwise, the installation will not succeed. The amount of space required depends on the product being installed.

Note:

On UNIX and Windows, Oracle Universal Installer looks for %TEMP% then %TMP%. If neither is set, Oracle Universal Installer will default to /tmp on UNIX and c:\temp on Windows.

Incomplete stage and missing files in file groups

Make sure you have a good staging area. You may have incorrectly copied the staging area from the CD to the hard disk.

Exceptions from action libraries:

NT Services, if a service is already started

File permissions

UNCAUGHT_RUNTIME exception when you try to install the product on your machine

This is a blanket error catch that catches any run-time errors like NullPointers from libraries. Check if the temp\OraInstall\<timestamp>.err has any stack trace. You will need to call support to debug the staging area.

Other Tips

The following tips may help you to troubleshoot problems:

Make sure the correct version of the JRE is specified in the PATH.

If Java cannot run applications from a Sun machine on an NCD X terminal (Oracle Universal Installer does not start), remove the following file:

$JAVA_HOME/lib/font.properties

If you are deleting an Oracle home manually without using Oracle Universal Installer, the products remain registered with Oracle Universal Installer. You must then simulate a de-install so that all Oracle Universal Installer references are removed.

If the installation is canceled:

Products will not be registered with Oracle Universal Installer.

Some files may have been copied, depending on when you issued the cancellation.

X terminal emulators that were tested with Oracle Universal Installer are listed in the following sections.

Exceed

There is a known compatibility issue that Hummingbird has identified to be a problem with Exceed. You can fix it by going into XConfig/Screen Definition/Screen 0 and changing Window Manager from "Default to Native" to "Native." See Figure B–1 to see the proper setup.

Figure B-1 Setting Exceed's Window Manager to "Native"

Another known issue where Exceed fails to recognize fonts is documented at the following site:

http://developer.java.sun.com/developer/bugParade/bugs/4262023.html

Reflection X

Refection X 6.2+: Select Settings/Window Manager/ Default Local Window Manager/ Reflection Window Manager. You may also have to select "X terminal desktop."

Reflection X 6.0: Select Connection/New XDMCP Connection/Connection Settings/Direct method/ type host destination and click Connect.

Tarantella

There is a known problem when using Tarantella to send DISPLAY to your Windows system, for instance, when using hosted UNIX systems. The bottoms of some Oracle Universal Installer screens may appear truncated, with buttons not visible. The problem occurs only when you use an individual Tarantella terminal window so that the Oracle Universal Installer window appears alone without a broader X-windowing environment.

To work around this problem, do one of the following:

Use keyboard shortcuts to invoke these commands:

Use Alt-N for Next to move to the next screen.

On the summary page, use Alt-I to start the installation.

Use the Window Manager window in Tarantella, which displays the entire screen as if it were a UNIX monitor. Installer dialogs will appear properly in Window Manager.

C Understanding Oracle Universal Installer Commands

The Oracle Universal Installer is run with various options and command-line arguments. This appendix lists the syntax of Oracle Universal Installer and the various command-line options available in Oracle Universal Installer. The following command shows the syntax for running the Oracle Universal Installer:

./runInstaller or setup.exe <option> [-command_line_variable=value]

In the preceding command, the following variables are used:

option: The options available in Oracle Universal Installer. They are described in Table C-1, "Options in Oracle Universal Installer".

command_line_variable: The command-line variable for the option. They are described in Table C-2, "Command Line Variables in Oracle Universal Installer".

Note:

You can pass the command line variable in either of the following three ways:

<command_line_variable>={"value1","value2"}

"<command_line_variable>={value1,value2}"

<command_line_variable>="{value1,value2}"

Options Available in Oracle Universal Installer

Table C-1 lists the various options available in Oracle Universal Installer.

Table C-1 Options in Oracle Universal Installer

Option
Description

-clusterware oracle.crs,<crs version>

Version of the Oracle Clusterware installed.

-crsLocation <Path>

Specifies the path to the Oracle Clusterware home location. This flag is used only for cluster installations. Specifying this flag overrides the CRS information obtained from the Central Inventory.

-invPtrLoc <full path of oraInst.loc>

Points to a different inventory location. The orainst.loc file contains the following entries:

inventory_loc=<location of central inventory>inst_group=<>

This flag can only be passed on UNIX platforms.

-jreLoc <location>

Path where the Java Runtime Environment is installed. You need to mention this path to override the default path.

-logLevel <level>

Filters log messages that have a lesser priority level than the level specified. Valid options are: severe, warning, info, config, fine, finer, and finest.

-paramFile <location of file>

Specifies the location of the oraparam.ini file to be used by Oracle Universal Installer.

-responseFile <Path>

Specifies the location of the response file to use. This option is used with the -silent flag.

-sourceLoc <location of products.xml>

Specifies the shiphome location.

-addLangs

Adds new languages to an already installed product.

-addNode

Adds node(s) to the installation. You cannot use this flag in silent mode with response files. You can pass the required session variable through the command line. You must pass the CLUSTER_NEW_NODES, CLUSTER_NEW_PRIVATE_NODE_NAMES, and CLUSTER_NEW_VIRTUAL_HOSTNAMES session variables when using this flag.

-attachHome

Attaches homes to the Oracle Universal Installer inventory. You must pass the ORACLE_HOME and ORACLE_HOME_NAME session variables when using this flag.

-cfs

Indicates that the Oracle home specified is on a cluster file system (shared). This is mandatory when '-local' flag is specified so that Oracle Universal Installer can register the home appropriately into the inventory.

-clone

Used for cloning an Oracle home from a source location to a target location. You must pass the ORACLE_HOME and ORACLE_HOME_NAME session variables when using this flag.

-debug

Used for getting the debug information from Oracle Universal Installer.

-deinstall

Used for de-install operations. You can pass the DEINSTALL_LIST and/or REMOVE_HOMES along with ORACLE_HOME and/or ORACLE_HOME_NAME session variables when using this flag

-detachHome

Detaches homes from the Oracle Universal Installer inventory without deleting the inventory directory inside the Oracle home. You must pass the ORACLE_HOME session variable when using this flag.

-enableRollingUpgrade

Used in cluster environments to enable an upgrade of a product on a subset of nodes (on which the product was installed).

-executeSysPrereqs

Executes system prerequisite checks and exits.

-force

Allows silent mode installation on a non-empty directory without warning.

-help

Lists the syntax and help information.

-ignorePatchConflicts

Ignores all conflicts with existing interim patches during an upgrade. The conflicting interim patches are removed from the home.

-ignoreSysPrereqs

Ignores the results of the system prerequisite checks.

-local

Performs the specified operation on the local node irrespective of the cluster nodes specified.

-printdiskusage

Logs debug information for disk usage.

-printmemory

Logs debug information for memory usage.

-printtime

Logs debug information for time usage.

-record -destinationFile <Path>

Records a response file. The information is recorded in the destination file path specified.

-removeallfiles

Removes the home directory after de-installation of all the components. This is used with the -deinstall flag.

-removeAllPatches

Removes all interim patches from the home.

-silent

Used for silent mode operations. The input can be a response file or a list of command line variable value pairs. You can use the -responsefile flag along with this flag.

-updateNodeList

Updates the node list for this home in the Oracle Universal Installer inventory. You can pass the ORACLE_HOME, LOCAL_NODE, and CLUSTER_NODES session variable when using this flag

-waitforcompletion

Used on a Windows platform. The command console will wait for Oracle Universal Installer to exit if you specify this flag.

-nobackground

Specifies to Oracle Universal Installer not to show background images.

-noclusterEnabled

Indicates that no cluster nodes are specified.

-noconsole

Suppresses the display of messages to the console.

-nowarningonremovefiles

Disables the warning message before removal of the home directory. This is used with the -deinstall flag.

-nowait

Used on a Windows platform. Specifies not to wait for the user to press Enter on the console after the task (installation, etc.) is complete.

-formCluster

Installs the Oracle Clusterware in order to form the cluster.

-remotecp <Path>

This flag can only be passed on UNIX platforms. This is used only for cluster installs. This flag specifies the path to the remote copy program on the local cluster node. For example, the path for scp is /usr/bin/scp.

-remoteshell <Path>

This flag can only be passed on UNIX platforms. This is used only for cluster installs. This specifies the path to the remote shell program on the local cluster node. For example, the path for ssh is /usr/bin/ssh.

Command-line Variables Available in Oracle Universal Installer

Table C-2 lists the command-line variables available in Oracle Universal Installer:

Table C-2 Command Line Variables in Oracle Universal Installer

Command Line Variable
Description

INVENTORY_LOCATION

Specifies the inventory location.

ORACLE_HOME

Specifies the ORACLE_HOME location.

ORACLE_HOME_NAME

Specifies the ORACLE_HOME name in the target machine.

ORACLE_HOME_KEY

Specifies the ORACLE HOME key name. This is used only on Windows platform.

ORACLE_HOME_FOLDER

Specifies the ORACLE HOME folder name. This is used only on Windows platform.

ORACLE_HOME_SERVICE

Specifies the ORACLE HOME service name. This is used only on Windows platform.

ANONYMOUS_LOGIN

Specifies an anonymous login.

LOGIN_NAME

Specifies the login name.

PASSWORD

Specifies the password.

LOGIN_CATEGORY

Specifies the login category.

UNIX_GROUP_NAME

Specifies the group name on a UNIX platform.

FROM_LOCATION

Specifies the location from where the component gets installed. This is the complete path to the products.xml file.

FROM_LOCATION_CD_LABEL

Specifies the label of the CD where the products.xml file resides in a multi-CD installation. The label can be found in the file disk label in the directory where the products.xml resides.

COMPONENT_LANGUAGES

Specifies the languages in which the components will be installed.

SELECTED_LANGUAGES

Specifies the selected languages.

SELECTED_PLATFORMS

Specifies the selected platforms.

TOPLEVEL_COMPONENT

Specifies the top level component to be installed in the current session.

ToplevelComp

Specifies the top level component id.

INSTALL_TYPE

Specifies the installation type of the components.

SHOW_SPLASH_SCREEN

Specifies whether the splash screen will be displayed in the current session. Set to true if the splash screen needs to be displayed.

SHOW_WELCOME_PAGE

Specifies whether the welcome screen will be displayed in the current session. Set to true if the Welcome page in the Oracle Universal Installer needs to be displayed.

SHOW_ROOTSH_CONFIRMATION

Set to true if the confirmation dialogue asking to run the root.sh script in the Oracle Universal Installer needs to be shown. This flag can only be passed on UNIX platforms.

SHOW_EXIT_CONFIRMATION

Specifies whether to display the confirmation dialogue for exiting the Oracle Universal Installer. Set to true for exit.

SHOW_CUSTOM_TREE_PAGE

Specifies if the custom tree page in the Oracle Universal Installer needs to be shown. Use this page to select/de-select dependencies. This page appears only in the custom installation type.

SHOW_COMPONENT_LOCATIONS_PAGE

Specifies if the components location page in the Oracle Universal Installer needs to be shown. This page appears if there are products whose installed directory can be changed. Set the value to false to prevent users from specifying an alternate directory.

SHOW_NODE_SELECTION_PAGE

Specifies if the node selection page should be shown.

SHOW_SUMMARY_PAGE

Specifies if the summary page in the Oracle Universal Installer needs to be shown. The summary page shows the list of components that need to be installed in this session.

SHOW_INSTALL_PROGRESS_PAGE

Specifies if the installation progress page in the Oracle Universal Installer needs to be shown. This page shows the current status in the installation.

SHOW_REQUIRED_CONFIG_TOOL_PAGE

Specifies if the required config assistants page in Oracle Universal Installer needs to be shown. This page shows the list of required configuration assistants that are part of this installation. It shows the status of each assistant, including any failures with detailed information on why it failed.

SHOW_CONFIG_TOOL_PAGE

Specifies if the config assistants page in Oracle Universal Installer needs to be shown. This page shows the list of configuration assistants that are part of this installation and are configured to launch automatically. It shows the status of each assistant, including any failures with detailed information on why it failed.

SHOW_RELEASE_NOTES

Specifies if the release notes of this installation need to be shown at the end of the installation. This dialog can be launched from the End of Installation page and shows the list of release notes available for the products just installed. This also requires the variable SHOW_END_SESSION_PAGE variable to be set to true.

SHOW_END_OF_INSTALL_MSGS

Specifies if the text on the end of the installation screen is to be shown. The text is always available under <Oracle_Home>/install/readme.txt.

SHOW_END_SESSION_PAGE

Specifies if the end of session page in Oracle Universal Installer needs to be shown. This page shows if the installation is successful or not.

SHOW_XML_PREREQ_PAGE

Specifies whether or not to show the prereq page.

NEXT_SESSION

Specifies if you want users to go back to the File Locations page for another installation. This flag also needs to be set to true in order to process another response file (see NEXT_SESSION_RESPONSE). This argument is used for chain installs.

NEXT_SESSION_ON_FAIL

Specifies the next session response. Set to true to allow users to invoke another session even if the current installation session has failed. This flag is only relevant if NEXT_SESSION is set to true. This argument is used for chain installs.

NEXT_SESSION_RESPONSE

Specifies the full path of the next session's response file. If only a file name is specified, the response file is retrieved from the <TEMP>/oraInstall directory. This variable is active only if NEXT_SESSION is set to true. This argument is used for chain installs.

LOCATION_FOR_DISK

Name used to specify the complete path to the other disks.

DEINSTALL_LIST

Specifies the list of components to be removed during a de-install session. This argument is used with the -deinstall flag.

SHOW_DEINSTALL_CONFIRMATION

Specifies the de-install confirmation. Set to true if de-install confirmation is needed during a de-install session. This argument is used with the -deinstall flag.

SHOW_DEINSTALL_PROGRESS

Specifies the de-install progress. Set to true if de-install progress is needed during a de-install session. This argument is used with the -deinstall flag.

REMOVE_HOMES

Specifies the list of the homes to be removed during a de-install session. Each home is represented by its full path. This argument is used with the -deinstall flag.

CLUSTER_NODES

Specifies the cluster node names selected by the user for installation.

CLUSTER_NEW_NODES

Specifies the new cluster nodes to be used for node addition.

REMOTE_NODES

Specifies the remote nodes.

REMOTE_CLEAN_MACHINES

Specifies the remote nodes which do not have an installation inventory set up.

LOCAL_NODE

Specifies the local node.

EXISTING_REMOTE_NODES

Specifies the remote nodes on which the current home is already installed.

CRS

Specifies whether the Oracle home is an Oracle Clusterware home or not.

CLUSTER_NEW_PRIVATE_NODE_NAMES

Specifies the private node names for the new nodes that are used for node addition.

CLUSTER_NEW_HOST_NAMES

Specifies the host names for the new cluster nodes.

CLUSTER_NEW_NODE_NUMBERS

Specifies the node numbers of the new cluster nodes

CLUSTER_NEW_VIRTUAL_HOSTNAMES

Specifies the virtual host names for the new cluster nodes.

ACCEPT_LICENSE_AGREEMENT

Specifies the license agreement status. By setting this variable to true, you are accepting the license agreement.

REGISTRATION_KEYWORD

Specifies the registration keyword value. This can be obtained from the URL specified in the Product Registration Page.

RESTART_SYSTEM

Specifies whether to restart the system or not. Set to true to allow automatic restart of the system. If set to false, the installer exits without restarting. No exit confirmation dialog is shown.

RESTART_REMOTE_SYSTEM

Specifies whether to restart the remote system or not. Set to true to allow automatic restarting of the remote system. If set to false, the installer does not restart remote systems. No exit confirmation dialog is shown.

SESSION_MODE

This session variable holds the current Oracle Universal Installer execution mode; that is, "Install" for an install and/or de-install session, or "Clone" for a cloning (home fix-up) session.

LOG_LOCATION

Specifies the log file location. This variable specifies the directory that contains the log files generated during installation. This directory is located within the Oracle home.

IGNORE_PREREQ

Specifies whether to skip the prerequisite checks or not. Set to true to continue component installation even when the prerequisite check fails.

ORACLE_HOSTNAME

Specifies the host name of the system.

PREREQ_CONFIG_LOCATION

Specifies the location where prerequisite configuration files are available.

PREREQ_LOG_LOCATION

Specifies the prereqs log location where prerequisite results will be generated.

PREREQ_ENTRY_POINT

Specifies the log location where prerequisite results will be generated.

ROOTSH_STATUS

Specifies the root.sh status — whether root.sh is required/before config or after config. This flag is used only on UNIX platforms.

SHOW_CUSTOM_ROOTSH_MESSAGE

Specifies the custom message shown for the root_sh dialogue. This flag is used only on UNIX platforms.

ROOTSH_LOCATION

Specifies the Root.sh location. By default it is set to OH\root.sh. This flag is used only on UNIX platforms.

USE_PREREQ_CHECKER

Specifies if the prereq checker is to be used during the installation or not. The value for this variable is set based on the value in the oraparam.ini file.

USE_OLD_INSTALL_PREREQS

Specifies if old style system prereqs are to be enabled in the installation scripts. The PRE_REQUISITE code should use this variable to determine which checks can be turned on or off. The value of this variable is set based on the value in the Oraparam.ini.

SHOW_NEXT_SESSION_PROGRESS

Specifies if the progress dialog will be shown during the setup of the next session or not. This flag is used in chain installs.

NEXT_SESSION_PROGRESS_TITLE

Specifies the title of the progress dialog shown during the setup of the next session. This flag is used in chain installs.

NEXT_SESSION_PROGRESS_TEXT

Specifies the text above the progress bar in the progress dialog shown during the setup of next session. This flag is used in chain installs.

D Sample Files

This appendix provides the following sample files:

Sample Response File

Sample ORAPARAM.INI File

Sample Components File

Sample Response File

Response files are of type .rsp and are used by Oracle Universal Installer to run silent installations.

####################################################################
## Copyright(c) Oracle Corporation 2007. All rights reserved.##
##                                                                ##
## Specify values for the variables listed below to customize     ##
## your installation.                                             ##
##                                                                ##
## Each variable is associated with a comment. The comment        ##
## identifies the variable type.                                  ##
##                                                                ##
## Please specify the values in the following format:             ##
##                                                                ##
##         Type         Example                                   ##
##         String       "Sample Value"                            ##
##         Boolean      True or False                             ##
##         Number       1000                                      ##
##         StringList   {"String value 1","String Value 2"}       ##
##                                                                ##
## The values that are given as <Value Required> need to be       ##
## specified for a silent installation to be successful.          ##
##                                                                ##
##                                                                ##
## This response file is generated by Oracle Software             ##
## Packager.                                                      ##
####################################################################
RESPONSEFILE_VERSION=2.2.1.0.0
#-------------------------------------------------------------------------------
#Name       : UNIX_GROUP_NAME
#Datatype   : String
#Description: Unix group to be set for the inventory directory. Valid only in Unix platforms.
#Example : UNIX_GROUP_NAME = "install"
#-------------------------------------------------------------------------------
UNIX_GROUP_NAME=<Value Unspecified>
#-------------------------------------------------------------------------------
#Name       : FROM_LOCATION
#Datatype   : String
#Description: Complete path of the products.jar.
#Example : FROM_LOCATION = "../stage/products.jar"
#-------------------------------------------------------------------------------
FROM_LOCATION="../stage/products.jar"
#-------------------------------------------------------------------------------
#Name       : FROM_LOCATION_CD_LABEL
#Datatype   : String
#Description: This variable should only be used in multi-CD installations. It includes the
 label of the Compact Disk where the file "products.jar" exists. The label can be found in
 the file "disk.label" in the same directory as products.jar.
#Example : FROM_LOCATION_CD_LABEL = "CD Label"
#-------------------------------------------------------------------------------
FROM_LOCATION_CD_LABEL="LABEL1"
#-------------------------------------------------------------------------------
#Name       : NEXT_SESSION_RESPONSE
#Datatype   : String
#Description: Optionally specifies the full path of next session's response file. If only a
 file name is specified, the response file is retrieved from <TEMP>/oraInstall directory.
 This variable is only active if NEXT_SESSION is set to true.
#Example : NEXT_SESSION_RESPONSE = "nextinstall.rsp"
#-------------------------------------------------------------------------------
NEXT_SESSION_RESPONSE=<Value Unspecified>
#-------------------------------------------------------------------------------
#Name       : ORACLE_HOME
#Datatype   : String
#Description: Complete Location of the Oracle Home.
#Example : ORACLE_HOME = "C:\OHOME1"
#-------------------------------------------------------------------------------
ORACLE_HOME=<Value Required>
#-------------------------------------------------------------------------------
#Name       : ORACLE_HOME_NAME
#Datatype   : String
#Description: Oracle Home Name. Used in creating folders, services.
#Example : ORACLE_HOME_NAME = "OHOME1"
#-------------------------------------------------------------------------------
ORACLE_HOME_NAME="OHOME1"
#-------------------------------------------------------------------------------
#Name       : TOPLEVEL_COMPONENT
#Datatype   : StringList
#Description: The Toplevel component that has to be installed in the current session.
#The following choices are available. The value should contain only one of these choices.
#The choices are of the form Internal Name, Version : External name. Please use the internal
 name and version while specifying the value.
#    oracle.swd, 2.2.1.2.0 : Oracle Installation Products 2.2.1.2.0
#Example : TOPLEVEL_COMPONENT = {"oracle.swd","2.2.1.2.0"}
#-------------------------------------------------------------------------------
TOPLEVEL_COMPONENT={"oracle.swd","2.2.1.2.0"}
#-------------------------------------------------------------------------------
#Name       : DEINSTALL_LIST
#Datatype   : StringList
#Description: List of components to be deinstalled during a deinstall session.
#The following choices are available. The value should contain only one of these choices.
#The choices are of the form Internal Name, Version : External name. Please use the internal
 name and version while specifying the value.
#    oracle.swd, 2.2.1.2.0 : Oracle Installation Products 2.2.1.2.0
#Example : DEINSTALL_LIST = {"oracle.swd","2.2.1.2.0"}
#-------------------------------------------------------------------------------
DEINSTALL_LIST={"oracle.swd","2.2.1.2.0"}
#-------------------------------------------------------------------------------
#Name       : SHOW_SPLASH_SCREEN
#Datatype   : Boolean
#Description: Set to true if the initial splash screen in the installer needs to be shown.
#Example : SHOW_SPLASH_SCREEN = true
#-------------------------------------------------------------------------------
SHOW_SPLASH_SCREEN=true
#-------------------------------------------------------------------------------
#Name       : SHOW_WELCOME_PAGE
#Datatype   : Boolean
#Description: Set to true if the Welcome page in the installer needs to be shown.
#Example : SHOW_WELCOME_PAGE = false
#-------------------------------------------------------------------------------
SHOW_WELCOME_PAGE=false
#-------------------------------------------------------------------------------
#Name       : SHOW_COMPONENT_LOCATIONS_PAGE
#Datatype   : Boolean
#Description: Set to true if the component locations page in the installer needs to be shown.
#This page only appears if there are products whose installed directory can be changed.
#If you set this to false you will prevent the user from being able to specify alternate
 directories.
#Example : SHOW_COMPONENT_LOCATIONS_PAGE = false
#-------------------------------------------------------------------------------
SHOW_COMPONENT_LOCATIONS_PAGE=false
#-------------------------------------------------------------------------------
#Name       : SHOW_CUSTOM_TREE_PAGE
#Datatype   : Boolean
#Description: Set to true if the custom tree page in the installer needs to be shown.
#In this page dependencies can be selected or unselected. This page appears only in a custom
 install type.
#Example : SHOW_CUSTOM_TREE_PAGE = false
#-------------------------------------------------------------------------------
SHOW_CUSTOM_TREE_PAGE=false
#-------------------------------------------------------------------------------
#Name       : SHOW_SUMMARY_PAGE
#Datatype   : Boolean
#Description: Set to true if the summary page in the installer needs to be shown.
#The summary page shows the list of components that will be installed in this session.
#Example : SHOW_SUMMARY_PAGE = true
#-------------------------------------------------------------------------------
SHOW_SUMMARY_PAGE=true
#-------------------------------------------------------------------------------
#Name       : SHOW_INSTALL_PROGRESS_PAGE
#Datatype   : Boolean
#Description: Set to true if the install progress page in the installer needs to be shown.
#This page shows the current status in the installation. The current status includes which
 product is being installed, which file is being copied.
#Example : SHOW_INSTALL_PROGRESS_PAGE = true
#-------------------------------------------------------------------------------
SHOW_INSTALL_PROGRESS_PAGE=true
#-------------------------------------------------------------------------------
#Name       : SHOW_REQUIRED_CONFIG_TOOL_PAGE
#Datatype   : Boolean
#Description: Set to true if the required config tools page in the installer needs to be
 shown.
#This page shows the list of required configuration tools that are part of this installation.
#It shows the status of each tool, including any failures with detailed information on why
 the tool has failed.
#Example : SHOW_REQUIRED_CONFIG_TOOL_PAGE = true
#-------------------------------------------------------------------------------
SHOW_REQUIRED_CONFIG_TOOL_PAGE=true
#-------------------------------------------------------------------------------
#Name       : SHOW_OPTIONAL_CONFIG_TOOL_PAGE
#Datatype   : Boolean
#Description: Set to true if the optional config tools page in the installer needs to be
 shown.
#This page shows the list of optional configuration tools that are part of this installation
 and are configured to launch automatically.
#It shows the status of each tool, including any failures with detailed information on why
 the tool has failed.
#Example : SHOW_OPTIONAL_CONFIG_TOOL_PAGE = true
#-------------------------------------------------------------------------------
SHOW_OPTIONAL_CONFIG_TOOL_PAGE=true
#-------------------------------------------------------------------------------
#Name       : SHOW_RELEASE_NOTES
#Datatype   : Boolean
#Description: Set to true if the release notes of this installation need to be shown at the
 end of installation.
#This dialog is launchable from the End of Installation page and shows the list of release
 notes available for the products just installed.
# This also requires the variable SHOW_END_SESSION_PAGE variable to be set to true.
#Example : SHOW_RELEASE_NOTES = true
#-------------------------------------------------------------------------------
SHOW_RELEASE_NOTES=true
#-------------------------------------------------------------------------------
#Name       : SHOW_ROOTSH_CONFIRMATION
#Datatype   : Boolean
#Description: Set to true if the Confirmation dialog asking to run the root.sh script in the
 installer needs to be shown.
#Valid only in Unix platforms.
#Example : SHOW_ROOTSH_CONFIRMATION = true
#-------------------------------------------------------------------------------
SHOW_ROOTSH_CONFIRMATION=true
#-------------------------------------------------------------------------------
#Name       : SHOW_END_SESSION_PAGE
#Datatype   : Boolean
#Description: Set to true if the end of session page in the installer needs to be shown.
#This page shows if the installation is successful or not.
#Example : SHOW_END_SESSION_PAGE = true
#-------------------------------------------------------------------------------
SHOW_END_SESSION_PAGE=true
#-------------------------------------------------------------------------------
#Name       : SHOW_EXIT_CONFIRMATION
#Datatype   : Boolean
#Description: Set to true if the confirmation when exiting the installer needs to be shown.
#Example : SHOW_EXIT_CONFIRMATION = true
#-------------------------------------------------------------------------------
SHOW_EXIT_CONFIRMATION=true
#-------------------------------------------------------------------------------
#Name       : NEXT_SESSION
#Datatype   : Boolean
#Description: Set to true to allow users to go back to the File Locations page for another
 installation. This flag also needs to be set to true in order to process another response
 file (see NEXT_SESSION_RESPONSE).
#Example : NEXT_SESSION = true
#-------------------------------------------------------------------------------
NEXT_SESSION=true
#-------------------------------------------------------------------------------
#Name       : NEXT_SESSION_ON_FAIL
#Datatype   : Boolean
#Description: Set to true to allow users to invoke another session even if current install
 session has failed. This flag is only relevant if NEXT_SESSION is set to true.
#Example : NEXT_SESSION_ON_FAIL = true
#-------------------------------------------------------------------------------
NEXT_SESSION_ON_FAIL=true
#-------------------------------------------------------------------------------
#Name       : SHOW_DEINSTALL_CONFIRMATION
#Datatype   : Boolean
#Description: Set to true if deinstall confimation is needed during a deinstall session.
#Example : SHOW_DEINSTALL_CONFIRMATION = true
#-------------------------------------------------------------------------------
SHOW_DEINSTALL_CONFIRMATION=true
#-------------------------------------------------------------------------------
#Name       : SHOW_DEINSTALL_PROGRESS
#Datatype   : Boolean
#Description: Set to true if deinstall progress is needed during a deinstall session.
#Example : SHOW_DEINSTALL_PROGRESS = true
#-------------------------------------------------------------------------------
SHOW_DEINSTALL_PROGRESS=true
#-------------------------------------------------------------------------------
#Name       : component_languages
#Datatype   : StringList
#Description: Languages in which the components will be installed.
#The following choices are available. The value should contain only one of these choices.
#The choices are of the form Internal Name : External name. Please use the internal name
 while specifying the value.
#    en,   : English
#    fr,   : French
#    ar,   : Arabic
#    bn,   : Bengali
#    pt_BR,   : Brazilian Portuguese
#    bg,   : Bulgarian
#    fr_CA,   : Canadian French
#    ca,   : Catalan
#    hr,   : Croatian
#    cs,   : Czech
#    da,   : Danish
#    nl,   : Dutch
#    ar_EG,   : Egyptian
#    en_GB,   : English (United Kingdom)
#    et,   : Estonian
#    fi,   : Finnish
#    de,   : German
#    el,   : Greek
#    iw,   : Hebrew
#    hu,   : Hungarian
#    is,   : Icelandic
#    in,   : Indonesian
#    it,   : Italian
#    ja,   : Japanese
#    ko,   : Korean
#    es,   : Latin American Spanish
#    lv,   : Latvian
#    lt,   : Lithuanian
#    ms,   : Malay
#    es_MX,   : Mexican Spanish
#    no,   : Norwegian
#    pl,   : Polish
#    pt,   : Portuguese
#    ro,   : Romanian
#    ru,   : Russian
#    zh_CN,   : Simplified Chinese
#    sk,   : Slovak
#    sl,   : Slovenian
#    es_ES,   : Spanish
#    sv,   : Swedish
#    th,   : Thai
#    zh_TW,   : Traditional Chinese
#    tr,   : Turkish
#    uk,   : Ukrainian
#    vi,   : Vietnamese
#Example : COMPONENT_LANGUAGES = {"en"}
#Component  : oracle.swd
#-------------------------------------------------------------------------------
component_languages={"en"}
#-------------------------------------------------------------------------------
#Name       : install_type
#Datatype   : String
#Description: Installation type of the component.
#The following choices are available. The value should contain only one of these choices.
#The choices are of the form Internal Name : External name. Please use the internal name
 while specifying the value.
#    Complete,   : Complete
#    Typical,   : Minimum
#    Custom,   : Custom
#Example : INSTALL_TYPE = "Complete"
#Component  : oracle.swd
#-------------------------------------------------------------------------------
install_type="Typical"
#-------------------------------------------------------------------------------
#Name       : prod_home
#Datatype   : String
#Description: Complete path where the product needs to be installed.
#Example : PROD_HOME = "C:\ProductName"
#Component  : oracle.swd
#-------------------------------------------------------------------------------
oracle.swd:prod_home=<Value Unspecified>
#-------------------------------------------------------------------------------
#Name       : prod_home
#Datatype   : String
#Description: Complete path where the product needs to be installed.
#Example : PROD_HOME = "C:\ProductName"
#Component  : oracle.swd.oui
#-------------------------------------------------------------------------------
oracle.swd.oui:prod_home=<Value Unspecified>
#-------------------------------------------------------------------------------
#Name       : prod_home
#Datatype   : String
#Description: Complete path where the product needs to be installed.
#Example : PROD_HOME = "C:\ProductName"
#Component  : oracle.swd.oui.core
#-------------------------------------------------------------------------------
oracle.swd.oui.core:prod_home=<Value Unspecified>
#-------------------------------------------------------------------------------
#Name       : prod_home
#Datatype   : String
#Description: Complete path where the product needs to be installed.
#Example : PROD_HOME = "C:\ProductName"
#Component  : oracle.swd.jre
#-------------------------------------------------------------------------------
oracle.swd.jre:1.3.1.0.0a:prod_home=<Value Unspecified>
#-------------------------------------------------------------------------------
#Name       : prod_home
#Datatype   : String
#Description: Complete path where the product needs to be installed.
#Example : PROD_HOME = "C:\ProductName"
#Component  : oracle.swd.jre
#-------------------------------------------------------------------------------
oracle.swd.jre:1.3.1.1.0a:prod_home=<Value Unspecified>
#-------------------------------------------------------------------------------
#Name       : prod_home
#Datatype   : String
#Description: Complete path where the product needs to be installed.
#Example : PROD_HOME = "C:\ProductName"
#Component  : oracle.swd.jre
#-------------------------------------------------------------------------------
oracle.swd.jre:1.3.0.0.0:prod_home=<Value Unspecified>
#-------------------------------------------------------------------------------
#Name       : dependency_list
#Datatype   : StringList
#Description: List of Dependees that needs to be installed along with this product.
#The following choices are available. The value can contain any combination of these choices.
#The choices are of the form Internal Name, Version : External name. Please use the internal
 name and version while specifying the value.
#    oracle.swd.jre, 1.3.1.1.0a : Java Runtime Environment 1.3.1.1.0a
#    oracle.swd.jre, 1.3.1.0.0a : Java Runtime Environment 1.3.1.0.0a
#    oracle.swd.osp, 2.2.1.2.0 : Oracle Software Packager 2.2.1.2.0 Alpha
#    oracle.swd.oil, 2.2.1.2.0 : Oracle Installation Libraries 2.2.1.2.0
#    oracle.swd.oui, 2.2.1.2.0 : Oracle Universal Installer 2.2.1.2.0 Alpha
#Example : DEPENDENCY_LIST = {"oracle.swd.jre:1.3.1.1.0a"}
#Component  : oracle.swd
#-------------------------------------------------------------------------------
dependency_list=<Value Unspecified>

Sample ORAPARAM.INI File

The oraparam.ini file is Oracle Universal Installer's initialization file. It should be located in the same directory as the Oracle Universal Installer executable file (setup.exe or runInstaller.sh).

[Oracle]
DISTRIBUTION=TRUE
SOURCE=../stage/products.xml
LICENSE_LOCATION=
JRE_LOCATION=../stage/Components/oracle.swd.jre/1.4.2.0.0/1/DataFiles
JRE_MEMORY_OPTIONS=" -mx150m"
DEFAULT_HOME_LOCATION=oracle/product/11.1.0/db
DEFAULT_HOME_NAME=OraDb11g_home
NO_BROWSE=/net
NLS_ENABLED=TRUE
BOOTSTRAP=TRUE
PREREQ_CONFIG_LOCATION=../stage/prereq
OUI_VERSION=11.1.0.0.0
#SHOW_HOSTNAME=ALWAYS_SHOW shows the hostname panel always
#SHOW_HOSTNAME=NEVER_SHOW does not the hostname panel
#SHOW_HOSTNAME=CONDITION_SHOW shows the hostname panel on condition
SHOW_HOSTNAME=NEVER_SHOW
#THIN_JDBC_FILENAME is optional and defaults to classes12.jar
#The value specified for this should be packaged with OUI, and should
#be relative to <OUI expanded stagedir>/jlib/
THIN_JDBC_FILENAME=classes12.jar
#JRE_OSDPARAM is to set OS dependent param for JRE ( mainly for native VM in 1.3.1)
#JRE_OSDPARAM is optional and should be set to -native for the JRE's
#that support native VM ( mainly for Unix platforms ), in JRE 1.3.1
#For JRE 1.4.1 this should be set to empty or the type of VM that is
#supported client/server. The default value is -native in UNIX platforms
#that supports native VM
#Unix supporting native - JRE_OSDPARAM="-native"
#Unix NOT supporting native and 1.4.1 - JRE_OSDPARAM=""
JRE_OSDPARAM=""
CLUSTERWARE={"oracle.crs","11.1.0.0.0"}
#RUN_OUICA specifies the batch script name that needs to be run
#The script is ouica.bat for win32, and ouica.sh for solaris.
#If the value is not specified, then the OUICA script is not run
RUN_OUICA=ouica.sh

[Certified Versions]
Linux=redhat-2.1,UnitedLinux-1.0,redhat-3,SuSE-9

[Linux-redhat-2.1-optional]

Sample Components File

The components file contains details of all the components as well as patchsets or interim patches installed in the Oracle home.

<?xml version="1.0" standalone="yes" ?>
<!-- Copyright (c) 2007 Oracle Corporation. All rights Reserved -->
<!-- Do not modify the contents of this file by hand. -->
<PRD_LIST>
<TL_LIST>
<COMP NAME="oracle.server" VER="11.1.0.0.0" BUILD_NUMBER="0" REP_VER="0.0.0.0.0"
 RELEASE="Production" INV_LOC="Components/oracle.server/11.1.0.0.0/1/" LANGS="en"
 XML_INV_LOC="Components21/oracle.server/11.1.0.0.0/" ACT_INST_VER="11.1.0.0.0"
 DEINST_VER="11.1.0.0.0" INSTALL_TIME="2007.Jun.03 11:39:07 IST" INST
_LOC="/home/shiva/oracle/product/11.1.0/db_2/oracle.server">
   <EXT_NAME>Oracle Database 11g</EXT_NAME>
   <DESC>Installs an optional pre-configured starter database, product options,
 management tools, networking services, utilities and basic client software for an
 Oracle database server.</DESC>
   <DESCID>COMPONENT_DESC</DESCID>
   <STG_INFO OSP_VER="11.1.0.0.0"/>
   <CMP_JAR_INFO>
      <INFO NAME="filemapObj" VAL="Components/oracle/server/v11_1_0_0
_0/filemap.xml"/>
      <INFO NAME="helpDir" VAL="Components/oracle/server/v11_1_0_0_0/help/"/>
      <INFO NAME="actionsClass" VAL="Components.oracle.server.v11_1_0_0
_0.CompActions"/>
      <INFO NAME="resourceClass" VAL="Components.oracle.server.v11_1_0_0
_0.resources.CompRes"/>
      <INFO NAME="identifiersXML" VAL="Components/oracle/server/v11_1_0_0_
0/identifiers.xml"/>
      <INFO NAME="contextClass" VAL="Components.oracle.server.v11_1_0_0_
0.CompContext"/>
      <INFO NAME="fastCopyLogXML" VAL="Components/oracle/server/v11_1_0_0_
0/fastCopyLog.xml"/>
   </CMP_JAR_INFO>
   <LOC_INFO INST_DFN_LOC="../Scripts" JAR_NAME="install2.jar"/>
   <BOOK NAME="oracle.server.hs"/>
   <PRE_REQ DEF="F"/>
   <PROD_HOME DEF="F"/>
   <LANG_IDX_MAP>
      <LANG LIST="en fr ar bn pt_BR bg fr_CA ca hr cs da nl ar_EG en_GB et fi de
 el iw hu is in it ja ko es lv lt ms es_MX no pl pt ro ru zh_CN sk sl es_ES sv th
 zh_TW tr uk vi"/>
      <LANGSET IDX="1" BITSET="{0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34,
 35, 36, 37, 38, 39, 40, 41, 42, 43, 44}"/>
      <LANGSET IDX="2" BITSET="{0}"/>
      <LANGSET IDX="3" BITSET="{2}"/>
      <LANGSET IDX="4" BITSET="{7}"/>
      <LANGSET IDX="5" BITSET="{9}"/>
      <LANGSET IDX="6" BITSET="{16}"/>
      <LANGSET IDX="7" BITSET="{10}"/>
      <LANGSET IDX="8" BITSET="{25, 29, 38}"/>
      <LANGSET IDX="9" BITSET="{17}"/>
      <LANGSET IDX="10" BITSET="{1}"/>
      <LANGSET IDX="11" BITSET="{19}"/>
      <LANGSET IDX="12" BITSET="{22}"/>
      <LANGSET IDX="13" BITSET="{18}"/>
      <LANGSET IDX="14" BITSET="{23}"/>
      <LANGSET IDX="15" BITSET="{24}"/>
      <LANGSET IDX="16" BITSET="{30}"/>
      <LANGSET IDX="17" BITSET="{11}"/>
      <LANGSET IDX="18" BITSET="{31}"/>
      <LANGSET IDX="19" BITSET="{4, 32}"/>
      <LANGSET IDX="20" BITSET="{4}"/>
      <LANGSET IDX="21" BITSET="{33}"/>
      <LANGSET IDX="22" BITSET="{34}"/>
      <LANGSET IDX="23" BITSET="{39}"/>
      <LANGSET IDX="24" BITSET="{15}"/>
      <LANGSET IDX="25" BITSET="{36}"/>
      <LANGSET IDX="26" BITSET="{40}"/>
      <LANGSET IDX="27" BITSET="{42}"/>
      <LANGSET IDX="28" BITSET="{35, 41}"/>
      <LANGSET IDX="29" BITSET="{32}"/>
      <LANGSET IDX="30" BITSET="{38}"/>
      <LANGSET IDX="31" BITSET="{35}"/>
      <LANGSET IDX="32" BITSET="{41}"/>
      <LANGSET IDX="33" BITSET="{0, 1, 16, 23}"/>
      <LANGSET IDX="34" BITSET="{25}"/>
      <LANGSET IDX="35" BITSET="{0, 1, 4, 6, 16, 18, 22, 23, 24, 25, 29, 35, 38, 41}"/>
      <LANGSET IDX="36" BITSET="{0, 23}"/>
      <LANGSET IDX="37" BITSET="{}"/>
      <LANGSET IDX="38" BITSET="{0, 1, 4, 16, 22, 23, 24, 35, 38, 41}"/>
      <LANGSET IDX="39" BITSET="{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
 15, 16, 17, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 36,
 37, 38, 39, 40, 42, 43, 44}"/>
      <LANGSET IDX="40" BITSET="{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34,
 35, 36, 37, 38, 39, 40, 41, 42, 43, 44}"/>
   </LANG_IDX_MAP>
   <PLAT_IDX_MAP>
      <PLAT LIST="46"/>
   </PLAT_IDX_MAP>
   <DST_IDX_MAP>
      <DST LIST="%INVENTORY_LOCATION% %ORACLE_HOME% %s_TMPDIR_LOC% %s_TEMP_LOC%"/>
   </DST_IDX_MAP>
   <DEP_GRP_LIST>
      <DEP_GRP NAME="Optional" EXT_NAME="Product Options" TYPE="O">
         <DEP_LIST>
            <DEP NAME="oracle.rdbms" VER="11.1.0.0.0" PLAT="Linux"/>
            <DEP NAME="oracle.options" VER="11.1.0.0.0" PLAT="Linux"/>
            <DEP NAME="oracle.network" VER="11.1.0.0.0" PLAT="Linux"/>
            <DEP NAME="oracle.sysman.console.db" VER="11.1.0.0.0" PLAT="Linux"/>
            <DEP NAME="oracle.rdbms.oci" VER="11.1.0.0.0" PLAT="Linux"/>
            <DEP NAME="oracle.precomp" VER="11.1.0.0.0" PLAT="Linux"/>
            <DEP NAME="oracle.xdk" VER="11.1.0.0.0" PLAT="Linux"/>
            <DEP NAME="oracle.doc" VER="11.1.0.0.0" PLAT="Linux"/>
            <DEP NAME="oracle.winprod" VER="11.1.0.0.0" PLAT="ALL_PLATFORMS"/>
            <DEP NAME="oracle.sqlplus.isqlplus" VER="11.1.0.0.0" PLAT="Linux"/>
            <DEP NAME="oracle.odbc" VER="11.1.0.0.0" PLAT="Linux"/>
         </DEP_LIST>
      </DEP_GRP>
      <DEP_GRP NAME="Required" EXT_NAME="Required Dependencies" TYPE="R">
         <DEP_LIST>
            <DEP NAME="oracle.rdbms.install.common" VER="11.1.0.0.0"
 PLAT="Linux"/>
         </DEP_LIST>
      </DEP_GRP>
      <DEP_GRP NAME="OptionalDecideNow" EXT_NAME="Installed Components" TYPE="O">
         <DEP_LIST>
            <DEP NAME="oracle.swd.oui" VER="11.1.0.0.0" PLAT="Linux"/>
            <DEP NAME="oracle.swd.opatch" VER="11.1.0.0.0" PLAT="Linux"/>
            <DEP NAME="oracle.dbjava.jdbc12" VER="11.1.0.0.0" PLAT="Linux"/>
         </DEP_LIST>
      </DEP_GRP>
   </DEP_GRP_LIST>
   <DEP_LIST>
      <DEP NAME="oracle.rdbms" VER="11.1.0.0.0" DEP_GRP_NAME="Optional" HOME_
IDX="1"/>
      <DEP NAME="oracle.options" VER="11.1.0.0.0" DEP_GRP_NAME="Optional" HOME_
IDX="1"/>
      <DEP NAME="oracle.network" VER="11.1.0.0.0" DEP_GRP_NAME="Optional" HOME_
IDX="1"/>
      <DEP NAME="oracle.sysman.console.db" VER="11.1.0.0.0" DEP_GRP_
NAME="Optional" HOME_IDX="1"/>
      <DEP NAME="oracle.rdbms.oci" VER="11.1.0.0.0" DEP_GRP_NAME="Optional" HOME_
IDX="1"/>
      <DEP NAME="oracle.precomp" VER="11.1.0.0.0" DEP_GRP_NAME="Optional" HOME_
IDX="1"/>
      <DEP NAME="oracle.xdk" VER="11.1.0.0.0" DEP_GRP_NAME="Optional" HOME_
IDX="1"/>
      <DEP NAME="oracle.sqlplus.isqlplus" VER="11.1.0.0.0" DEP_GRP_NAME="Optional"
 HOME_IDX="1"/>
      <DEP NAME="oracle.odbc" VER="11.1.0.0.0" DEP_GRP_NAME="Optional" HOME_
IDX="1"/>
      <DEP NAME="oracle.rdbms.install.common" VER="11.1.0.0.0" DEP_GRP_
NAME="Required" HOME_IDX="1"/>
      <DEP NAME="oracle.swd.oui" VER="11.1.0.0.0" DEP_GRP_NAME="OptionalDecideNow"
 HOME_IDX="1"/>
      <DEP NAME="oracle.swd.opatch" VER="11.1.0.0.0" DEP_GRP_
NAME="OptionalDecideNow" HOME_IDX="1"/>
      <DEP NAME="oracle.dbjava.jdbc12" VER="11.1.0.0.0" DEP_GRP_
NAME="OptionalDecideNow" HOME_IDX="1"/>
   </DEP_LIST>
   <REF_LIST>
      <REF NAME="oracle.server" VER="11.1.0.0.0" HOME_IDX="1"/>
   </REF_LIST>
   <INST_TYPE_LIST>
      <INST_TYPE NAME="EE" NAME_ID="EE" DESC_ID="EE_DESC"/>
   </INST_TYPE_LIST>
   <FILESIZEINFO>
      <DEST VOLUME="%INVENTORY_LOCATION%" SPACE_REQ="2000"/>
      <DEST VOLUME="%ORACLE_HOME%" SPACE_REQ="98465"/>
      <DEST VOLUME="%s_TMPDIR_LOC%" SPACE_REQ="0"/>
      <DEST VOLUME="%s_TEMP_LOC%" SPACE_REQ="0"/>
   </FILESIZEINFO>
</COMP>

Index

A  B  C  D  E  F  H  I  J  L  M  N  O  P  Q  R  S  T  U  V  W  X 

A

ACCEPT_LICENSE_AGREEMENT parameter, 3.4.4

adding nodes, 1.4.6

all node patching, 7.9.1

APPLTOP_STAGE parameter in ORAPARAM.INI, 4.2.2, 4.2.2

Apply command

for OUI-based homes, 7.5.1

for standalone OPatch, 7.6.3.1

patch conflict behavior, 7.10.2

ARU_IDs for platforms, 2.6.1.3.2

attaching Oracle homes, 1.4.7.1

B

background processes

clusterware, 5.7.3

Oracle Clusterware, 5.8.3

BOOTSTRAP parameter in ORAPARAM.INI, 4.2.2

BOOTSTRAP_SIZE parameter in ORAPARAM.INI, 4.2.2

C

Cache Fusion, 5.2.2, 5.8.1

Central Inventory, 2.6.1.2

creating, 2.6.2

detaching homes from the Central Inventory, 2.6.3

inventory file, 2.6.1.2.1

logs directory, 2.6.1.2.2

recovering from corruption, 2.6.8.1

removing, 2.6.3.2

on UNIX platforms, 2.6.3.2.1

on Windows platforms, 2.6.3.2.2

using session variables, 2.6.2.1

verifying the operation, 2.6.2.2

Central Inventory pointer file, 2.6.1.1

Linux, 2.6.1.1

Solaris, 2.6.1.1

Windows, 2.6.1.1

changing primary Oracle home, 2.7

cloning

about, 6.1

cloning phase, 6.2.2

considerations, 4.4.4

description of process, 1.4.3

log files, 6.3

Oracle Database 11.1, 6.4, 6.4.2

overview, 6.2

preparing the 11.1 Oracle Database source, 6.4.1

source preparation phase, 6.2.1

cluster

adding more nodes, 5.9

availability checking, 5.10.2

creating clusterware home directory, 5.4.10

deinstallation, 5.10.5, 5.14

on UNIX, 5.14.1

on Windows, 5.14.2

detection, 5.10.1

hardware requirements, 5.2.1

installation, 5.10, 5.10.3

command line options, 5.11

in silent mode, 5.10.4

product software, 5.10

OPatch prerequisites, 7.3.2

patching

all node patching, 7.9.1

minimum downtime patching, 7.9.3

rolling patching, 7.9.2

patchsets and upgrades, 5.12

setup and pre-install config tasks

UNIX, 5.4

Windows, 5.5

software requirements, 5.2.2

SSH configuration, 5.4.2.2

system installation requirements, 5.2

troubleshooting, 5.16

updating nodes, 2.6.9.1

Cluster File System (CFS), 5.10.3

CLUSTER_NODES parameter, 3.4.4, 3.4.4, 3.4.4

clusterware, 5.1.1, 5.7.2

background processes, 5.7.3, 5.8.3

creating

home directory, 5.4.10

deinstallation, 5.14.3

installation on UNIX, 5.7

installing with OUI, 5.8.1

in silent mode, 5.8.2

Oracle Clusterware

home directory, 5.4.8.3

storage, 5.6

stty commands, 5.4.2.2.3

troubleshooting, 5.16

command line arguments for OUI, 4.4.2

components file

sample, D.3

third-party applications and, 2.6.1.3.1

creating

Oracle home, 2.2

required UNIX groups and users, 5.4.2

D

debugging

automated inventory backups, B.1.2

central inventory backup, B.1.2.1

installation log, B.1.1

mechanisms, B.1

Oracle Universal Installer errors, B.2

default Oracle home, determining, 2.4

DEFAULT_HOME_LOCATION parameter in ORAPARAM.INI, 4.2.2

DEFAULT_HOME_NAME parameter in ORAPARAM.INI, 4.2.2

DEINSTALL_LIST parameter, 3.4.4

deinstallation

cluster, 5.10.5

dependents, 4.3.2

description of process, 1.4.2

Oracle Clusterware, 5.14.3

Oracle products, 4.3

Real Application Clusters software, 5.14

on UNIX, 5.14.1

on Windows, 5.14.2

removing products and Oracle homes, 4.3.1

silent, 4.3.3

top level products, 4.3.2

DEPENDENCY_LIST parameter, 3.4.4

detaching homes from the Central Inventory, 2.6.3

using optional flags, 2.6.3.1

detaching Oracle homes, 1.4.7.2

diagnosing inventory corruption, 2.6.8.1, 2.6.8.2

diagnosing RAC inventory corruption, 2.6.9.2

directory structure

for UNIX, 2.7.4

for Windows, 2.7.3

disk space requirements, 1.1, 1.1

DISTRIBUTION parameter in ORAPARAM.INI, 4.2.2

E

errors

exceptions from action libraries, B.2

failed to connect to server error, 4.2.5.1

incomplete stage and missing files in file groups, B.2

out of "temp" space, B.2

UNCAUGHT_RUNTIME exception, B.2

Exceed tool, B.3

exit codes for Oracle Universal Installer, 4.4.3

F

failed to connect to server error, 4.2.5.1

format of response file, 3.4

FROM_LOCATION response file parameter, 3.4.4

FROM_LOCATION_CD_LABEL parameter, 3.4.4

H

help, getting while installing products, 4.2.1

Home Inventory

recovering from corruption, 2.6.8.2

home properties file, 2.6.1.3.2

ARU_IDs for platforms, 2.6.1.3.2

Home Selector, 2.7

changing primary Oracle home, 2.7

function of, 2.7.2

overview, 2.7.1

I

IMAGES section of ORAPARAM.INI, 4.2.2

INCLUDE response file parameter, 3.4.4

INSTALL_TYPE response file parameter, 3.4.4

installation

automatic prerequisite checks, 4.1

cluster, 5.10.3

in silent mode, 5.10.4

command line options for cluster, 5.11

description of process, 1.4.1

from staged HTTP location, 4.2.4.3

from the Web, 4.2.4.3

getting help, 4.2.1

media available, 4.2.4

modes, 4.2.3

on a cluster, 5.10

ORAPARAM.INI file, 4.2.2

post tasks for Real Application Clusters, 5.13

backing up disk, 5.13.2

configuring Oracle products, 5.13.4

download and install patches, 5.13.3

verfication, 5.13.1

prerequisite check parameters, 4.1

prerequisite checks, 4.1

response file, using, 3.5

silent mode prerequisite checks, 4.1

standalone prerequisite checks, 4.1

TEMP/TMP directory, 4.2.4.2.1

UNIX, special instructions, 4.2.5

installation modes, 1.6

clusters, 1.6.4

interactive, 1.6.1, 4.2.3

silent, 1.6.3, 4.2.3

suppressed, 1.6.2, 4.2.3

installing

Oracle Clusterware, 5.8.1

Oracle Clusterware in silent mode, 5.8.2

Oracle home on multiple nodes, 1.4.6

Oracle products, 4.2

product sofware on a cluster, 5.10

interim patches, getting, 7.1.2

internationalization

installation dialogs language, 8.1

language add-on, 8.3

product language selections, 8.2

inventory

about, 2.6

backup, 2.6.7

Central Inventory

creating, 2.6.2

detaching homes, 2.6.3

inventory file, 2.6.1.2.1

logs directory, 2.6.1.2.2

recovering from corruption, 2.6.8.1

removing, 2.6.3.2

removing on UNIX platforms, 2.6.3.2.1

removing on Windows platforms, 2.6.3.2.2

using session variables, 2.6.2.1

verifying the operation, 2.6.2.2

Home Inventory, recovering from corruption, 2.6.8.2

operations, 1.4.7

attaching Oracle homes, 1.4.7.1

detaching Oracle homes, 1.4.7.2

updating the node list, 1.4.7.3

Oracle home inventory, 2.6.1.3

ContentsXML folder, 2.6.1.3.3

one-offs folder, 2.6.1.3.3

scripts folder, 2.6.1.3.3

templates folder, 2.6.1.3.3

pointer file, 2.6.1.1

RAC Home Inventory, recovering from corruption, 2.6.9.2

Real Application Clusters, 2.6.9

structure of, 2.6.1

Oracle home inventory, 2.6.1.3

pointer file, 2.6.1.1

IP address requirements, Windows, 5.5.4.2

J

Java Runtime Environment (JRE), 1.1

JRE, 1.1

JRE_LOCATION parameter in ORAPARAM.INI, 4.2.2

JRE_MEMORY_OPTIONS parameter in ORAPARAM.INI, 4.2.2

L

LICENSE_LOCATION parameter in ORAPARAM.INI, 4.2.2

LICENSE_TITLE parameter in ORAPARAM.INI, 4.2.2

Linux Central Inventory pointer file, 2.6.1.1

LOCATION_FOR_DISK2 parameter, 3.4.4

log files

for Oracle Universal Installer, 4.5

locating and viewing for cloning, 6.3

Lsinventory command

for OUI-based homes, 7.5.3

for standalone OPatch, 7.6.3.2

M

mass deployment, 5.9

memory requirements, 1.1

MetaLink certification information, 5.3

minimum downtime patching, 7.9.3

modes of installation, 1.6, 4.2.3

clusters, 1.6.4

interactive, 1.6.1, 4.2.3

silent, 1.6.3, 4.2.3

suppressed, 1.6.2, 4.2.3

multi-CD support, response file, 3.4.4

multiple Oracle homes, 2.5

N

Napply command

for OUI-based homes, 7.5.2

patch conflict behavior, 7.10.2

network

hardware requirements, 5.4.5.1

IP address requirements, 5.4.5.3

node time requirements, 5.4.5.4

parameter requirements, 5.4.5.2

requirements for Windows, 5.5.4

Network File System (NFS), 5.10.3, 5.10.3

NEXT_SESSION resonse file parameter, 3.4.4

NEXT_SESSION_ON_FAIL parameter, 3.4.4

NEXT_SESSION_RESPONSE parameter, 3.4.4

NLS_ENABLED parameter in ORAPARAM.INI, 4.2.2

NLS_ENABLED variable, 8.1

NO_BROWSE parameter in ORAPARAM.INI, 4.2.2

nodes, adding, 1.4.6

Nrollback command for OUI-based homes, 7.5.6

O

OPatch

additional checks for RAC, 7.3.2

Apply command

for OUI-based homes, 7.5.1

for standalone OPatch, 7.6.3.1

backup and recovery considerations, 7.4

bug conflict, 7.10.1.4

conflict detection and resolution, 7.10.3

conflicts, 7.10

bug conflict, 7.10.1.4

duplicate, 7.10.1.3

file conflict, 7.10.1.5

subset, 7.10.1.2

superset, 7.10.1.1

types, 7.10.1

debugging

logging and tracing, 7.11.1

recovering from failed patching, 7.11.2

resolving application errors, 7.11.3

description, 1.3.2

duplicate conflicts, 7.10.1.3

environment variables, 7.1.3

features, 7.1.1

file conflict, 7.10.1.5

getting interim patches, 7.1.2

Lsinventory command

for OUI-based homes, 7.5.3

for standalone OPatch, 7.6.3.2

Napply command

for OUI-based homes, 7.5.2

Nrollback command for OUI-based homes, 7.5.6

online patching, 7.8

overview, 7.1

prerequisite checks, 7.3

problem resolution, 7.11

Query command

for OUI-based homes, 7.5.4

for standalone OPatch, 7.6.3.3

Real Application Clusters patching

all node patching, 7.9.1

minimum downtime patching, 7.9.3

rolling patching, 7.9.2

requirements, 7.2

Rollback command

for OUI-based homes, 7.5.5

for standalone OPatch, 7.6.3.4

standalone patching, 7.6

inventory operations use cases, 7.6.4.1

patching operations use cases, 7.6.4.2

requirements, 7.6.2

schema patching options, 7.7.1

standalone SQL execution, 7.7.2

unsupported services, 7.6.1

utility for standalone homes, 7.6.3

utility operations use cases, 7.6.4.3

subset conflicts, 7.10.1.2

superset conflicts, 7.10.1.1

troubleshooting

logging and tracing, 7.11.1

recovering from failed patching, 7.11.2

resolving application errors, 7.11.3

types of conflicts, 7.10.1

utility for OUI-based Oracle homes, 7.5

Version command

for OUI-based homes, 7.5.7

for standalone OPatch, 7.6.3.5

OpenSSH, 5.4.2.2, 5.4.2.2

Optimal Flexible Architecture

characteristics of OFA, 2.7.4

directory structure, 2.7.4

Optimal Flexible Architecture (OFA)

ORACLE_BASE directory, 2.7.4.1

ORACLE_HOME directory, 2.7.4.2

optional response file parameters, 3.5.2

OPTIONAL_CONFIG_TOOLS parameter, 3.4.4

Oracle base directory, 5.4.8.1, 5.4.9

Oracle Cluster Registry location option, 5.7.1

Oracle Clusterware

home directory, 5.4.8.3

Oracle Diagnostic Logging (ODL) guidelines, 7.11.1.2

Oracle home directory, 5.4.8.4

Oracle home inventory

ARU_IDs for platforms, 2.6.1.3.2

components file (comps.xml), 2.6.1.3.1

home properties file, 2.6.1.3.2

Oracle homes

attaching, 1.4.7.1

changing with Home Selector, 2.7

creating, 2.2

default homes, 2.4

description, 1.5.2

detaching, 1.4.7.2

detaching homes from the Central Inventory, 2.6.3

directory structure

UNIX, 2.7.4

Windows, 2.7.3

introduction, 2.1

multiple homes, support of, 2.5

removing, 2.3, 4.3.1

target home, definition, 2.5.1

Oracle Inventory directory (oraInventory), 5.4.8.2

Oracle Inventory group and UNIX, 5.4.2

Oracle MetaLink certification information, 5.3

ORACLE section of ORAPARAM.INI, 4.2.2

Oracle Universal Installer

attaching Oracle homes, 1.4.7.1

Central Inventory, 2.6.1.2

cloning, 4.4.4

command line arguments, 4.4.2

description, 1.3.1

detaching Oracle homes, 1.4.7.2

exit codes, 4.4.3

installation modes, 1.6

inventory, 2.6

description, 1.5.1

operations, 1.4.7

inventory structure, 2.6.1

Oracle home inventory, 2.6.1.3

pointer file, 2.6.1.1

log files, 4.5

Oracle home description, 1.5.2

running, 4.4

starting, 4.4.1

system requirements, 1.1

updating node list, 1.4.7.3

XML format, 2.6

ORACLE_BASE, 2.4

ORACLE_BASE directory, 2.7.4.1

ORACLE_HOME directory, 2.7.4.2

ORACLE_HOME response file parameter, 3.4.4

ORACLE_HOME_NAME response file parameter, 3.4.4

ORAPARAM.INI file

APPLTOP_STAGE parameter, 4.2.2

BOOTSTRAP parameter, 4.2.2

BOOTSTRAP_SIZE parameter, 4.2.2

DEFAULT_HOME_LOCATION, 4.2.2

DEFAULT_HOME_NAME parameter, 4.2.2

description, 4.2.2

DISTRIBUTION parameter, 4.2.2

IMAGES section, 4.2.2

JRE_LOCATION parameter, 4.2.2

JRE_MEMORY_OPTIONS parameter, 4.2.2

LICENSE_LOCATION parameter, 4.2.2

LICENSE_TITLE parameter, 4.2.2

NLS_ENABLED parameter, 4.2.2

NO_BROWSE parameter, 4.2.2

ORACLE section, 4.2.2

OUI_LOCATION parameter, 4.2.2

OUI_VERSION parameter, 4.2.2

REGISTRATION_KEY, 4.2.2

REGISTRATION_URL, 4.2.2

sample, D.2

SOURCE parameter, 4.2.2

USE_BUILD_NUMBER parameter, 4.2.2

out of "temp" space error, B.2

P

parameters for response file, 3.4.4

patching

additional checks for RAC, 7.3.2

backup and recovery considerations, 7.4

conflict detection and resolution, 7.10.3

conflicts

duplicate, 7.10.1.3

subset, 7.10.1.2

superset, 7.10.1.1

types, 7.10.1

debugging

logging and tracing, 7.11.1

recovering from failed patching, 7.11.2

resolving application errors, 7.11.3

description of process, 1.4.4

environment variables, 7.1.3

getting interim patches, 7.1.2

online, 7.8

OPatch utility for OUI-based Oracle homes, 7.5

prerequisite checks, 7.3

problem resolution, 7.11

Real Application Clusters

all node patching, 7.9.1

minimum downtime patching, 7.9.3

rolling patching, 7.9.2

requirements, 7.2

standalone, 7.6

inventory operations use cases, 7.6.4.1

patching operations use cases, 7.6.4.2

requirements, 7.6.2

schema patching options, 7.7.1

SQL execution, 7.7.2

unsupported services, 7.6.1

utility for standalone homes, 7.6.3

utility operations use cases, 7.6.4.3

troubleshooting

logging and tracing, 7.11.1

recovering from failed patching, 7.11.2

resolving application errors, 7.11.3

patchsets for upgrades, 1.4.5

post installation tasks, Real Application Clusters, 5.13

prerequisite checks

automatic checks, 4.1

command line parameters, 4.1

installing products, 4.1

slient mode checks, 4.1

standalone checks, 4.1

Q

Query command

for OUI-based homes, 7.5.4

for standalone OPatch, 7.6.3.3

R

RAC Home Inventory

recovering from corruption, 2.6.9.2

Real Application Clusters

Cache Fusion, 5.2.2

clusterware, 5.1.1

converting single-instance nodes to, 5.15

creating UNIX groups and users, 5.4.2

hardware requirements, 5.2.1

installed components, 5.1.2

inventory for, 2.6.9

IP address requirements, 5.4.5.3

network

hardware requirements, 5.4.5.1

parameter requirements, 5.4.5.2

node time requirements, 5.4.5.4

Oracle

base directory, 5.4.8.1, 5.4.9

Clusterware home directory, 5.4.8.3

home directory, 5.4.8.4

inventory directory, 5.4.8.2

patching

all node patching, 7.9.1

minimum downtime patching, 7.9.3

rolling patching, 7.9.2

patchsets and upgrades, 5.12

setup and pre-install config tasks, 5.4

software requirements, 5.2.2

SSH configuration, 5.4.2.2

system installation requirements, 5.2

troubleshooting, 5.16

updating nodes, 2.6.9.1

Real Application Tasks

post installation tasks, 5.13

backing up disk, 5.13.2

configuring Oracle products, 5.13.4

downloading and installing patches, 5.13.3

verification, 5.13.1

record mode, 3.3

using to create response file, 3.3.1

recovering from inventory corruption, 2.6.8.1, 2.6.8.2

recovering from RAC inventory corruption, 2.6.9.2

Reflection X, troubleshooting, B.3

REGISTRATION_KEY parameter in ORAPARAM.INI, 4.2.2

REGISTRATION_URL parameter in ORAPARAM.INI, 4.2.2

REMOVE_HOMES parameter, 3.4.4

removing

Central Inventory, 2.6.3.2

on UNIX platforms, 2.6.3.2.1

on Windows platforms, 2.6.3.2.2

Oracle homes, 2.3, 4.3.1

reponse file optional parameters, 3.5.2

requirements

disk space, 1.1, 1.1

JRE, 1.1

memory, 1.1

response file

ACCEPT_LICENSE_AGREEMENT parameter, 3.4.4

CLUSTER_NODES parameter, 3.4.4, 3.4.4, 3.4.4

creating with record mode, 3.3

definition, 3.1.2

DEINSTALL_LIST parameter, 3.4.4

DEPENDENCY_LIST parameter, 3.4.4

format, 3.4

FROM_LOCATION response file parameter, 3.4.4

FROM_LOCATION_CD_LABEL parameter, 3.4.4

general format

comments, 3.4.2

headers, 3.4.3

values, 3.4.1

INCLUDE parameter, 3.4.4

INSTALL_TYPE parameter, 3.4.4

installing by using, 3.5

location, 3.1.2

LOCATION_FOR_DISK2 parameter, 3.4.4

modifying, 3.2

NEXT_SESSION parameter, 3.4.4

NEXT_SESSION_ON_FAIL parameter, 3.4.4

NEXT_SESSION_RESPONSE parameter, 3.4.4

OPTIONAL_CONFIG_TOOLS parameter, 3.4.4

ORACLE_HOME parameter, 3.4.4

ORACLE_HOME_NAME parameter, 3.4.4

parameters, 3.4.4

record mode, using, 3.3.1

REMOVE_HOMES parameter, 3.4.4

RESPONSEFILE_VERSION parameter, 3.4.4

RESTART_SYSTEM parameter, 3.4.4

sample, D.1

SELECTED_LANGUAGES, 3.4.4

setting variables from command line, 3.5.3

SHOW_COMPONENT_LOCATIONS_PAGE parameter, 3.4.4

SHOW_CUSTOM_TREE parameter, 3.4.4

SHOW_DEINSTALL_CONFIRMATION parameter, 3.4.4

SHOW_DEINSTALL_PROGRESS parameter, 3.4.4

SHOW_END_SESSION_PAGE parameter, 3.4.4

SHOW_EXIT_CONFIRMATION parameter, 3.4.4

SHOW_INSTALL_PROGRESS_PAGE parameter, 3.4.4

SHOW_OPTIONAL_CONFIG_TOOL_PAGE, 3.4.4

SHOW_RELEASE_NOTES, 3.4.4

SHOW_ROOTSH_CONFIRMATION parameter, 3.4.4

SHOW_SPLASH_SCREEN parameter, 3.4.4

SHOW_SUMMARY_PAGE parameter, 3.4.4

SHOW_WELCOME_PAGE parameter, 3.4.4

silent installation, 3.1.1

specifying, 3.5.1

value of component variable, 3.5.3.2

value of session variable, 3.5.3.1

TOPLEVEL_COMPONENT parameter, 3.4.4

UNIX_GROUP_NAME parameter, 3.4.4

using, 3.5

variable lookup order, 3.4.1.1

variable values, 3.4.1.1, 3.4.1.2

RESPONSEFILE_VERSION parameter, 3.4.4

RESTART_SYSTEM parameter, 3.4.4

Rollback command

for OUI-based homes, 7.5.5

for standalone OPatch, 7.6.3.4

rolling patching, 7.9.2

RSA key, 5.4.2.2.1

running

in silent mode to install, 5.7.2

OUI after installation, 4.4

S

SELECTED_LANGUAGES, 3.4.4

SELECTED_LANGUAGES variable, 8.2

session variables, using to create Central Inventory, 2.6.2.1

setting response file variables, 3.5.3

SHOW_COMPONENT_LOCATIONS_PAGE parameter, 3.4.4

SHOW_CUSTOM_TREE_PAGE parameter, 3.4.4

SHOW_DEINSTALL_CONFIRMATION parameter, 3.4.4

SHOW_DEINSTALL_PROGRESS parameter, 3.4.4

SHOW_END_SESSION_PAGE parameter, 3.4.4

SHOW_EXIT_CONFIRMATION parameter, 3.4.4

SHOW_INSTALL_PROGRESS_PAGE parameter, 3.4.4

SHOW_OPTIONAL_CONFIG_TOOL_PAGE, 3.4.4

SHOW_RELEASE_NOTES, 3.4.4

SHOW_ROOTSH_CONFIRMATION parameter, 3.4.4

SHOW_SPLASH_SCREEN parameter, 3.4.4

SHOW_SUMMARY_PAGE parameter, 3.4.4

SHOW_WELCOME_PAGE parameter, 3.4.4

silent deinstallation, 4.3.3

silent installation

definition, 3.1.1

reasons for performing, 3.1.3

silent mode, installing clusterware, 5.7.2

single-instance nodes, converting to Real Application Clusters, 5.15

Solaris Central Inventory pointer file, 2.6.1.1

SOURCE parameter in ORAPARAM.INI, 4.2.2

specifying

value of component variable, 3.5.3.2

value of session variable, 3.5.3.1

SSH configuration, 5.4.2.2

staged HTTP location, installing from, 4.2.4.3

starting Oracle Universal Installer, 4.4.1

storage, clusterware, 5.6

stty commands, 5.4.2.2.3

system requirements

disk space, 1.1

JRE, 1.1

memory, 1.1

T

Tarantella, troubleshooting, B.3

target home, 2.5.1

TEMP/TMP directory for CD-ROMs, 4.2.4.2.1

third-party applications, components file and, 2.6.1.3.1

TOPLEVEL_COMPONENT parameter, 3.4.4

translation

installation dialogs language, 8.1

language add-on, 8.3

product language selections, 8.2

troubleshooting

automated inventory backups, B.1.2

central inventory backup, B.1.2.1

debugging mechanisms, B.1

Exceed, B.3

installation log, B.1.1

Oracle Universal Installer errors, B.2

Reflection X, B.3

Tarantella, B.3

U

UNIX

creating required groups and users, 5.4.2

directory structure for, 2.7.4

installing Oracle clusterware, 5.7

special installation instructions, 4.2.5

UNIX_GROUP_NAME parameter, 3.4.4

updating

node list, 1.4.7.3

nodes for a cluster, 2.6.9.1

upgrades of products, 1.4.5

USE_BUILD_NUMBER parameter in ORAPARAM.INI, 4.2.2, 4.2.2

user equivalency, 5.4.2.2.2

using optional flags to detach Oracle homes, 2.6.3.1

utilities

actions performed, 1.4

for software deployment, 1.3

V

variable

lookup order, response file, 3.4.1.1

values for response file, 3.4.1.2

variable NLS_ENABLED, 8.1

variable SELECTED_LANGUAGES, 8.2

VD (Voting Disk Location) location option, 5.7.1

verifying the Central Inventory operation, 2.6.2.2

Version command

for OUI-based homes, 7.5.7

for standalone OPatch, 7.6.3.5

W

Web installation, 4.2.4.3

Windows

Central Inventory pointer file, 2.6.1.1

hardware and software certification, 5.5.1

hardware requirements, 5.5.2

IP address requirements, 5.5.4.2

network requirements, 5.5.4

pre-installation tasks for Real Application Clusters, 5.5

software requirements, 5.5.3

Windows, directory structure for, 2.7.3

X

XML format, OUI inventory and, 2.6

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2010, Oracle and/or its affiliates. All rights reserved.

License Restrictions Warranty/Consequential Damages Disclaimer

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

Hazardous Applications Notice

This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.

Trademark Notice

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Third-Party Content, Products, and Services Disclaimer

This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.