Unattended Installation Parameters

The following describes the parameters used with the irisinstall_silent script in unattended installation. Some parameters include a default value which the installation uses if the parameter is omitted.

ISC_CPF_MERGE_FILE=”<location>"

Specifies the location of the configuration merge file when performing a configuration merge.

For more information, see Automating Configuration of InterSystems IRIS with Configuration Merge.

ISC_PACKAGE_INSTANCENAME="<instancename>"

Required

Specifies the name of the instance to be installed or upgraded: if the instance does not exist, this is a new installation; if it does exist, this is an upgrade. For example:

ISC_PACKAGE_INSTANCENAME="MyIris"

ISC_PACKAGE_INSTALLDIR="<installdir>"

Required for new instances

Specifies the installation directory for the new instance to be installed; for example:

ISC_PACKAGE_INSTALLDIR="/opt/MyIris"

If the specified directory does not exist, the installation attempts to create it. This parameter is ignored if you are upgrading an installation.

Review the Installation Directory section of this book for information about choosing an installation directory.

ISC_PACKAGE_INSTALL_INTEGRATEDML="Y"|"N"

Default: Y

Specifies whether or not to install InterSystems IntegratedML.

For more information about IntegratedML, see Using IntegratedML.

ISC_PACKAGE_UNICODE="Y"|"N"

Optional

Specifies whether or not this is a UNICODE installation; valid values are Y or N. See Character Width Settings for more information.

ISC_PACKAGE_INITIAL_SECURITY="Minimal"|"Normal"|"LockedDown"

Optional

Default: LockedDown

Specifies the initial security setting for the installation; valid values are: "Minimal", "Normal", or "LockedDown".

If it is set to "Normal" or "LockedDown", ISC_PACKAGE_USER_PASSWORD is required.

"Minimal" is only available for InterSystems IRIS installations.

ISC_PACKAGE_MGRUSER="<user>"

Optional

Default: <installer’s-username>

Specifies the login name of the owner of the installation. For example:

ISC_PACKAGE_MGRUSER="jcsmith"

If the security level is "Minimal", this parameter is ignored, and ISC_PACKAGE_MGRUSER is set to "root".

ISC_PACKAGE_MGRGROUP="<group>"

Optional

Default: <installer’s-group>

Specifies the group that is allowed to start and stop the instance. For example:

ISC_PACKAGE_INITIAL_MGRGROUP="irisusr"

ISC_PACKAGE_USER_PASSWORD="<password>"

Required for installation of secure instances

Specifies the required password for an instance with Normal or Locked Down security.

If the security level is "Minimal", this parameter is ignored.

If the security level is "Normal" or "LockedDown" and this parameter is not specified, the installation fails and an error is thrown.

ISC_PACKAGE_CSPSYSTEM_PASSWORD="<password>"

Specifies the password for the CSPSystem user.

If the security level is "Minimal", this parameter is ignored.

If the security level is "Normal" or "LockedDown" and this parameter is not specified, the value of ISC_PACKAGE_USER_PASSWORD is used.

ISC_PACKAGE_IRISUSER="<user>"

Optional

Default: irisusr

Specifies the effective user for the InterSystems IRIS Superserver.

If the security level is "Minimal", this parameter is ignored and set to the default.

ISC_PACKAGE_IRISGROUP="<group>"

Optional

Default: irisusr

Specifies the effective user for InterSystems IRIS processes.

If the security level is "Minimal", this parameter is ignored and set to the default.

ISC_PACKAGE_CLIENT_COMPONENTS="<component1> <component2> ..."

Optional

Default: <all-client-bindings-installed>

Specifies the client bindings to be installed from the client_components package (see Unattended Installation Packages).

Specified components (bindings) must be space-delimited. Available components are listed in package/client_components/manifest.isc. Installation validates the specified components and removes those that do not exist or are not supported on a particular system.

ISC_PACKAGE_WEB_CONFIGURE="Y"|"N"

Optional

Default: Y (automatically configure the gateway for an external web server)

Specifies whether or not to configure the Web Gateway for an external web server.

Set this option to N if you don’t want the web server configured automatically.

ISC_PACKAGE_WEB_SERVERTYPE="Apache"|"None"

Optional

Default: Apache

Type of existing web server for the Web Gateway to use. For example: ISC_PACKAGE_WEB_SERVERTYPE="Apache"

ISC_PACKAGE_WEB_APACHE_VERSION=2.4

Optional, with ISC_PACKAGE_WEB_SERVERTYPE="Apache"

Default: autodetected

Version of Apache web server.

ISC_PACKAGE_WEB_APACHE_USER="<username>"

Optional, with ISC_PACKAGE_WEB_SERVERTYPE="Apache"

Default: autodetected

Username for Apache web server.

ISC_PACKAGE_WEB_APACHE_CONF="<path_to_httpd.conf>"

Optional, with ISC_PACKAGE_WEB_SERVERTYPE="Apache"

Default: installation attempts to autodetect file location

Location of the Apache Web server configuration file, for example: /etc/httpd/conf/httpd.conf

By default, installation attempts to autodetect file in one of several standard locations. Installation exits with error if ISC_PACKAGE_WEB_SERVERTYPE="Apache" and httpd.conf location is undetermined.

ISC_PACKAGE_WEB_GATEWAY_DIR="<web_gateway_directory>"

Optional, for new Web Gateway installations only

Default: /opt/webgateway_

Directory to contain the Web Gateway files.

ISC_PACKAGE_STARTIRIS="Y"|"N"

Optional

Default: Y (start the instance automatically after installation)

Specifies whether or not to start the installed InterSystems IRIS instance following installation.

ISC_INSTALLER_MANIFEST="<location>"

When installing with an installation manifest, specifies the location of the exported manifest class.

See Using the Manifest for more information.

ISC_INSTALLER_PARAMETERS="<var>=<value>,<var>=<value> ..."

When installing with an installation manifest, specifies variable name/value pairs.

ISC_INSTALLER_LOGFILE="<filename>"

When installing with an installation manifest, specifies the log file name.

ISC_INSTALLER_LOGLEVEL="<level>"

When installing with an installation manifest, specifies the log level, from -1 (“none”) to 3 (“verbose”).

ISC_PACKAGE_SUPERSERVER_PORT="<port_number>"

Optional

Default: 1972 (if available, otherwise 51773 or the first available subsequent number)

Specifies the Superserver port to be used by the instance being installed.

ISC_PACKAGE_USER_DATABASE=Y|N

Default: Y

Specifies whether or not to install the optional users database.

Unattended Installation Packages

Installing as a Nonroot User