Reference
Command Line Parameters
The OUI supports the command line parameters described in Table 1-1:
Table 1-1. Installation Command Line Parameters
Parameter |
Purpose |
Additional Comments |
---|---|---|
-silent |
Instructs the installer to run a silent install. |
When this parameter is specified, the -responseFile parameter must also be provided. |
-reponseFile <filename> |
Tells the installer which response file to use. |
The response filename should be fully qualified. |
-nowelcome |
Disables the installer's opening splash screen. |
Redundant when used with the -silent qualifier. |
-record |
Tells the installer to record a new response file during the session. |
When this parameter is specified, you must also use the -destinationFile parameter. |
-destinationFile |
Tells the installer where to write a recorded install session. |
Useful only with the -record parameter. |
session_variable_name=<value> |
Sets a session variable. |
Overrides the value set in the response file, if any. |
<component_name>_ |
Sets a component-specific variable. |
Overrides the value set in the response file, if any. |
Response Files
Oracle ships with sample response files. These response files are different for Oracle 9i and Oracle 10g. Table 1-2 lists the sample response files for Oracle 10g, and Table 1-3 lists the sample response files for Oracle 9i:
Table 1-2. Oracle 10g Sample Response Files
Oracle 10g Response File |
Purpose |
---|---|
oracle.client.Administrator.rsp clientadmin.rsp |
Installs client-only version of Oracle, including all administrative tools. |
oracle.client.Custom.rsp clientcustom.rsp |
Custom file for client-only installs. Must be edited extensively before use. |
oracle.client.Runtime.rsp runtime.rsp |
Runtime-only installation of Oracle client. Generally used only for "embedded" installations. |
oracle.server.Custom.rsp custom.rsp |
Custom file for server installs. Must be edited extensively before use. |
oracle.server.EE.rsp enterprise.rsp |
Full Enterprise Edition (EE) installation. Needs minor edits before use. |
oracle.server.PE.rsp |
Full Personal Edition (PE) installation. Needs minor edits before use. |
oracle.server.SE.rsp |
Full Standard Edition (SE) installation. Needs minor edits before use. |
dbca.rsp |
Runs the Database Creation Assistant (DBCA) to create a database non-interactively. Requires an associated database template, and needs extensive editing before use. |
netca.rsp |
Runs the Network Configuration Assistant non-interactively. Needs minor edits before use. |
Table 1-3. Oracle 9i Sample Response Files
Oracle 9i Response File |
Purpose |
---|---|
clientadmin.rsp |
Installs client-only version of Oracle, including all administrative tools. |
clientcustom.rsp |
Custom file for client-only installs. Must be edited extensively before use. |
clientruntime.rsp |
Runtime-only installation of Oracle client. Generally used only for "embedded" installations. |
custom.rsp |
Custom file for server installs. Must be edited extensively before use. |
enterprise.rsp |
Full enterprise edition installation. Needs minor edits before use. |
standard.rsp |
Full standard edition installation. Needs minor edits before use. |
dbca.rsp |
Runs the Database Creation Assistant to create a database non-interactively. Requires an associated database template, and needs extensive editing before use. |
netca.rsp |
Runs the Network Configuration Assistant (NetCA) non-interactively. Needs minor edits before use. |
emca.rsp |
Runs the Enterprise Manager Configuration Assistant non-interactively. Needs minor edits before use. |
omicustom.rsp |
Runs the Oracle Management and Integration Configuration Assistant non-interactively. Needs minor edits before use. |
oid.rsp |
Runs the Oracle Internet Directory Configuration Assistant non-interactively. Needs minor edits before use. |
Syntax
OUI response files are plain text files. Installer settings are specified as name/value pairs, in the following form:
<name> = [ <recommended> : ] <value>
<name> is always a single string, with no spaces, and is case-insensitive.
The <recommended> portion is a literal, which if present, must be either DEFAULT or FORCED followed by a colon. If DEFAULT is specified, the value will be presented as a changeable default during a non-silent installation. A FORCED value may not be changed by the user. If unspecified, the DEFAULT setting is assumed.
<value> can be a number, Boolean, string, or string list. The different value types are represented as shown in Table 1-4:
Table 1-4. Value Types Supported by OUI Response Files
Type |
Example |
---|---|
Number |
99 |
Boolean |
TRUE |
String |
"Sample string" |
String List |
{ "string1", "string2" } |
Note that Boolean values are completely case-insensitive.
In Oracle 9i, the response file is organized in sections, similar to old-style Windows ".ini" files. Each section has a specific set of allowable keywords and values. The sections are shown in Table 1-5:
Table 1-5. Oracle 9i Response File Sections
Section Name |
Purpose |
---|---|
General |
Contains the version number of the response file. |
Include |
Allows you to include other response files with the current one. |
Session |
Lists values specific to the various dialogs of the OUI. |
Components |
Lists component-specific variables. |
For Oracle 10g, the section concept has been eliminated entirely. Name/value pairs, which would have appeared in the general and session sections of an Oracle 9i response file, can now appear anywhere in the response file, in any order. At the time of this writing, there does not appear to be any way to include other files within an Oracle 10g response file. Items that would have appeared in an older version's components section now have the component name appended to the beginning, with a colon separating the component name and the rest of the name/value construct. For example:
oracle.networking.netca:OPTIONAL_CONFIG_TOOLS={"netca"}
The same setting in Oracle 9i would look like:
[oracle.networking.netca_9.2.0.1.0] OPTIONAL_CONFIG_TOOLS={"netca"}
A response file can also contain comments. A comment is any line that begins with the # character. The supported syntax for OUI response files, by section, is shown in Table 1-6:
Table 1-6. Supported Syntax, by Section
Name |
Value Type |
Description |
---|---|---|
[General] Section |
||
RESPONSEFILE_VERSION |
String |
Response file version number. As of this writing, the correct value for 10g is 2.2.1.0.0, and the correct value for 9i is 1.7.0. |
[Include] Section |
||
FILEn |
String |
An arbitrary number of files can be included by appending a unique number to the end of each FILE directive and specifying a fully qualified filename as its value. |
[Session] Section | ||
FROM_LOCATION |
String |
Indicates the source from which the product(s) will be installed. The string provided should be the fully qualified filename of the products.jar file on Disk 1 of the installation. |
FROM_LOCATION_CD_LABEL |
String |
When installing directly from CD in a multi-CD session, this value indicates the label for which the installer should look when the CD is changed. |
LOCATION_FOR_DISK2 LOCATION_FOR_DISK3 |
String |
If installing from disk, or if all CDs are mounted concurrently, these variables tell the installer where to find the second, third, etc. disks. If not specified, the installer will automatically attempt to find successive disks in "../../Diskn," relative to FROM_LOCATION. |
NEXT_SESSION |
Boolean |
Instructs the installer to offer (non-silent) or attempt (silent) another install session immediately after the current one. |
NEXT_SESSION_ON_FAIL |
Boolean |
If the current install fails for any reason, the installer will not attempt or allow another install if this value is set to FALSE. |
NEXT_SESSION_RESPONSE |
String |
Fully qualified filename of another response file. If NEXT_SESSION and/or NEXT_SESSION_ON_FAIL are TRUE, the installer will automatically move to this response file when the current one is complete. |
ORACLE_HOME |
String |
Location to which the software should be installed. |
ORACLE_HOME_NAME |
String |
This variable is only important on Windows at the current time. It gives a name that identifies the ORACLE_HOME named above. If the home location already exists, then both the designated home directory and name must match. |
APPL_TOP |
String |
If installing Oracle applications, this designates the installation home directory. |
APPL_TOP_NAME |
String |
Analogous to ORACLE_HOME_NAME, this value names the APPL_TOP directory. |
SHOW_COMPONENT_LOCATIONS SHOW_CUSTOM_TREE_PAGE SHOW_END_SESSION_PAGE SHOW_EXIT_CONFIRMATION SHOW_INSTALL_PROGRESS_PAGE SHOW_OPTIONAL_CONFIG_TOOL_PAGE SHOW_REQUIRED_CONFIG_TOOL_PAGE SHOW_ROOTSH_CONFIRMATION SHOW_SPLASH_SCREEN SHOW_SUMMARY_PAGE SHOW_WELCOME_PAGE SHOW_RELEASE_NOTES SHOW_DEINSTALL_CONFIRMATION SHOW_DEINSTALL_PROGRESS SHOW_CONFIG_TOOL_PAGE (10g) SHOW_CUSTOM_TREE_PAGE (10g) |
Boolean |
Tells the installer if it should display the indicated page during an interactive (non-silent) installation. |
TOPLEVEL_COMPONENT |
String List |
This is a required variable that specifies the name and version of the main component to be installed. |
UNIX_GROUP_NAME |
String |
UNIX group name to be used for the inventory directory. Used during a first-time install only. |
DEINSTALL_LIST |
String List |
Contains names and versions of any components to be uninstalled prior to new software installation. |
[component] Section |
||
DEPENDENCY_LIST |
String List |
A list of names and versions of other components on which the current component depends. |
PROD_HOME |
String |
Location to which the current component should be installed. Most components must be installed inside ORACLE_HOME. |
OPTIONAL_CONFIG_TOOLS |
String List |
Specifies a list of optional configuration tools to be launched by the installer. |
INSTALL_TYPE |
String |
This variable must be present for the top level component(s) whenever there is more than one install type available. |
COMPONENT_LANGUAGES |
String List |
When more than one language set is available, this variable indicates which language to install. |
Component-specific variables |
Varies |
Many individual components have specific variables that can (or must) be set in the response file. |
A complete list of component-specific variables is not provided here since they change, sometimes radically, with each release of the OUI. An exhaustive list can be found in the install directories. On Disk 1, in the stage directory, there are a number of ".jar" files. At the very least, there should be an install1.jar, but there may be more (install2.jar, etc.) files.
To look inside the jar files, you'll need to have a Java development kit (JDK) installed. Any JDK version should work, but Java runtime environments (JRE), will usually not include the jar command. Once you have a JDK, you can use the following command to extract the files:
jar xvf <jar filename>
The above command will extract everything from the jar file, creating a hierarchy of files in the current directory. Once that's done, you can explore the directories to find the "identifiers.xml" files. Every component that has some sort of settable variable will have one of these files. You can tell what component each one is for by the directory in which it is stored. Inside the file, you'll see, toward the end of the file, lines somewhat like the ones below:
<VAR NAME="s_dlgEMEmailAddress" DESC_ID="s_dlgEMEmailAddress_DESC" TYPE="String" EXP="T" SEC="F" CLONE="T" CALC="T" VALDN="T" GEN_RES="T"> <ASSOC_DEP NAME="oracle.sysman.agent" VERSION="4.1.0.0.0" PLATS="{453,173,467,295,87,610,198,918,162,2,111,90,168,888,913,30,46,211,197, 110,912,615,50}" ASSOC="EMD_EMAIL_ADDRESS"> </ASSOC_DEP> <ASSOC_DEP NAME="oracle.sysman.console.db" VERSION="10.1.0.1.0" PLATS="{453,173,467,295,87,610,198,918,162,2,111,90,168,888,913,30,46,211,197, 110,912,208,615,50,601}" ASSOC="s_emailAddress"> </ASSOC_DEP> </VAR>
This is a description of a single variable for the sysman.server component, since the file from which it was taken was in that directory. The variable's name is "s_dlgEMEmailAddress", it's a string variable, and a description of its purpose can be found by searching for "s_dlgEMEmailAddress_DESC" in the same file. If there is no description present, it is probably be a derived variable, not settable by the user.
Oraparam.ini
The oraparam.ini file contains initialization settings for the OUI. These settings will very rarely need to be changed from their defaults, but a description of all documented parameters is included in Table 1-7 for the sake of completeness:
Table 1-7. Oraparam.ini Supported Parameters
Parameter |
Description |
---|---|
DISTRIBUTION |
Set to TRUE if the oraparam.ini is on read-only media, such as a CD-ROM or the Web. |
SOURCE |
Path to the default products.jar file to be used for this installation. The path can be relative to the directory in which oraparams.ini is stored. |
LICENSE_LOCATION |
This parameter is not set by default. If used, it should point to a text file containing a license agreement to which the user must agree before proceeding with installation. When set, the license page will be presented after the initial welcome screen. |
LICENSE_TITLE |
Sets the title to be displayed when the license agreement, specified above, is presented. |
JRE_LOCATION |
Path to the base directory of the JRE to be used for this install. This path can be relative to the directory in which the oraparam.ini is located. |
OUI_LOCATION |
Path to the OUI files. |
JRE_MEMORY_OPTIONS |
Memory settings parameter, passed to the JRE. This can be used to increase or decrease the amount of memory allocated to the installer. |
DEFAULT_HOME_LOCATION |
Default location for ORACLE_HOME. |
DEFAULT_HOME_NAME |
Default name for ORACLE_HOME. |
NO_BROWSE |
List of directories to which the installer will refuse to browse. This would generally be used to exclude extremely large directories or network-mounted directories. |
NLS_ENABLED |
If set to TRUE, national language support will be enabled in the OUI. If set to FALSE, the installer will display all prompts in English, even if the system's base language is set to something other than English. |
BOOTSTRAP |
If set to TRUE, the installer will use a temporary directory to make a copy of itself and the JRE it needs before proceeding with the install. This will allow it to stop using the files on the installation media, thus allowing CDs to be changed. This variable must be set to TRUE for multi-CD installations. If the files are copied to a staging directory before installation, setting this variable to FALSE will slightly improve the speed of installation. |
BOOTSTRAP_SIZE |
This variable is used to indicate the size required for the bootstrap directory. Before installation begins, the OUI will check to make sure that at least this much space is available in the target staging directory. |
OUI_VERSION |
Sets the expected version of the OUI. This number must match exactly or the installer will exit. |
USE_BUILD_NUMBER |
If set to TRUE, the OUI will consider both the version number and build number when determining if it should overwrite an existing OUI installation. |
APPLTOP_STAGE |
When set to TRUE, the OUI will prompt the user to define an APPL_TOP directory. |