A Starting the Upgrade Assistant

This topic describes how to run the Oracle Fusion Middleware Upgrade Assistant. You can run the Upgrade Assistant either in the Graphical User Interface (GUI) mode or in the response file mode.

You can use the optional command-line interface arguments, documented in this topic, to upgrade your Oracle Fusion Middleware components to the latest version. In addition, a response file can be generated to automate some of the upgrade tasks.

This topic contains the following sections:

A.1 Starting the Upgrade Assistant in Graphical User Interface (GUI) Mode

The Upgrade Assistant is used to upgrade schemas, component configurations and standalone system components.

Oracle recommends that you successfully complete the upgrade of schemas and component configurations for a single domain before beginning the upgrade of another domain.

Note:

The Upgrade Assistant should be run by a non-SYSDBA user whenever possible. The steps to create a user who has the privileges required to upgrade the schemas are described in Creating a Non-SYSDBA User.
To start the Upgrade Assistant:
  1. On UNIX operating systems:: change directory to ORACLE_HOME/oracle_common/upgrade/bin.

    On Windows operating systems: change directory to ORACLE_HOME\oracle_common\upgrade\bin.

  2. Enter the following command to start the Upgrade Assistant:

    On UNIX operating systems:

    ./ua

    On Windows operating systems:

    ua.bat

    You can also launch the Upgrade Assistant with logging parameters as shown in the UNIX example below:

    ./ua [-logLevel <log_level] [-logDir <log_directory>]

    Logging level. Select one of the following:
    • TRACE

    • NOTIFICATION

    • WARNING

    • ERROR

    • INCIDENT_ERROR

    The default logging level is NOTIFICATION.

    Note:

    When troubleshooting, consider setting the -logLevel to TRACE so that more information will be logged. If additional information is not needed, change the logLevel as the Upgrade Assistant's log files can become very large when -logLevel TRACE is used.

A.1.1 Starting the Upgrade Assistant with Additional Parameters (Optional)

Table A-1 lists the command-line parameters you can use while running the Upgrade Assistant in the GUI mode. The following example shows the usage of these parameters on your respective operating system:

On UNIX operating systems:

Change directory to ORACLE_HOME/oracle_common/upgrade/bin

Enter the command: ./ua -help

On Windows operating systems:

Change directory to ORACLE_HOME\oracle_common\upgrade\bin

Enter the command: ua.bat -help

Note:

If you get an Xlib error when starting the Oracle Upgrade Assistant such as "Failed to connect to server", "Connection refused by server", or "Can't open display", then you must set the DISPLAY environment variable and restart the Upgrade Assistant as described in Setting the DISPLAY Environment Variable.

Table A-1 Upgrade Assistant GUI Command Line Parameters

Parameter Required or Optional Parameter? Description

-logLevel

Optional.

Logging level. Select one of the following:

  • TRACE

  • NOTIFICATION

  • WARNING

  • ERROR

  • INCIDENT_ERROR

The default logging level is NOTIFICATION.

Note:

When troubleshooting, consider setting the -logLevel to TRACE so that more information will be logged. If additional information is not needed, change the logLevel as the Upgrade Assistant's log files can become very large when -logLevel TRACE is used.

Note:

TRACE messages are not included in the Upgrade Assistant Log File Viewer. To view TRACE messages you must use another tool.

-logDir

Optional.

Note:

If you have installed the Upgrade Assistant in a read-only directory, you must specify this parameter to ensure the log directory is writable. If the log directory is read-only, the Upgrade Assistant will fail.

Change the default location of upgrade log files and temporary files. You must specify an existing, writable directory where Upgrade Assistant will create log files and temporary files.

On UNIX operating systems, the default locations are:

ORACLE_HOME/oracle_common/upgrade/logs
ORACLE_HOME/oracle_common/upgrade/temp

On Windows operating systems, the default locations are:

ORACLE_HOME\oracle_common\upgrade\logs
ORACLE_HOME\oracle_common\upgrade\temp

-threads

Optional

Identify the number of threads available for concurrent schema upgrades or readiness checks of the schemas.

The value must be a positive integer in the range 1 to 8. Default is 4 threads.

-readiness

Required for Readiness Check

Performs the upgrade readiness check without performing any actual examines or upgrades.

Schemas and configuration are checked.

Note:

-readiness option may not appear on the command line with -examine option.

For more information, see Performing the Readiness Check

-help

Optional.

Prints all the command-line options to the console.

A.2 Starting the Upgrade Assistant in Response File Mode

Silent or “hands free” upgrades can be performed using a response file. The response file can only be created after you have provided the information in the Upgrade Assistant screens.

The following topics describe how you can upgrade the supported Oracle Fusion Middleware components using a response file. The response file collects all the information that you have entered through the Upgrade Assistant's graphical user interface screens, and performs exactly the same function that the Upgrade Assistant wizard performs.

Note:

You must run the Upgrade Assistant in GUI mode first to generate the response file that will be used to complete your silent upgrade.

A.2.1 Creating an Upgrade Response File

The Save Response File option on the Upgrade Summary screen creates a file that uses the information you have already provided in the Upgrade Assistant screens. The response file enables you to use the saved information instead of manually entering data through the Upgrade Assistant wizard screens.

Once you select the Save Response File option, you will be prompted for a name and location where you want to create this response file. After it is created, you can use it exactly as-is to replicate the upgrade options on other systems, or modify it as needed.

For more information, see Using the Response File to Upgrade Fusion Middleware.

A.2.2 Using the Response File to Upgrade Fusion Middleware

To perform upgrades using a response file from the command-line interface (CLI), use the following command:

On Unix operating systems:

Change directory to ORACLE_HOME/oracle_common/upgrade/bin

Execute the following:

./ua -response <response_file> [-examine] [-logLevel <log_level>] [-logDir <log_directory>] [-threads <number>]

On Windows operating systems:

Change directory to ORACLE_HOME\oracle_common\upgrade\bin

Execute the following:

ua.bat -response <response_file> [-examine] [-logLevel <log_level>] [-logDir <log_directory>] [-threads <number>]

Table A-2 Upgrade Assistant Response File Mode Command Line Parameters

Parameter Required or Optional Parameter? Description

-readiness

Required for Readiness Check

Performs the upgrade readiness check without performing any actual examines or upgrades.

Schemas and configuration are checked.

Note:

Do not specify this parameter if you have specified the -examine parameter.

For more information, see Performing the Readiness Check

-threads

Optional

Identify the number of threads available for concurrent schema upgrades or readiness checks of the schemas.

The value must be a positive integer in the range 1 to 8. Default is 4 threads.

-response

Required.

File containing inputs required to perform an upgrade. This file can be generated from inputs entered when the Upgrade Assistant is run in graphical mode.

-examine

Optional.

If this option is present, Upgrade Assistant performs the examine phase but DOES NOT perform any actual upgrades.

Note:

Do not specify this parameter if you have specified the -readiness parameter.

-logLevel

Optional.

Logging level. Select one of the following:

  • TRACE

  • NOTIFICATION

  • WARNING

  • ERROR

  • INCIDENT_ERROR

The default logging level is NOTIFICATION.

Note:

Consider setting the -logLevel to TRACE so that more information will be logged. This will be useful when troubleshooting a failed upgrade. The Upgrade Assistant's log files can become very large if -logLevel TRACE is used.

-logDir

Optional.

Change the default location of upgrade log files and temporary files. You must specify an existing, writable directory where Upgrade Assistant will create log files and temporary files.

On UNIX operating systems, the default locations are:

ORACLE_HOME/oracle_common/upgrade/logs
ORACLE_HOME/oracle_common/upgrade/temp

On Windows operating systems, the default locations are:

ORACLE_HOME\oracle_common\upgrade\logs
ORACLE_HOME\oracle_common\upgrade\temp

-help

Optional.

View all of the command line options.

A.3 Setting the DISPLAY Environment Variable

When running Upgrade Assistant in GUI mode, you must set the DISPLAY variable properly or you may receive errors such as:

Xlib: connection to ":1.0" refused by server

Xlib: No protocol specified

Cause: These errors indicate that the DISPLAY variable is not set up properly to allow a GUI to be displayed to the screen.

Action: Set the DISPLAY environment variable to the system name or IP address of your local workstation, and re-run Upgrade Assistant.

If you continue to receive these errors after setting the DISPLAY variable, try launching another GUI tool, such as vncconfig. If you see the same errors, your DISPLAY environment variable may not be set correctly.