Using Console Mode to Install

Edit online

Start the Installer on a Mac OS X, UNIX, or Linux System

Edit online
  1. Log on to the machine as the installation user you created earlier.
  2. Download the bin file for the IBM webMethods Installer from Passport Advantage Online.
    Note: If you want to transfer the bin file to another machine using FTP, use the binary file transfer mode\type. If you use another mode\type, the bin file might become corrupted.
  3. Shut down all non-IBM applications that are running on the machine on which you are going to install. If these applications are not shut down, product files might become corrupted.
  4. If you are going to install new products into an existing IBM installation directory (that contains products from the same release):
    • Shut down running products in that directory so the installer can update key files that are locked by the operating system. For instructions, see the product documentation.
    • Check whether a file named afterInstallAsRootLog.txt exists in the IBM installation directory. If it does, execute the Software AG_directory/bin/beforeInstallAsRoot script.

  5. Run the command below. The bin file is a self-extracting archive that extracts its content into the machine's temporary directory. 

    sh IBM_webMethods_Install_operating_system.bin
    Important: IBM webMethods Installer can be forced in console mode when the -console parameter is specified in the command line.

    You might receive Java messages when you start the installer. For example, you might receive warning messages about system preferences, or about unlocking connections. You can ignore these messages.

    If your temporary directory contains thousands of files, the startup process might take one minute or longer. The installer will display Initializing system resources during this time. If you want to speed up this process, delete the files in your temporary folder.

    To change the temporary directory for IBM webMethods Installer and the bin file extract location, set the following environment variable before running the bin file: 
    TMPDIR=<temporary-directory>
export TMPDIR
    To reuse the extracted content of the bin file, specify the following before running the bin file: 
    SAGINSTALLERDIR=/path/to/installer
export SAGINSTALLERDIR
    To specify custom Java options, set the following environment variable before running the bin file: 
    SAG_JAVA_OPTIONS=<custom-options>
export SAG_JAVA_OPTIONS

    As you move through the installer wizard, the installer stores some of the files it requires in the default temporary directory. If you cancel the installer and later restart it on the same machine, the installer will use the stored files rather than downloading them from the installer server again, to improve performance.

    After installation concludes successfully, the installer will delete the bin file content and the stored files in the default temporary directory.

  6. The user file-creation mode mask (umask) can affect the file permissions for newly created files and directories. Make sure the umask you are using for installation will not prevent users from accessing and executing these files.

Use a Proxy Server

Edit online

You can use SSL to connect to the IBM webMethods Installer server.

If your company connects to the Internet through an HTTP or Socks proxy server, you must use that proxy server to install.

If the installer can connect to the IBM webMethods Installer server without going through a proxy server, it displays a message to that effect. You can choose to continue, have the installer auto-detect your proxy servers so you can select one to use, or manually supply the settings for an HTTP or Socks proxy server.

If the installer cannot connect to the IBM webMethods Installer server without going through a proxy server but detects a proxy server, it displays a message to that effect. You can take the same actions as above.

If the installer cannot connect to the IBM webMethods Installer server without going through a proxy server and does not detect a proxy server, consult your network administrator. You will not be able to continue installation until the issue is resolved.

You can also use an NTLM proxy with IBM webMethods Installer. An NTLM proxy is a transparent proxy for Windows systems that retrieves the credentials of the currently logged user. When you use Installer and only specify the proxy host and port, the connection might fail. You have to specify the username and password of a valid user in the DOMAIN\username format.

Choose Release

Edit online

Choose the product release that includes the products you want to install. The installer downloads the list of your products.

Specify the Installation Directory

Edit online

Specify the installation directory in which to install your IBM products.

Note: If you want to use a symlink for the installation directory, you must use the symlink every time you install into the directory. For example, you cannot install some products using a directory name and then later create a symlink and use it to install more products into the same directory, or vice versa.
When you install using any method, the installer auto-detects a host name or IP address for the machine on which you are running the installer. You might need to change that value, as follows:
  • If the machine has multiple host names or IP addresses, the value detected by the installer might not be the one you want to use. For example, the installer might have detected an IP address that is only accessible from inside your organization’s network. If you want the products to be accessible from outside your organization, replace the auto-detected value with an externally accessible host name or IP address.
  • If you are installing in the cloud, the installer detects the internal IP address of the cloud instance. If you want your products to be accessible from outside the cloud instance (for example, from another cloud instance running other products), replace the auto-detected value with an externally accessible host name or IP address.
If you are creating a script, the installer stores the auto-detected or changed value in the script. When you install from the script, the installer will use the stored value.
Note: Some third-party applications used by IBM runtime products have limitations regarding spaces in the installation directory. IBM therefore recommends installing in a directory that does not include spaces. However, if you are installing on a Windows system, you can install some IBM design-time products in a directory under Program Files; the installer indicates which products.

Select Products to Install

Edit online

The installer lists the products that are supported on the target operating system.

Important: The installer does not distinguish among flavors of an operating system. Make sure you install products only on the supported flavors listed in the products’ system requirements

The highest level of the product tree shows product names and releases, while the lower levels show the items that make up or are related to the product. If you have already installed an item in the specified installation directory, the item name is preceded by the letter I within brackets (that is, [I]).

The installer can display only a limited number of lines in the tree at a time. To page forward through the tree, enter a plus sign (+). To page backward through the tree, enter a minus sign (-). To search for a specific product or item, enter S, then enter the name of the product or item. Enter S again to find the next occurrence of the product or item.

You can select products using the methods below in any combination. The installer puts an X in the tree next to selected products and items.

  • Select typical development installations from the Typical Installations list by entering the appropriate numbers. The installer automatically selects the products that make up those installations.
    Note: You might not see the selections until you page forward through the tree.
  • Select individual products in the tree by entering the numbers next to the product headings. Enter each number on a separate line. If a selected product requires other products on the same machine, the installer does the following:
    • If you are installing from Passport Advantage Online, the installer automatically selects the required products.
      Note: If you later unselect products, the installer does not automatically unselect the required products. To clear all automatically selected required products, clear all selections on the tree and make your product selections again.
    • If you are creating an image, the installer lists the required products and asks whether to download them into the image. If the required products are not in the target installation directories, you must include them in the image. If you do not, when you try to install from the image, installation will fail.
    Note: If a selected product requires other products but those products can be installed on a different machine, the installer does not automatically select or list those products.

When you are done, press ENTER twice.

Select Language Packs to Install

Edit online

If language packs are available for products you are installing or have already installed, the installer prompts you to choose language packs to install. Many products support multiple languages; you can install as many language packs as you want, and all of the languages installed (including the default, U.S. English) will be available to users.

Select Product Updates to Install

Edit online

When performing product installation in an empty directory for the first time, the IBM webMethods Installer client also installs the most recent updates for your selected products. If the selected installation directory contains other IBM products, the Installer client will not install any product updates and you can use Update Manager or Command Central to install the most recent updates for your products. You can choose whether to install the latest updates for all products or install updates for only a subset of products. Updates can be installed both online and offline and any user data that is needed, for example credentials and proxy settings, is collected from the Installer client.

  • When using an online installation, the Installer client connects to Passport Advantage Online to install all products and updates that you selected.
  • When using an offline installation, a previously created image is used. The image is created using the Installer client and the image must contain the required products, updates, and Update Manager.
    Note: Images created using Command Central or older versions of the Installer client allow you to install only products without updates. Fix images created using Update Manager are not supported.

When creating an image, the latest updates are added to the image by default using Update Manager. After the image is created, Update Manager is removed.

Configure Products

Edit online

Some products have default admin passwords. When you install one or more of those products you have to specify and confirm a new default administrator passoword. The password restriction/complexity suggested by the Installer is basic and follows parts of the NIST guidelines.

The Installer asks you to provide an admin password on each run, even when installing into an existing directory. In such cases you can use either the same password, or a different password. Providing a password is mandatory.

When installing products using a script, you provide the administrator password during script execution and can do so through automation.

After specifying and confirming a new default administrator password, the Require password change at first product login allows you to choose whether the product user will have to change the administrator password at first login. This option is disabled by default.
Note: Product installation and product administration may not be done by the same individual. You can use this option to prompt the product administrator to set a password for production purposes on first login, instead of hardcoding a password in installation scripts.

If configuration values are necessary for products you are installing, the installer asks for configuration information. For details on product configuration, see the appropriate product installation documentation.

Use Installation Images

Edit online
Important: Never extract or modify image files using any tool other than the installer.

Create an Image

Edit online

To create an installation image, specify the -writeImage parameter before the -console parameter on the command you run to start the installer. . For example: 

sh IBM_webMethods_Install_operating_system .bin 
-writeImage full_path_to_new_image_file -console

You can specify any file name for the image that is permitted by your operating system. Do not specify an extension; the installer will automatically add .zip. The directory to which you save the file must already exist.

By default, the installer creates the image for the operating system on which you are running the installer. If you want to create the image for another operating system, specify the -imagePlatform parameter on the command. For example: 

sh IBM_webMethods_Install_operating_system.bin 
-writeImage full_path_to_new_image_file 
-imagePlatform operating_system -console

On operating_system , identify the operating system for which to create the image.

The table below lists the values for the operating_system parameter.

Operating System Value for operating_system
IBM AIX AIX
Apple Mac OS X OSX
HP HP-UX Intel Itanium 2 (for product releases 10.3 and lower) HP11IT
HP HP-UX PA-RISC HP11
Linux RHEL and SLES IBM System z LNXS390X
Linux RHEL and SLES x86 LNX
Linux RHEL and SLES x86-64 (EM64T, AMD64) LNXAMD64
Microsoft Windows x86 WNT
Microsoft Windows x86-64 (EM64T, AMD64) W64
Oracle Solaris SPARC SOL
Oracle Solaris x86-64 (EM64T, AMD Opteron) (for product releases 10.3 and lower) SOLAMD64

Go to Use a Proxy Server. You will see all prompts described in that section and the following sections except the installation directory panel and the product configuration panels; you will see those panels when you install from the image.

Important: When you select products to download into an image, the installer lists additional products that are required by the selected products. If these required products do not already exist in the target installation directories, you must include them in the image. If you do not, you will not be able to install the selected products, and in some cases installation will fail. This includes the Java package; if the Java package does not exist in the target installation directories, you must include it in the image.

Display the Contents of an Image

Edit online

To list the contents of an image, specify the -imageContents parameter before the -console parameter on the command you run to start the installer. For example: 

sh IBM_webMethods_Install_operating_system.bin 
-imageContents full_path_to_image_file -console

Validate the Contents of an Image

Edit online

Validating an image makes sure that the image is not missing any files and all checksums match. To validate the contents of an image, specify the -validateImage parameter before the -console parameter on the command you run to start the installer. For example: 

sh IBM_webMethods_Install_operating_system.bin 
-validateImage full_path_to_image_file -console

Install from an Image

Edit online

To install from an installation image, specify the -readImage parameter before the -console parameter on the command you run to start the installer. For example: 

sh IBM_webMethods_Install_operating_system.bin 
-readImage full_path_to_image_file -console

Use Existing Images to Install Products or Create Images Faster

Edit online
  • To install products faster, specify the -existingImages parameter before the -console parameter on the command you run to start the installer. For example: 
    sh IBM_webMethods_Install_operating_system.bin 
-existingImages existing_image_files -console
  • To create images faster, specify the -existingImages, -writeImage, and -imagePlatform parameters before the -console parameter on the command you run to start the installer. For example: 
    sh IBM_webMethods_Install_operating_system.bin 
-existingImages existing_image_files 
-writeImage full_path_to_image_file 
-imagePlatform operating_system  -console

For existing_image_files , specify existing images that contain the products you want, as described below. It does not matter which operating systems the images were created for.

  • You can specify full paths to image files. For example: 
    -existingImages /opt/myImages/IS_HPUX.zip,/opt/myImages/Designer_Solaris.zip
  • You can specify directories that contain image files. For example: 
    -existingImages /opt/myImages/MyImages
  • You can list image files in a text file. For example: 
    /opt/myImages/IS_HPUX.zip 
/opt/myImages/Designer_Solaris.zip 
/opt/myImages/MwS_Windows.zip

    Then specify the file. For example: 

    -existingImages /opt/listofimages.txt
Note: If you specify files that are not image files, the installer ignores them.

Use Installation Scripts

Edit online

When you create a script, you will provide your IBM ID and Entitlement key to download your products, and this password is stored in the script. If you want to encrypt the Entitlement key, provide a master password using the parameter masterPassword password. You must then provide the master password using the same parameter when you edit or install from the script.

Create a Script

Edit online

To create an installation script, run one of the commands below. You can specify any file name for the script that is permitted by your operating system. The directory to which you save the file must already exist.

  • To create an installation script and install products on the local machine, specify the -writeScript parameter before the -console parameter on the command you run to start the installer. For example: 
    sh IBM_webMethods_Install_operating_system.bin 
-writeScript full_path_to_new_script_file -console
  • To create an installation script without installing products on the local machine, specify the -editScript parameter before the -console parameter on the command you run to start the installer. For example: 
    sh IBM_webMethods_Install_operating_system.bin 
-editScript full_path_to_new_script_file -console
  • To create an installation script of yourself installing from an image rather than from Passport Advantage Online, specify the -readImage parameter before the -console parameter on the command you run to start the installer. For example: 
    sh IBM_webMethods_Install_operating_system.bin 
{-writeScript|-editScript} full_path_to_new_script_file 
-readImage full_path_to_existing_image_file -console
  • To create an installation script from an existing script, specify the -readScript and -writeScript parameters before the -console parameter on the command you run to start the installer. For example: 
    sh IBM_webMethods_Install_operating_system.bin 
-readScript full_path_to_new_script_file 
-writeScript full_path_to_new_script_file -console

Edit an Existing Script

Edit online
Important: Do not edit a script manually, by opening the text file.

To edit an existing installation script, specify the -editScript parameter before the -console parameter on the command you run to start the installer. For example: 

sh IBM_webMethods_Install_operating_system.bin 
-editScript full_path_to_existing_script_file -console

Install from a Script on Mac OS X System, Other UNIX System, or Windows System

Edit online

To install from an installation script, specify the -readScript parameter before the -console parameter on the command you run to start the installer. For example: 

sh IBM_webMethods_Install_operating_system.bin 
-readScript full_path_to_existing_script_file

When you created the script, you might have provided a master password to encrypt the stored Entitlement key. If so, provide that master password so the installer can decrypt the Entitlement key. For example, enter: 

sh IBM_webMethods_Install_operating_system.bin 
-readScript full_path_to_existing_script_file -masterPassword password

By default, you will see the installer run in wizard mode unless you are installing on a headless system. If you are installing on a headless system, the installer will run in console mode.

Important: If you created the script from Passport Advantage Online, the product releases referred to in the script must be available on Passport Advantage Online or the script will fail. If you created the script from an image, the image must be in the location it was in when you created the script or the script will fail.

If you are installing on a system that has a monitor, and you want to display the output on a console, specify the -console parameter. For example: 

sh IBM_webMethods_Install_operating_system.bin 
-readScript full_path_to_existing_script_file -console

If your company connects to the Internet through an HTTP or Socks proxy server, you must use that proxy server to install. If you specified proxy information when you created the script, the installer stored all seings except user name and password in the script. If you want to override the stored seings, or if you did not specify proxy information when you created the script, specify the appropriate parameters below.

  • To have the installer use an HTTP proxy server, specify these parameters on the command: 
    -proxyHost host -proxyPort port -proxyUser user -proxyPass password
  • To have the installer use a Socks proxy server, specify these parameters on the command: 
    -socksProxyHost host socksProxyPort port

For example: 

sh IBM_webMethods_Install_operating_system.bin 
-socksProxyHost host -socksProxyPort port 
-readScript full_path_to_existing_script_file -console
Note: If you are installing on a Windows system and you logged in remotely, you might experience problems with the Windows graphics subsystem. Try adding -Djava.awt.headless=true as the first parameter on the command. Only do this if you experience an actual problem; configuring the installer as a headless application on Windows systems might trigger a known problem in Java (see bug JDK-6607186).

After a script runs successfully, by default, the installer exits immediately. If you want the installer to instead allow you to choose when to exit after the script completes, specify the -scriptNoExit parameter at the end of the command.

If errors occur while a script is running, installation fails. By default, the installer shows the errors and does not exit. If you want the installer to exit immediately with a non-zero exit value, specify the -scriptErrorInteract no parameter at the end of the command. If you want the installer to show the errors and pause for a specified number of seconds before exiting, specify the -scriptErrorInteract number_of_seconds parameter at the end of the command.

Generate Images for Multiple Operating Systems from an Image Generation Script

Edit online

Create an Image Generation Script

Edit online

To create an image generation script, specify the -writeImageScript and -imagePlatform parameters before the -console parameter on the command you run to start the installer. For the list of valid values for operating_system, see Create an Image. For example: 

sh IBM_webMethods_Install_operating_system.bin 
-writeImageScript full_path_to_new_image_generation_script_file 
-writeImage full_path_to_new_image_file 
-imagePlatform operating_system -console

You can specify any file name for the image generation script that is permitted by your operating system. The directory to which you save the file must already exist. For operating_system, specify the operating system that supports the greatest number of products for which you want to generate images. For most products, that operating system is Microsoft Windows 64-bit (W64).

Generate Images

Edit online

Procedure

  1. To generate an installation image from the image generation script, specify the -readImageScript parameter before the -console parameter on the command you run to start the installer. For the list of valid values for operating_system, see Create an Image. For example: 
    sh IBM_webMethods_Install_operating_system.bin 
-readImageScript full_path_to_existing_image_generation_script_file 
 full_path_to_new_image_file -console

    You can specify any file name for the image that is permitted by your operating system. Do not specify an extension; the installer will automatically add the extension .zip. The directory to which you save the file must already exist.

    By default, the installer generates the image for the operating system on which you are running the installer. If you want to generate the image for another operating system, specify the -imagePlatform parameter on the command. For example: 

    sh IBM_webMethods_Install_operating_system.bin
-readImageScript full_path_to_existing_image_generation_script_file
full_path_to_new_image_file 
-imagePlatform operating_system -console

    Follow the usual image creation steps to select products and so on.

  2. Repeat the previous step to create images for other operating systems.
    Note: Generating these images requires no user input, so you can automate the generation of these images if desired.
    Important: Do not extract or modify image files using any tool other than the installer.

Change Logging Options

Edit online

You can change logging options by specifying logging-related parameters in front of the -console parameter on the command you run to start the installer.

The following table lists the parameters you can specify to change logging options.

Parameter Variables
-debugLvl level Amount of information to log. Valid values are as follows:
Amount of information to log Value
Fatal only fatal
Errors only error
Errors and warnings warning
Errors, warnings, and informational messages (default) info
All; produces a 10 to 200MB file verbose
No information (that is, do not log any information) none
-debugFile debug_file Full path to the file to contain the logging information. The default is Software AG_directory/install/logs/installLog.txt.
-maxLogSize numberm Maximum size of the file to contain the logging information, in megabytes. If the file reaches the specified size, the installer begins writing a second file (installLog_part2.txt), and then a third file (installLog_part3.txt), and so on, until it writes ten files (installLog_part10.txt). It then overwrites the first file, and then the second file, and so on. The default maximum size for the log file is 250 MB.
-debugOut Writes logging information to standard out as well as to file. This is not valid when using IBM_webMethods_Install_Windows_x64.exe
-debugErr Writes logging information to standard error as well as to file.
-debug level Shorthand way to specify-debugErr -debugLvl level .

Listing the Available Artifacts

Edit online

About this task

You can use the list artifacts command to see the products and fixes available for your installation.

Example

To list all artifacts available on Passport Advantage Online, use the following command:
./<IBMwebMethodsInstaller>.bin list artifacts --release 11.1 --username <IBM_ID> --password <Entitlement_key> --verbose
Note: When connecting to Passport Advantage Online, make sure you provide your username and password to connect successfully.
To list all artifacts available in an image, use the following command:
./<IBMwebMethodsInstaller>.bin list artifacts --installer-image <full_installer_image_path>

Additional options:

  • --platform <Platform> Allows you to select a platform and only the products and updates for this platform are shown. Only usable when listing artifacts from Passport Advantage Online.
  • --fixes ALL Allows you to display all updates in the result. If this option is not specified, only the latest updates are displayed.
  • --format <format> Allows you to select the format in which to display the results. Valid values are json and plain (default). If the option is not specified, the results are displayed in plain text.
  • --output-file <full path where result will be saved> Allows you to save the displayed results in a file. If the option is not specidied, the result is printed on the console.

What to do next

For more information on using the list artifacts command, use the list artifacts help command with the Installer.
Note: This functionality is not available for releases lower than 10.11.

Creating Container Images with IBM webMethods Installer on Linux systems

Edit online

About this task

You can use IBM webMethods Installer to create container images on Linux systems without a preexisting installation. The Installer client can install any certified products along with their fixes and build a container image. When one or more of the products you are using to build a container image have default administrator passwords, make sure to specify the --admin-password property. Only products that are certified for containerization and their top level dependencies are shown in the product tree and only a single runtime product can be selected at a time. For example, if you select Microservices Runtime then you won't be able to select Universal Messaging, because both products provide their runtime and entrypoint scripts.
Note: Products that are not certified or are not in the scope of the release are not shown in the Installer tree.

To create a container image with IBM webMethods Installer, start the Installer client executable with the create container-image command after adding the desired options to the command.

To view all required and available options when creating a container image with IBM webMethods Installer, start the Installer client executable with the create container-image help command.

To view all available product and fix IDs, use the list artifacts command. For more information see Listing the Available Artifacts.

When you are creating an image with IBM webMethods Installer and a java.lang.OutOfMemoryError: Java heap space error occurrs, add the JAVA_TOOL_OPTIONS=-Dcom.softwareag.installer.useTempFileForZipMerge=true system environment and then create the image.

Note: This functionality is not available for releases lower than 10.11.

Examples

Edit online

Creating a Container Image

To create a container image with all latest fixes from Passport Advantage Online, use the following command: 
sh IBMwebMethodsInstaller<yyyymmdd-operating_system>.bin create container-image --name <docker_image_name>  --products <product1_id>[,<product2_id>...]  
--username <IBM_ID> --password <Entitlement_key> --release 11.1
Note: You can configure proxy for your connection to Passport Advantage Online. For more information use the create container-image help command.

Creating a Container Image with Specific Fixes

To create a container image with all of the latest fixes from Passport Advantage Online, use the following command: 

sh IBMwebMethodsInstaller<yyyymmdd-operating_system>.bin create container-image --name <docker_image_name> 
--products integrationServer,jdbcAdapter --fixes <fix_id> --username <IBM_ID> --password <Entitlement_key>  
 --admin-password=<adminPassword>

Creating a Container Image from an Installer Image

To create a container image with all latest fixes from an installer image, use the following command: 

sh IBMwebMethodsInstaller<yyyymmdd-operating_system>.bin create container-image --name <docker_image_name> 
--products integrationServer,jdbcAdapter  --installer-image=<installer_image_file> --admin-password=<adminPassword>

Product and fix IDs can be obtained by using the list artifacts command. For more information see Listing the Available Artifacts.