Unattended installation

This topic explains how to run the API Gateway installer in unattended mode on UNIX/Linux and Windows. It also describes each of the available command options.

Note   Windows is supported only for a limited set of developer tools, see Install developer tools on Windows. API Gateway and API Manager do not support Windows.

Run the installer in unattended mode

You can run the API Gateway installer in unattended mode on the command line. Perform the following steps:

  1. Change to the directory where the setup file is located.
  2. Run the setup file with the --mode unattended option.

Standard setup without API Manager

The following example shows how to install all available API Gateway components (excluding API Manager on UNIX/Linux) in unattended mode:

UNIX/Linux

./APIGateway_7.6.2_Install_linux-x86-32_BN<n>.run --mode unattended 
--setup_type standard 
--licenseFilePath my_license.lic
--analyticsLicenseFilePath my_analytics_license.lic
--prefix /opt/Axway-7.6.2
--cassandraInstalldir opt/db/cassandra
--cassandraJDK opt/jre
--startCassandra 1

Windows

APIGateway_7.6.2_Client_Tools_Install_win-x86-32_BN<n>.exe --mode unattended 
--prefix C:\Axway-7.6.2

--analyticsLicenseFilePath my_analytics_license.lic

The components are installed in the background, in the directory specified by the --prefix option. On Windows, the installed components are Policy Studio, Configuration Studio, and Package and Deployment Tools only.

Complete setup with API Manager

The following example shows how to install all API Gateway components on UNIX/Linux, including API Manager, in unattended mode:

./APIGateway_7.6.2_Install_linux-x86-32_BN<n>.run --mode unattended 
--setup_type complete 
--licenseFilePath my_license.lic
--analyticsLicenseFilePath my_analytics_license.lic
--apimgmtLicenseFilePath my_mgmt_license.lic
--prefix /opt/Axway-7.6.2
--cassandraInstalldir /opt/db/cassandra
--cassandraJDK /opt/jre
--startCassandra 1

The components are installed in the background, in the directory specified by the --prefix option.

Custom setup

The topics on installing each API Gateway component show how to use the --setup_type advanced option to install a custom setup in unattended mode. For example, see Install the API Gateway server.

Unattended mode options

For a description of all the available command-line options and their default settings, run the setup file with the --help option. This outputs the help text in a separate console. For example:

UNIX/Linux

./APIGateway_7.6.2_Install_linux-x86-32_BN<n>.run --help

Windows

APIGateway_7.6.2_Client_Tools_Install_win-x86-32_BN<n>.exe --help

The following table summarizes some of the more common options:

Option Description
--help Display available options and default settings.
--mode Specify an installation mode.
--setup_type Specify a setup type (standard, complete, or advanced) (on UNIX/Linux only).
--enable-components Specify a comma-separated list of components to enable.
--disable-components Specify a comma-separated list of components to disable.
--prefix Specify an installation directory.
--licenseFilePath Specify the path to a license file (on UNIX/Linux only).
--analyticsLicenseFilePath Specify the path to an API Gateway Analytics license file.
--apimgmtLicenseFilePath Specify the path to an API Manager license file (on UNIX/Linux only).
--unattendedmodeui Specify different levels of user interaction when installing on a UNIX/Linux system with X-Windows or on Windows.
--cassandraInstalldir Specify the Apache Cassandra installation directory, for example, opt/db/cassandra (on UNIX/Linux only).
--cassandraJDK

Specify the location of your Oracle Java Runtime Environment for Apache Cassandra. The default value is:

  • INSTALL_DIR/apigateway/Linux.x86_64/jre/bin
Note   OpenJDK is not supported.
--startCassandra Specify whether the Apache Cassandra server starts after the installer completes (on UNIX/Linux only). Set to 1 to start Cassandra after installation, or set to 0 if you do not want Cassandra to start.
--optionfile Specify options in a properties file. For more information on option files, go to:
http://installbuilder.bitrock.com/docs/installbuilder-userguide.html

Related Links