install command

The install command installs the product and most of the components in the product. When you install the product, the installer program installs the core product files and creates zero, one, or two profiles, depending on the product that you are installing and your installation selections. A silent parameter runs the Installation wizard in silent mode without displaying the graphical user interface.

Purpose

This topic describes the command-line syntax for the install command. Start the install command module from the command line to install the product.

Before you begin installing the product

Prepare the operating system for installation. Follow the procedure in Task overview: Installing to get started.

The command file resides in the root directory of the component on the product disk.

In an effort to simplify your task environment, WebSphere® Application Server has adopted a common installation engine for WebSphere software components in the product package. The install command starts the installation program in almost all components in the product package:
  • [AIX] [HP-UX] [Linux] [Solaris] ./install
  • [Windows] install.exe
Avoid trouble: If you use uniform naming conventions (UNC) to identify file paths in your install command, the items you anticipate installing may not all be installed after the command runs. To guard against this possibility, you should first map the file path to a drive, then run the install command against that mapped drive. This will ensure that all the items are installed.gotcha

Parameters and syntax

This section describes the command that starts the Installation wizard.
  • Issue the install command to start the Installation wizard and display the graphical user interface:
    component_disc_directory/install
    
  • Issue the install -silent command to start the Installation wizard in silent mode, without the graphical user interface:
    component_disc_directory/install -options "response_file_name" -silent

Use the following install command options to install a new installation, add a feature to an existing installation, upgrade a trial or the Express product, or configure an existing WebSphere Application Server product by creating a profile.

Table 1. Install command options.

Use the following table to determine valid values for each option.

Option Name (-OPT) WebSphere Application Server
Values Default
allowNonRootSilentInstall "true | false" Commented
disableOSPrereqChecking "true | false" Commented
disableNonBlockingPrereqChecking "true | false" Commented
checkFilePermissions "true | false" Commented
feature "noFeature | samplesSelected | languagepack.console.all | languagepack.server.all" "samplesSelected"
installLocation Any valid directory path app_server_root directories for root and non-root installers
installType "installNew | addFeature | upgrade" "installNew"
profileType "standAlone | none" "standAlone"
silentInstallLicenseAcceptance "true | false" "false"
traceFormat ALL | text | XML Commented
traceLevel OFF | SEVERE | WARNING | INFO | CONFIG | FINE | FINER | FINEST Commented
PROF_adminUserName Any valid user ID Empty string
PROF_adminPassword Any valid user password Empty string
PROF_cellName A string with valid characters Commented
PROF_defaultPorts Commented | Uncommented Commented
PROF_enableAdminSecurity "true | false" "true"
PROF_hostName Any valid host name Commented
PROF_isDefault Commented | Uncommented Commented
PROF_nodeName Any valid and unique node name Commented
PROF_omitAction Name of a configuration action Commented
PROF_portsFile Any valid file path to a valid ports file Commented
PROF_profileName Any valid profile name string Commented
PROF_profilePath Any valid file path. See the description of profile_root in Directory conventions for default values. Commented
PROF_serverName Any application server name, such as server1 Commented
PROF_startingPort Any valid port number Commented
PROF_validatePorts Commented | Uncommented Commented
PROF_webServerCheck "true | false" Commented
PROF_webServerHostname A valid host name of the system with the Web server Commented
PROF_webServerInstallPath Any valid directory path to the Web server Commented
PROF_webServerName A valid name of a valid Web server Commented
PROF_webServerOS linux | windows | aix | hp | solaris | os390 | i5os Commented
PROF_webServerPluginPath Any valid directory path to the Web server plug-ins Commented
PROF_webServerPort A valid port to access the Web server Commented
PROF_webServerType IHS | IIS | SUNJAVASYSTEM | DOMINO | APACHE | HTTPSERVER_ZOS Commented
PROF_winserviceAccountType specified user | localsystem Commented
PROF_winserviceCheck "true | false" Commented
PROF_winserviceStartupType manual | automatic | disabled Commented
PROF_winservicePassword The password of the valid specified user Commented
PROF_winserviceUserName The name of the valid specified user Commented

See the following descriptions for more information about each option.

Option descriptions

Use the following information to learn the purpose of an option and to determine which options to use for profile creation.
allowNonRootSilentInstall
Change this option to "true" to allow a non-root or non-administrator installer ID to install the product. A "true" value indicates that you accept the limitations associated with installing as a non-root user. If the value is "false", a non-root user cannot install the product.

See Non-root installations for more information.

feature
Change the selection state of the features.
Valid values are:
samplesSelected
Installs the sample applications.
noFeature
Indicates that no features are selected for installation.
languagepack.console.all
Installs all language packs for the administrative console.
languagepack.server.all
Installs all language packs for the runtime environment.
installLocation

Change the installation location of the product. Specify any valid directory.

[Windows] Enclose directory names with spaces in double-quotes.

The default values vary per operating system. Separate default locations exist for non-administrator or non-root installer IDs. See the description of app_server_root directories for root and non-root installers in Directory conventions.

installType

Change the installType option to control the type of installation. The default is to install a new copy of WebSphere Application Server. Each operation type requires a separate invocation of the install command.

Valid values include:
installNew
This default value installs a new copy of the core product files.
addFeature
Adds features to an existing installation in an incremental installation.

Each WebSphere Application Server product has several features including sample applications, language packs for the administrative console, and language packs for the run time.

To install a new feature, set installType to addFeature.
upgrade
Upgrade a trial edition to a licensed version. Or upgrade the Express product to the base WebSphere Application Server product.
profileType
Indicate the type of profile to create.
Valid values include:
  • Application server

    Create a standalone application server profile.

  • Management

    For a base application server topology an administrative agent is provided.

    For a Network Deployment topology the deployment manager is provided for tightly coupled management, or a job manager is provided for a more loosely coupled management of multiple base application servers.

  • Cell

    Create a cell with two profiles: a deployment manager and an application server node that is already federated into the deployment manager cell.

  • Custom

    Create a profile with an empty node. You must federate this node to use it.

  • None

    Do not create a profile at this time. However, you will have to manually create a profile after installation in order for the product to be functional.

  • Secure proxy

    Create a secure proxy server to take requests from the internet and forward them to application servers. The secure proxy server resides in the DMZ.

silentInstallLicenseAcceptance
By changing the silentInstallLicenseAcceptance property in a silent response file to "true", you agree that you have reviewed and agree to the terms of the IBM® International Program License Agreement accompanying the program, which is located in the mount point or disc_drive/WAS/lafiles directory.

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.

traceFormat
Control the trace file output.
traceLevel
Control the amount of trace information collected.
PROF_adminPassword
Select the password for the administrative user ID.

Set the PROF_enableAdminSecurity option to true to use this option.

PROF_adminUserName
Select the administrative user ID.

Set the PROF_enableAdminSecurity option to true to use this option.

Important: Write down the user name and password. You cannot log onto the administrative console without it. You cannot use WebSphere Application Server at all unless you know the ID and password.
PROF_cellName
Specify a unique cell name for the profile.

The cell name must be unique within the WebSphere Application Server environment.

Even though you might plan to federate a standalone application server at some time, specify a unique cell name for the profile that is not the cell name of the deployment manager.

PROF_defaultPorts
Uncomment the option to use the default WebSphere Application Server port settings.

Do not use this parameter with the PROF_portsFile option or the PROF_startingPort option.

PROF_enableAdminSecurity
Choose whether to enable administrative security during the installation process.

Set the installLocation option to your existing installation root directory.

Set the profileType option.

Set other appropriate profile options (PROF_ options) for your type of profile.

If profileType="custom" or profileType="none", set this option to false.

Valid values are:
true
Administrative security is enabled. You must specify a user name and a password.
Important: Write down the user name and password. You cannot log onto the administrative console without it. You cannot use WebSphere Application Server at all unless you know the ID and password.
false
Administrative security is not enabled.
PROF_hostName
Specify the host name of the machine where the profile is to reside.

The host name is the domain name system (DNS) name (short or long) or the IP address of this computer.

PROF_isDefault
Set a default profile.

The default profile is the default target for commands issued against an anonymous profile, such as commands issued from the app_server_root/bin directory.

Issuing a command from the bin directory of another profile sets the command window to address the other profile, and not the default profile. Opening a new command window targets anonymous commands to the default profile again.

PROF_nodeName
Specify a unique node name for the profile.

The node name must be unique within the WebSphere Application Server environment.

PROF_omitAction
Omit the specified configuration action.
PROF_portsFile
Specify the path to a property file containing the desired port values.

Valid values are a valid file path default WebSphere Application Server port settings.

Do not use this parameter with the PROF_defaultPorts option or the PROF_startingPort option.

PROF_profileName
Set the profile name.

Specify the name of the profile. The profile name must be unique for this WebSphere Application Server installation or for the cell to which it might belong at some time.

Valid values are a string with valid characters.

PROF_profilePath
Specify the fully qualified file path to the profile_root directory.

Specify a valid directory to contain the files that define the run-time profile environment, such as commands, configuration files, and log files.

[Windows] If the directory contains spaces, enclose the path in double-quotes.

Valid values are a valid directory path.

PROF_serverName
Specify the server name for the standalone application server profile, for the deployment manager, or for the federated application server that is part of the cell profile.

Each standalone application server profile or each federated application server profile can have a server named server1, for example. Server names have to be unique within a profile, but not within a cell or within an installation.

PROF_startingPort
Specify the starting port number for generating all ports for the profile. If not specified, the profile uses default ports specified in the serverindex.xml file.

Do not use this parameter with the PROF_portsFile option.

PROF_validatePorts
Uncomment the option to validate that no conflicts exist within the selected ports.
PROF_webServerCheck
Specify whether you wish to define a Web server definition.
PROF_webServerHostname
Specify the host name of the system with the Web server.

Requires the PROF_webServerCheck option.

PROF_webServerInstallPath
Specify the local or remote installation path of the Web server.

Requires the PROF_webServerCheck option.

PROF_webServerName
Specify the name of the Web server.

Requires the PROF_webServerCheck option.

PROF_webServerOS
Specify the operating system of the system where the Web server runs.

Requires the PROF_webServerCheck option.

PROF_webServerPluginPath
Specify the path to the Web server plug-in for the Web server.

Requires the PROF_webServerCheck option.

PROF_webServerPort
Specify the access port of the Web server, such as port 80.

Requires the PROF_webServerCheck option.

PROF_webServerType
Specify the type of web server.

Requires the PROF_webServerCheck option.

PROF_winserviceAccountType
Specify the type of windows service to create.

Requires the PROF_winserviceCheck option.

PROF_winserviceCheck
Choose whether to run the server process as a Windows® service.
PROF_winserviceStartupType
Specify the start up method for the windows service.

Requires the PROF_winserviceCheck option.

PROF_winservicePassword
Specify the password for the windows service.

Requires the PROF_winserviceCheck option.

PROF_winserviceUserName
Specify the user name for the windows service.

Requires the PROF_winserviceCheck option.

Example

Install WebSphere Application Server with the Installation wizard user interface
install

See Installing the product and additional software for more information about installing with the Installation wizard.

Install WebSphere Application Server from the command line
install -options /tmp/was/my_response_file.txt -silent
Install WebSphere Application Server from the command line without the user interface
install -options /tmp/was/my_response_file.txt 
The command installs the product with these particulars:
Response file location
/tmp/was/my_response_file.txt
Root installation
-OPT allowNonRootSilentInstall="false"
Install features
-OPT feature="samplesSelected"
Installation root directory
-OPT installLocation="app_server_root"
Install a new installation of the product
-OPT installType="installNew"
Type of profile created during installation
-OPT profileType="standAlone"
Accept IBM licensing agreement
-OPT silentInstallLicenseAcceptance="true"
Specify a cell name
-OPT PROF_cellName="my_cell1"
Use the default ports for the standalone application server
-OPT PROF_defaultPorts=
Specify the host name (IP address in this case)
-OPT PROF_hostName="5.55.555.555"
Identify the file path for profiles
-OPT PROF_profilePath="profile_root"
Name the application server
-OPT PROF_serverName="my_server1"
Let the installer program assign non-conflicting ports
-OPT PROF_validatePorts=
Install a Web server definition
-OPT PROF_webServerCheck="true"
Identify the location of the Web server and the plug-ins

-OPT PROF_webServerHostname="5.55.555.555"
-OPT PROF_webServerInstallPath="Web_server_root"
-OPT PROF_webServerName="my_ihs_web_server1"
-OPT PROF_webServerOS="linux"
-OPT PROF_webServerPluginPath="plugins_root"
-OPT PROF_webServerPort="80"
-OPT PROF_webServerType="IHS"

Content of /tmp/was/my_response_file.txt

-OPT allowNonRootSilentInstall="false"
-OPT feature="samplesSelected"
-OPT installLocation="app_server_root"
-OPT installType="installNew"
-OPT profileType="standAlone"
-OPT silentInstallLicenseAcceptance="true"
-OPT traceFormat=ALL
-OPT traceLevel=INFO
-OPT PROF_cellName="exp_cell1"
-OPT PROF_defaultPorts=            
-OPT PROF_hostName="5.55.555.555"  
-OPT PROF_isDefault=              
-OPT PROF_nodeName="node1_node"  
-OPT PROF_profileName="my_default"  
-OPT PROF_profilePath="profile_root"
-OPT PROF_serverName="my_server1"
-OPT PROF_validatePorts=            
-OPT PROF_webServerCheck="true"
-OPT PROF_webServerHostname="5.55.555.555"
-OPT PROF_webServerInstallPath="Web_server_root"
-OPT PROF_webServerName="my_ihs_web_server1"
-OPT PROF_webServerOS="linux"
-OPT PROF_webServerPluginPath="plugins_root"
-OPT PROF_webServerPort="80"
-OPT PROF_webServerType="IHS"

See Installing silently for more information about using the installation wizard in silent mode, without the graphical user interface.

Logging

Examine the app_server_root/logs/install/log.txt file to verify that there were no file system or other unusual errors while installing. If there are problems, correct them, and reinstall the product.

WebSphere Application Server uses return codes to indicate the results of an installation operation:
0
Success
1
Failed
2
Partial success
3
Reserved
4
License not accepted
5
PrereqCheck failed
6
Upgrade not supported

Return codes are in use in the following components on the following operating systems.

Table 2. Return code applicability.

Use the following table to determine the applicability of return codes.

Operating System WebSphere Application Server Application Client IBM HTTP Server Web Server Plug-ins Edge Components Update Installer (UPDI)
AIX®, HP-UX, Linux®, and Solaris Yes Yes Yes Yes Yes Yes

[Windows] ISMP does not set exit codes on Windows due to a limitation. Consult the install log to determine success or failure.

Partial success means that some portion of the installation failed but the installation is still at least partially usable. The failure is recoverable. Once recovered, the installation is completely usable. Consult the log to determine the exact failure and what, if any, corrective action can be taken.




Related concepts
Non-root installations
Related tasks
Installing silently
Installing the product and additional software
Related reference
vpd.properties file
Related information
Operating system registry keys
Reference topic    

Terms of Use | Feedback

Last updated: Oct 21, 2010 12:05:26 PM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=compass&product=was-base-dist&topic=rins_install
File name: rins_install.html