responsefile.txt

responsefile.txt

This topic describes the response file for performing a silent installation of the Web server plug-ins for WAS.
Install the product silently using an options response file.
The responsefile.txt file has directives that set installation options. Comments in the file describe how to set the string value for each directive.
Use the options file to run the Plug-ins installation wizard in silent mode, which is referred to as installing silently. The wizard reads the options file to determine responses and does not display the graphical user interface. Use the following command to use a copy of the options file named myresponsefile.txt for a silent installation:
install -options "myresponsefile.txt" -silent
Location of the response file

The sample options response file is named responsefile.txt. The file is in the plugin directory on the product disc or in the downloaded installation image.

Mode of use

The Plug-ins installation wizard can read an existing options response file and run silently without displaying the graphical user interface.

Installing silently

The options file supplies the values to the Plug-ins installation wizard when installing silently. The wizard reads the options file to determine responses and does not display the graphical user interface. Use the following command to use a copy of the options file named myresponsefile.txt for a silent installation:
install -options "myresponsefile.txt" -silent
Creating an operational environment
The installation of the plug-ins is a three-step process:

Installing the binary plug-in modules for supported Web servers

Configure the Web servers to use the binary module to communicate with the appserver

Creating a Web server definition in the appserver
As you install an application, you can install it on the Web server definition in addition to the appserver. All applications on the Web server definition are listed in its plug-in configuration file. After propagation, the real Web server can access the applications.

The sample options response file, responsefile.txt, controls installing the binary plug-ins, configuring the Web server, and creates a script for creating the Web server definition on a remote appserver machine. The script is customized according to values supplied in the responsefile.txt file. The script is generated to run on the appserver machine to create the Web server definition.
If the Web server is on the same machine as a stand-alone appserver, the responsefile.txt file can create the Web server definition directly without creating a script. To edit and use the response file for installing the plug-ins and configuring the Web server and appserver, perform the following procedure:
Copy the responsefile.txt file from the plugins directory on the product disc to a place that you can identify on your machine.

Edit the file to customize the values for your installation.

Save the file.
Start the installation. For example:
install -options /tmp/plugins/myresponsefile.txt -silent
On non-Windows operating systems, silent installations run in a synchronous process. The process does not return until the silent installation finishes. For a silent installation to run synchronously on Windows, issue the first of the following commands:

Synchronous processing: START /WAIT install.exe -options "C:\temp\myresponsefile.txt" -silent

Asynchronous processing: install -options "C:\temp\plugins\myresponsefile.txt" -silent
After the installation, examine the logs for success.
Logging

If no installation logs exist, refer to temporary log file, log.txt in your <userhome>/plglogs directory. You can also cause ISMP to record status about a problem that is preventing the installation from occurring, as described in the following section.
For example, if you start the silent installation without accepting the license in the -OPT silentInstallLicenseAcceptance="false" directive, the installation does not occur. The fact that the license entry was not accepted is recorded in log.txt in the <userhome>/plglogs directory. If all validations pass, the installation occurs. Then, the Plug-ins installation wizard records installation events in the following log files. The log files are in the plugins_root/logs/install directory:

log.txt

Records all of the ISMP events that occur during the installation. The log also describes whether the installation was local or remote. Messages at the end of the file indicate whether manual configuration steps are required to complete the installation. Key elements to look for in the installation record are:

Manual steps warning

When the wizard requires you to run a script to create the Web server definition, the wizard refers to the fact that manual steps are required.
If manual steps are required, the name and location of the script that run are written in the log file at the end of the installation record.

Web server type

The log has a record of the Web server type, such as IHS for the IBM HTTP Server, for example.

Location of the plug-in configuration file

The log has a record of the plugin-cfg.xml file location currently in the Web server configuration.

installconfig.log

Lists all of the configuration events that occur during the installation.

installGSKit.log

Lists events that occur during the installation of the GSKit code.
The command line for the installation is listed when the installation occurs. The GSKit 7 installation record is written after the GSKIT 7 : entry in the log.
The GSKit 4 installation record is written after the GSKIT 4: entry in the log.

installWeb_server_typePlugin.log

Records events that occur during the installation of a Web server plug-in. The name of the file varies to reflect the Web server:

installAPACHEPlugin.log

installIHSPlugin.log

installIISPlugin.log

installSunOnePlugin.log

installDomino5Plugin.log

installDomino6Plugin.log

installDomino7Plugin.log

Each log lists the following critical information:

The plug-in binary module that is currently installed

The current location of the plug-in configuration file that is configured for the Web server

configure_Web_server_type_webserver.log

Lists events that occur during the configuration of a Web server plug-in. The name of the file varies to reflect the Web server:

configure_APACHE_webserver.log

configure_IHS_webserver.log

configure_IIS_webserver.log

configure_SUNJAVASYSTEM_webserver.log

configure_DOMINO_webserver.log

The configureWeb_server_type_webserver.log file reports the actions that the Plug-ins installation wizard performs as it updates the Web server configuration file.
In a remote scenario, this log is not present because run the script to create the Web server definition manually.
In a federated scenario, the script is created and this log is not present.

Information that ISMP can log when it cannot start the Plug-ins installation wizard
Certain events can prevent the installer from starting the installation wizard. Such an event is not enough disc space to launch the installation wizard, for example. If your installation fails and there is no information in the installation logs, use the -log parameter to record entries for events that cause the installer program to fail to start the installation wizard. The syntax of the install command for logging such events is:
install  -options fully_qualified_options_response_file_name               
         -silent
         -log # !fully_qualified_log_file_name  @ALL 
install -options "/usr/IBM/WAS/silentFiles/myresponsefile.txt" 
        -silent -log # !/usr/IBM/WAS/myOptionFiles/log.txt  @ALL
install -options "/opt/IBM/WAS/silentFiles/myresponsefile.txt" 
        -silent -log # !/opt/IBM/WAS/myOptionFiles/log.txt  @ALL
install.exe -options "C:\IBM\WebSphere\silentFiles\myresponsefile.txt" 
            -silent -log # !C:\IBM\WebSphere\silentFiles\log.txt  @ALL
Verify or troubleshoot the installation if the plugins_root/logs/install/log.txt file does not contain a record of any problems, but problems exist.
If the error happens early in the installation, look for the logs in the system temporary directory. The installation program copies the logs from the system temporary directory to the logs directory at the end of the installation.
See Troubleshooting installation and Installation component troubleshooting tips for more information.

Usage notes

The file is not a read-only file.

Edit this file directly with your flat file editor of choice, such as WordPad on a Windows platform.

The file is updated when you specify the -options parameter when using the Plug-ins installation wizard.

The file must exist to perform a silent installation. The installation program reads this file to determine installation option values when you install silently. Provide the fully qualified file path.

Save the file in a location that you can identify when you specify the fully qualified path as part of the installation command.

Example responsefile.txt file

Edit the version of the file that ships with your WebSphere Application Server product. The following example is not guaranteed to be an accurate representation of the file that ships with the product.
################################################################################
# 
# A common use of an options file is to run the wizard in silent mode. This lets
# the options file author specify wizard settings without having to run the
# wizard in graphical or console mode. To use this options file for silent mode
# execution, use the following command line arguments when running the wizard:
# 
#   install -options "responsefile.txt" -silent
#
################################################################################ 
#
 Synchronous Silent Installs
# ---------------------------------
# On non-Windows operating systems, silent installs will execute in a synchronous process. 
# The process will not return until the silent install has completed.
#
# For the silent install to run synchronously on Windows,  run the 
# executable in the following way:
#
#    START /WAIT  install.exe -options "response_local.txt" -silent
#
#
################################################################################

################################################################################
#
# TROUBLE SHOOTING TIP
#
# If no signs of an install are visible, reference the log file (waslogs/log.txt)
# in the user's temporary directory for signs of cause.
# 

################################################################################ 
#
 Default Web server Plugins install locations
# ---------------------------------------- 
#
#  Below are the default install locations for each supported operating system.
# 
#  AIX:  "/usr/IBM/WAS/Plugins"
#
#  HP-UX, Linux, and Solaris: "/opt/IBM/WAS/Plugins"
#
#  Windows: "C:\Program Files\IBM\WebSphere\Plugins"
#
# 
 On unix operating systems, spaces in the install location is not supported.
################################################################################ 

###################################################################################
#
# Allow non-root/non-admin install
#
# Valid Options  : true   Allows install for non-root/non-admin users.
#      false  Disallows install for non-root/non-admin users. Install will not occur.  
#
# If no install occurs, this will be logged to a log file (waslogs/log.txt) 
# in the user's temporary directory.
#
# By changing this value in this response file to "true", you will allow the 
# install to continue
# for non-root/non-admin users. 
# 
#

-OPT allowNonRootSilentInstall="false"


###################################################################################
#
# License Acceptance
#
# Valid Options  : true   Accepts the license. Will install the product.
#      false  Declines the license. Install will not occur.  
#
# If no install occurs, this will be logged to a temporary log file (
# temporaryPluginInstallLog.txt) in the user's temporary directory.
#
# By changing this value in this response file to "true", you agree that you 
# have reviewed and agree to the terms of the IBM International Program License 
# Agreement accompanying this program, which is located at CD_ROOT\plugins\lafiles.
# If you do not agree to these terms, do not change the value or otherwise download, 
# install, copy, access, or use the program and promptly return the program and proof 
# of entitlement to the party from whom you acquired it to obtain a refund of the
# amount you paid.
#
# 

-OPT silentInstallLicenseAcceptance="false"

################################################################################
# Operating System Prerequisite Checking
#
# To disable operating system prerequisite checking, uncomment
# the following line. This will notify the installer that you are disabling
# operating system prerequisite checking.
#
-OPT disableOSPrereqChecking="true"

################################################################################
#
# install Type
#
# Valid Options : local   WAS and Web server on same machine
#                 remote  WebSphere Applicaiton Server and Web server on seperate machines.
#

-OPT installType="local"


################################################################################
#
# pluginDestination
#
# Web server Plugins for IBM WAS V6.1 install location
#

-OPT installLocation="C:\Program Files\IBM\WebSphere\Plugins"


################################################################################
#
# WAS V6.1 Existing Location
#
# Valid Options : Existing WAS V6.1 install home directory.
#
# Note   : This option is valid for local install type.
#         The install will use the directory entered below.  
#

-OPT wasExistingLocation="C:\Program Files\IBM\WebSphere\AppServer"


################################################################################
#
# Web server to configure
#
# Valid options  
#    : none          Install binaries only.  No Web server configuration.
#    : ihs           IBM HTTP Server V6 or V6.1
#    : apache        Apache Web Server V2
#    : domino5       Lotus Domino Web Server V5 (supported on HP-UX)
#    : domino6       Lotus Domino Web Server V6 or V6.5 (not supported on HP-UX)
#    : sunone        Sun ONE Web Server 6.0 or Sun Java System Web Server V6.1    
#    : iis5          Microsoft Internet Information Services V5 (supported on Windows)
#    : iis6          Microsoft Internet Information Services V6 (supported on Windows)
#
# Note   : Specify only one Web server to configure.
#

-OPT webServerSelected="domino6"


################################################################################
#
# IHS-specific Administrator settings
#
################################################################################
#
# HTTP Administration Port number #
# Specify the HTTP Administration Port number (only specify value when configuring IHS)
#

-OPT ihsAdminPort=""


################################################################################
#
# IHS Administrator User ID for IHS Administration server
#
# Specify the IHS Administrator server userid. (only specify value when configuring IHS)
#

-OPT ihsAdminUserID=""



################################################################################
#
# Web server Configuration File 1
#
# Valid options for Web server configuration file 1 
#
#    ihs     : httpd.conf 
#    apache           : httpd.conf
#    domino5   : Notes.jar
#    domino6   : Notes.jar
#    sunone    : obj.conf
#
#  Note  : File must exist    
#

-OPT webServerConfigFile1="C:\Program Files\IBM HTTP Server\conf\httpd.conf"


################################################################################
#
# Web server Configuration File 2
#
# Valid options for Web server configuration file 2
#
#    domino5 : names.nsf
#    domino6 : names.nsf
#    sunone  : magnus.conf
#    
# Note  : File must exist
#

-OPT webServerConfigFile2=""


################################################################################
#
# Web server port number #
# Specify the Web server port for the Web server selected to be configured.
#

-OPT webServerPortNumber="80"


################################################################################
#
# Domino 6 User ID
#
# Specify the Domino 6 User ID. (only specify value when configuring Domino 6 on
# Linux, Solaris, and AIX platforms)
#
# Note : Domino 6 is supported on Windows, but this value is not required on Windows.
#

-OPT domino6UserID="notes"


################################################################################
#
# Web server Definition Name
#
# A web server definition allows for Web server administration through the WebSphere 
# admin console.  
#
#  Note : No spaces are allowed in the Web server definition name.
#

-OPT webServerDefinition="webserver1"


################################################################################
#
# plugin-cfg.xml File Location  
#
# This file will be generated by the plugin installer.  
#
# Valid options:  
#  ""        : leaving the string empty will result in installer generating the plugin-cfg.xml #          file location at install time and configuring Web server to use this location.
#          This is the recommended option.
#
#  "<file_location>" : User may enter an existing file location.  Web server will be 
#          configured to use this existing plugin-cfg.xml file location.
#          If file is specified, it must exist, otherwise install will not proceed.
#

-OPT pluginCfgXmlLocation=""


################################################################################
#
# WAS Machine HostName
#
# remote install type   : enter the hostname of the WAS machine.
# local install type   : hostname of machine being installed to will be used.
#

-OPT wasMachineHostName=""


################################################################################
#
#  Advanced User Options available in silent installs only
#  
#  Map all the existing deployed applications to the Web server.
#
#  Valid Options 
#      true   :  Web server Definition is mapped as a target to the existing deployed applications 
#               such as snoop and hitcount (Recommended)
#      false  :  No applications are mapped to the Web server definition.
#
#  Note : If not set to a valid option of true or false, the installer will set to true 
# and continue install.
# 

-OPT mapWebserverToApplications="true"


################################################################################
#
#  Web server Hostname
#
#  In advanced scenarios where a user has multiple Web server hostnames on a machine, 
#  set the entry below to the Web server hostname used to configure.
#
#  Valid Options :
#        ""      :  Install will resolve to hostname detected on machine (Recommended)      
#      "<HOSTNAME>"  :  Where <HOSTNAME> is a Web server hostname on the machine.
#

-OPT webServerHostName=""


################################################################################
#
# WAS Profile Name
#
# Name of the WAS Profile to be configured. This option is only valid
# in local install scenarios.
#
# Valid options:  
#  "<WAS_profile_name>"  : User must enter the name of an existing WAS profile
#                               leaving the string empty will result in the installer
#                               using the default profile #                               example.  profileName="AppSrv01"
#

-OPT profileName=""
Reference topic