B Using Scripts or Response Files to Create Oracle Real Application Clusters Databases

This appendix describes the steps for noninteractive installations during which you can create Oracle Real Application Clusters (Oracle RAC) databases using scripts.

Note:

The scripts generated by Database Configuration Assistant (DBCA) are for reference only. Oracle strongly recommends that you use DBCA to create a database.

See Also:

Oracle Universal Installer and OPatch User's Guide for Windows and UNIX for detailed information about generating scripts

This appendix contains the following topics:

B.1 Using DBCA to Generate Installation Scripts for Oracle RAC

To generate scripts to create an Oracle RAC database, create a database using the generated scripts, and prepare the database for use, complete the following steps:

  1. Start DBCA and select your preferred options to build the Oracle RAC database.

    On the Creation Options page of your DBCA session, deselect Create Database and select Generate Database Creation Scripts before you click Finish. You can accept the default destination directory for the scripts, or browse for a different location. In either case, you should note the path name for use in the next step.

    See Also:

    Chapter 3, "Creating Oracle RAC Databases with DBCA" for additional information about running a DBCA session
  2. Go to the directory where DBCA created the scripts, and review the SQL scripts to ensure that they contain the statements to build a database with the characteristics you require. If they do not, then Oracle recommends that you rerun DBCA to create scripts with the desired configuration rather than editing the scripts yourself.

  3. On each cluster node you identified during your DBCA session, run the script sid.bat, where sid is the SID prefix that you entered on the DBCA Database Name page.

  4. Set the initialization parameter, cluster_database, to the value TRUE in your SPFILE by entering an ALTER SYSTEM statement in SQL*Plus, or by uncommenting the parameter in the PFILE for each instance.

  5. Configure Oracle Net Services to support your new database and instances as described in Chapter 6, "Understanding the Oracle Real Application Clusters Installed Configuration".

  6. Set the REMOTE_LISTENER parameter to the SCAN (using the Easy Connect Naming syntax scanname:scanport) in your SPFILE by entering an ALTER SYSTEM statement in SQL*Plus, or by uncommenting the parameter in the PFILE for each instance.

  7. Run the Server Control Utility (SRVCTL) to configure and start database and instance applications as described in Oracle Real Application Clusters Administration and Deployment Guide.

    See Also:

    Oracle Universal Installer and OPatch User's Guide for Windows and UNIX for additional information about creating and using scripts to install Oracle software with OUI

B.2 About DBCA Noninteractive (Silent) Configuration for Oracle RAC

You can perform a noninteractive, or silent configuration of Oracle RAC using DBCA. To perform a silent configuration, you must have completed an Oracle Grid Infrastructure (Oracle Clusterware and Oracle Automatic Storage Management (Oracle ASM)) installation.

You can use DBCA to create a database from templates supplied by Oracle, or from templates that you create. The templates contain settings optimized for a particular type of workload.

Oracle provides templates for the following two workload types:

  • General purpose or transaction processing

  • Data warehouse

For more complex environments, you can select the Custom Database option. This option does not use templates and results in a more extensive installation interview, which means that it takes longer to create your database.

B.3 DBCA Commands for Noninteractive (Silent) Configuration of Oracle RAC

You can use the following command syntax to create an Oracle RAC database using the general purpose template, placing the data files in an existing Oracle ASM disk group. Nodes node1 and node2 are the cluster nodes on which Oracle RAC database instances are created. The disk group name is +ASMgrp1. An Oracle Home User was specified for this installation, and is indicated with the -serviceUserPassword option:

%ORACLE_HOME%\bin\dbca -silent -createDatabase -templateName General_Purpose.dbc
-gdbName %DBNAME% -sid %ORACLE_SID% -sysPassword -systemPassword 
-sysmanPassword -dbsnmpPassword  -serviceUserPassword 
-emConfiguration LOCAL -storageType ASM -diskGroupName +ASMgrp1 
-datafileJarLocation %ORACLE_HOME%\assistants\dbca\templates 
-nodeinfo node1,node2 -characterset WE8MSWIN1252
-obfuscatedPasswords false -sampleSchema false -asmSysPassword 

After you run this command, if you did not include the passwords as values in the above command, then DBCA prompts you for the passwords for the SYS, SYSTEM, SYSMAN, DBSNMP, Oracle Home (or Oracle Service) and SYSASM users, for example:

Enter SYS user password:
password
Enter SYSTEM user password:
password
...

See Also:

Oracle Database Administrator's Guide for a complete description of the dbca commands and options

B.4 Understanding How Response Files are Used During Installation

When you start OUI, you can use a response file to automate the installation and configuration of Oracle software, either fully or partially. OUI uses the values contained in the response file to provide answers to some or all installation prompts.

Typically, the installer runs in interactive mode, which means that it prompts you to provide information in graphical user interface (GUI) screens. When you use response files to provide this information, you run the installer from a command prompt using either of the following modes:

  • Silent

    If you include responses for all of the prompts in the response file and specify the -silent option when starting the installer, then it runs in silent mode. During a silent mode installation, the installer does not display any screens. Instead, it displays progress information in the terminal that you used to start it.

  • Response file

    If you include responses for some or all of the prompts in the response file and omit the -silent option, then the installer runs in response file mode. During a response file mode installation, the installer displays all the screens, screens for which you specified information in the response file, and also screens for which you did not specify the required information in the response file.

You define the settings for a silent or response file installation by entering values for the variables listed in the response file. For example, to specify the Oracle home name, supply the appropriate value for the ORACLE_HOME_NAME variable:

ORACLE_HOME_NAME="OraDBHome1"

Another way of specifying the response file variable settings is to pass them as command-line arguments when you run the installer. For example:

 -silent "ORACLE_HOME_NAME=OraDBHome1" ...

Enclose the variable name and its value in double quotation marks.

See Also:

Oracle Universal Installer and OPatch User's Guide for Windows and UNIX for more information about response files

B.4.1 Deciding to Use Silent Mode or Response File Mode

The following table provides reasons for running the installer in silent mode or response file mode:

Mode Reasons to Use
Silent Use silent mode for the following installations:
  • To complete an unattended installation, which you schedule using operating system utilities

  • To complete several similar installations on multiple systems without user interaction

OUI displays progress information on the terminal that you used to start it, but it does not display any of the installer screens.

Response file Use response file mode to complete similar Oracle software installations on more than one system, providing default answers to some, but not all the OUI prompts.

If you do not specify information required for a particular OUI screen in the response file, then OUI displays that screen. OUI suppresses screens for which you have provided all of the required information.


B.4.2 Creating a Database Using Oracle ASM for Database Files in Silent Mode

Before you create a database that uses Oracle ASM, you must run the root.bat script. For this reason, you cannot create a database using Oracle ASM as the storage option for database files during a silent-mode installation. Instead, you can complete a software-only installation using silent-mode, and then run the Oracle Net Configuration Assistant and DBCA in silent mode after you have completed the software-only installation and you have run the root.bat script.

Note:

This limitation applies only to databases that use Oracle Automatic Storage Management as the storage option for database files. You can create a database that uses the file system option during a silent-mode installation.

B.4.3 General Procedure for Using Response Files

Use the following general steps for installing and configuring Oracle products using the installer in silent or response file mode:

Note:

You must complete all required preinstallation tasks on a system before running the installer in silent or response file mode.
  1. Verify the Windows Registry key HKEY_LOCAL_MACHINE\Software\Oracle exists and that the value for inst_loc is the location of the Oracle Inventory directory on the local node.

    To install Oracle RAC, you must first have installed Oracle Grid Infrastructure on your cluster nodes. The Oracle Inventory directory was created and added to the Windows registry during the installation of Oracle Grid Infrastructure. If the inst_loc key does not exist in the Windows registry, then install Oracle Grid Infrastructure for a cluster before continuing.

    Note:

    Changing the value for inst_loc in the Windows registry is not supported after the installation of Oracle software.
  2. Prepare a response file.

  3. Run OUI in silent or response file mode.

  4. If you completed a software-only installation, then run Oracle Net Configuration Assistant (NETCA) and DBCA in silent or response file mode.

The following sections describe these steps.

B.5 Preparing Response Files

The following sections describe methods you can use to prepare response files for silent mode or response file mode installations:

B.5.1 Editing a Response File Template

Oracle provides response file templates for each product and installation type and for each configuration tool. For Oracle Database, these files are located in the database\response directory on the installation media or in the Oracle_home\inventory\response directory after the software has been installed.

Note:

If you copied the installation media to a directory on a local disk (referred to as the staging_dir directory), then the response files are located in the directory staging_dir\database\response.

Table B-1 lists the response files provided with the Oracle RAC software.

Table B-1 Response Files for Oracle Database

Response File Used For

db_install.rsp

Silent installation of Oracle Real Application Clusters

dbca.rsp

Silent creation and configuration of an Oracle database using DBCA

netca.rsp

Silent configuration of Oracle Net using NETCA


Caution:

When you modify a response file template and save a file for use, the response file may contain plain text passwords. Oracle strongly recommends that database administrators or other administrators delete or secure the response files when they are not in use.

To copy and modify a response file:

  1. Copy the response file from the response file directory to a directory on your system.

    If you have copied the installation media to a hard drive, then you can edit the file in the staging_dir\database\response directory.

  2. Open the response file in a text editor.

    During installation, you can specify sensitive information, such as passwords, at the command line rather than within the response file. The section Section B.4, "Understanding How Response Files are Used During Installation" explains this method.

    See Also:

    Oracle Universal Installer and OPatch User's Guide for Windows and UNIX for detailed information about creating response files
  3. Follow the instructions in the file to edit it.

    Note:

    OUI or the configuration assistants fail if you do not correctly configure the response file.
  4. Secure the response file.

    Ensure that only the user that installed the Oracle software can view or modify response files. Consider deleting the modified response file after the installation succeeds.

    Note:

    A fully specified response file for an Oracle Database installation contains the passwords for database administrative accounts and for a user who is a member of the operating system groups ORA_DBA and Administrators.

B.5.2 Recording Response Files

You can use OUI in interactive mode to record response files, which you can then edit and use to complete silent mode or response file mode installations. This method is useful for Advanced or software-only installations.

You can save all the installation steps into a response file during installation by clicking Save Response File on the Summary page. You can use the generated response file for a silent installation later.

When you record the response file, you can either complete the installation, or you can exit from OUI on the Summary page, before OUI starts to copy the software to the local disk.

If you use record mode during a response file mode installation, then OUI records the variable values that were specified in the original source response file into the new response file.

Note:

You cannot save passwords while recording the response file.

To record a response file:

  1. Complete preinstallation tasks as for a standard installation.

    When you use OUI to record a response file, it checks the system to verify that it meets the requirements to install the software. For this reason, Oracle recommends that you complete all of the required preinstallation tasks and record the response file while completing an installation.

  2. Ensure that the Oracle Installation User has permissions to create or write to the Oracle home path that you will specify when you run the installer.

  3. On each installation screen, specify the required information.

  4. When OUI displays the Summary screen, perform the following steps:

    1. Click Save Response File. In the pop up window, specify a file name and location for the new response file. Click Save to write the settings you have entered to the file.

    2. Click Finish to continue with the installation.

      Click Cancel if you do not want to continue with the installation. The installation stops, but the recorded response file is retained.

  5. If you do not complete the installation, then delete the Oracle home directory that the installer created using the path you specified in the Specify File Locations screen.

  6. Before you use the saved response file on another system, edit the file and make any required changes. Use the instructions in the file as a guide when editing it.

B.6 Running Oracle Universal Installer Using a Response File

Now, you are ready to run OUI at the command line, specifying the response file you created, to install the Oracle Database software. The OUI executable file, setup.exe, provides several options.

B.6.1 Viewing the Help Information for OUI

For information about all the available options for OUI, run the setup.exe command with the -help option. For example, if the installation software is accessed through a DVD disk drive mounted as E:, then you would use the following commands:

C:\> E:
E:\> database\setup.exe -help

If the installation software has been extracted from a downloaded ZIP file to the directory X:\staging_dir, where X: is a drive on your system, then you would use the following command:

C:\> X:
X:\> staging_dir\database\setup.exe -help

The help information appears in your session window after a brief delay.

B.6.2 Running OUI Using a Response File for Input

To use OUI with a response file to install the Oracle Database software, complete the following steps:

  1. Complete the preinstallation tasks as for a typical installation.

  2. Log in as the Oracle Installation User.

  3. Start OUI in silent or response file mode by entering a command similar to the following:

    X:\staging_dir> database\setup.exe  [-silent] [-noconfig] \
     -responseFile responsefilename
    

    Note:

    Do not specify a relative path to the response file. If you specify a relative path, then OUI fails. Use the full path location for the response file.

    In this example:

    • X:staging_dir is either the location of the installation media (for example, a DVD drive) or the path of staging directory on the local node.

    • -silent runs OUI in silent mode.

    • -noconfig suppresses running the configuration assistants during installation, and a software-only installation is performed instead.

    • responsefilename is the full path and file name of the installation response file that you configured previously. See Section B.5.1, "Editing a Response File Template."

B.7 Postinstallation Configuration Using Response Files

The following sections explain how to create and run a response file configuration after installing Oracle software. The topics in this section are:

B.7.1 About the Postinstallation Configuration File

When you perform an installation using silent mode or response file mode, you provide information about your servers in a response file that you otherwise provide manually using a graphical user interface. However, the response file does not contain passwords for user accounts that configuration assistants require after software installation is complete. To run the configuration assistants after the installation completes in silent mode, you must provide the passwords used by the assistants in a password file.

The configuration assistants are started with a script called configToolAllCommands. You can run this script in silent mode by using a password response file. The script uses the passwords in the file to run the configuration tools in succession to complete the software configuration. If you keep the password file to use when cloning installations, then Oracle strongly recommends that you store the password file in a secure location.

You can also use the password file to restart a failed installation. If you stop an installation to fix an error, then you can rerun the configuration assistants using configToolAllCommands and a password response file.

The configToolAllCommands password response file has the following options:

  • internal_component_name is the name of the component that the configuration assistant configures.

  • variable_name is the name of the configuration file variable.

  • value is the desired value to use for configuration.

The command syntax is as follows:

internal_component_name|variable_name=value

For example, to set the password for the SYS user of Oracle ASM:

oracle.assistants.asm|S_ASMPASSWORD=myPassWord

Oracle Database configuration assistants require the SYS, SYSTEM, and DBSNMP passwords for use with DBCA. You might need to specify the following additional passwords, depending on your system configuration:

  • If the database is using Oracle ASM for storage, then you must specify a password for the S_ASMSNMPPASSWORD variable. If you are not using Oracle ASM, then leave the value for this password variable blank.

  • If you selected to configure Oracle Enterprise Manager, then you must set the value of the S_HOSTUSERPASSWORD variable to the password of the Oracle software installation owner. If you do not want to enable Oracle Enterprise Manager, then the leave the value for this password variable blank.

  • If you create a multitenant container database (CDB) with one or more pluggable databases (PDBs), then you must specify a password for the ORACLE.INSTALL.DB.CONFIG.STARTERDB.PASSWORD.PDBADMIN variable.

  • If you specified an Oracle Home user for the Oracle Database installation, then specify a password for the oracle.assistants.server|S_WINSERVICEUSERPASSWORD variable.

B.7.2 Creating a Password Response File

To create a password response file to use with the configuration assistants, perform the following steps:

  1. Create a response file that has a name of the format filename.properties.

  2. Open the file with a text editor, and cut and paste the sample password file contents, as shown in Example B-1, modifying as needed.

  3. If the file is stored on a volume formatted for Windows New Technology File System (NTFS), then modify the security permissions to secure the file.

Example B-1 Sample Password Response File for Oracle RAC Databases

This example provides a template for a password response file to use with the database configuration assistants.

oracle.assistants.server|S_SYSPASSWORD=password
oracle.assistants.server|S_SYSTEMPASSWORD=password
oracle.assistants.server|S_DBSNMPPASSWORD=password
oracle.assistants.server|S_PDBADMINPASSWORD=password
oracle.assistants.server|S_EMADMINPASSWORD=password
oracle.assistants.server|S_ASMSNMPPASSWORD=password
oracle.assistants.server|S_WINSERVICEUSERPASSWORD=password

If you do not want to enable access for Oracle Enterprise Manager or Oracle ASM, then leave those password fields blank.

B.7.3 Performing Postinstallation Configuration Using a Response File

To run configuration assistants with the configToolAllCommands script in silent mode or response file mode, perform the following steps:

  1. Change directory to %ORACLE_HOME%\cfgtoollogs.

  2. Run the configuration script using the following syntax:

    configToolAllCommands RESPONSE_FILE=\path\name.properties
    

    Example B-2 Running Configuration Assistants in Response File Mode

    Assume you created a password response file in the C:\users\oracle\db directory with a name of cfg_db.properties. To run the configuration assistants in response file mode to configure the Oracle software after installation, enter commands similar to the following:

    C:\> cd %ORACLE_HOME%\cfgtoollogs
    C:\..\cfgtoollogs> configToolAllCommands RESPONSE_FILE=C:\users\oracle\db\cfg
    _db.properties
    

B.8 Running Configuration Assistants Using Response Files

You can run configuration assistants in response file to configure and start Oracle software after it is installed on your system. To run configuration assistants in response file mode, you must first copy and edit a response file template.

Note:

If you copied the software to a hard disk, then the response file template is located in the directory X:\staging_dir\database\response

This section contains the following topics:

B.8.1 Silent Mode of Database Configuration Assistant

Use the -silent flag in combination with the -responseFile flag to set the mode to silent. In the silent mode, Database Configuration Assistant uses values that you specify, in the response file or as command-line options, to create a database. No window or user interface is displayed in the silent mode.

B.8.2 Progress Only Mode of Database Configuration Assistant

Use the -progressOnly flag in combination with the -responseFile flag, to set the mode to progress only. As it configures and starts the database, Database Configuration Assistant displays a window that contains status messages and a progress bar. This window is similar to the window that is displayed when you choose to create a preconfigured database during an Enterprise Edition, Standard Edition, or Standard Edition 2 (SE2) installation.

In this mode, Database Configuration Assistant uses values that you specify, in the response file or as command line options, to create a database.

B.8.3 Running Database Configuration Assistant in Response File Mode

You can run Database Configuration Assistant (DBCA) in response file mode, either in silent mode or progress only mode, to configure and start an Oracle database on the system. To run Database Configuration Assistant in response file mode, you must copy and edit a response file template.

To run DBCA in response file mode, you must use the -responseFile flag in combination with either the -silent or -progressOnly flag:

  1. Oracle provides a response file template named dbca.rsp in the response directory on the installation media. Copy the dbca.rsp response file template from the response file directory to a directory on your system.

    If you have copied the software to a hard drive, then you can edit the file in the X:\staging_dir\database\response directory if you prefer.

    Note:

    As an alternative to editing the response file template, you can also create a database by specifying all required information as command-line options when you run DBCA. For information about the list of options supported, enter the following command:
    C:\> %ORACLE_HOME%\bin\dbca -help
    
  2. Log in as the Oracle Home user. Set the %ORACLE_HOME% environment variable to the correct Oracle home directory. See Section 6.5, "Working with Multiple Oracle Home Directories on Windows."

  3. Open the response file in a text editor.

  4. Edit the file, following the instructions in the file.

    In response file mode, DBCA uses values that you specify in the response file or as command-line options, to create a database.

    Note:

    DBCA fails if you do not correctly configure the response file.
  5. Open a command-line window. Change directories to the location of the Oracle home directory.

  6. Use a command similar to the following example to run DBCA in silent or response file mode using a response file:

    C:\> %ORACLE_HOME%\bin\dbca {-progressOnly | -silent} -responseFile \
    local_dir\dbca.rsp
    

    In this example:

    • The -silent option runs DBCA in silent mode, suppressing user prompts.

    • The -progressOnly option runs DBCA in response file mode.

    • local_dir is the full path of the directory where the dbca.rsp response file is located.

    As DBCA configures and starts the database, it displays a window that contains status messages and a progress bar. The window that DBCA displays is the same window that is displayed when you choose to create a preconfigured database during an Oracle Database Enterprise Edition, Standard Edition, or Standard Edition 2 (SE2) installation.

    See Also:

B.8.4 Running Oracle Net Configuration Assistant Using Response Files

You can run Oracle Net Configuration Assistant (NETCA) in silent mode to configure and start an Oracle Net listener on the system, configure naming methods, and configure Oracle Net service names. To run NETCA in silent mode, you must copy and edit a response file template. Oracle provides a response file template named netca.rsp in the response subdirectory of:

  • The Oracle_home\inventory\response directory after a software-only installation

  • The database\response directory on the installation media or staging area

To run NETCA using a response file:

  1. Copy the netca.rsp response file template from the response file directory on the installation media to a directory on your system.

    If the software is staged on a hard drive, or has already been installed, then you can edit the file in the response directory located on the local disk instead.

  2. Open the response file in a text editor.

  3. Follow the instructions in the file to edit it.

    Note:

    NETCA fails if you do not correctly configure the response file.
  4. Log in as the Oracle Home user. Set the %ORACLE_HOME% environment variable to the correct Oracle home directory. See Section 6.5, "Working with Multiple Oracle Home Directories on Windows."

  5. Enter a command similar to the following to run NETCA in silent mode:

    C:\> Oracle_home\bin\netca -silent -responsefile X:\local_dir\netca.rsp
    

    In this command:

    • The -silent option runs NETCA in silent mode.

    • X:\local_dir is the full path of the directory where you copied the netca.rsp response file template.