Skip Headers
Oracle® Universal Installer and OPatch User's Guide
11g Release 2 (11.2) for Windows and UNIX

Part Number E12255-09
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

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:

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 Oracle Clusterware 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. This option does not support relative paths, so you need to specify the absolute 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 session variable 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 session variable 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 the ORACLE_HOME session variable 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

Enables 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.

-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_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_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 enable 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 enable 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 enable 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.