Preparing Silent Installation

Preparing Silent Installation

IncrediBuild's Silent Installation feature enables the end-user to run a single installation setup file (your setup), and select the relevant components. The setup file allows installation of all the components on the primary machine (PC/Server). For the secondary machines (the machines running the Helper agents), the user does not have to install the host software (your software). On these machines, the end-user installs the Helper agent, and on one of them, the Coordinator.

This type of installation is most appropriate for the following situations:

This topic describes the installation of an IncrediBuild Agent/Coordinator using an automated silent installer, as follows:

Generating the Silent Installer

The standard IncrediBuild installation package, used for the manual installation procedure, can also be used to generate an automated installation application, which can subsequently be run on machines to silently install IncrediBuild Agents and Coordinators using a variety of configurable command line options. The automated installer can also be used to uninstall IncrediBuild, update installations to newer versions, and repair existing installations. This is very useful for managers of VM farms.

To generate an automated installer:

  1. Run the standard IncrediBuild installation package.
  2. Select Create Automated Installer and click Save as... to select where the automated installer should be saved.

    A file named "IBSetupConsole.exe" is created in the specified location.

Installing an IncrediBuild Agent Using the Automated Installer

The syntax for installing an Agent using the automated installer is as follows:

IBSetupConsole.exe /Install /Components=Agent /Coordinator={COORDINATORNAME} [General Options] [Agent Options]

Where:

Option Description Default Value
/AGENT:OPENFIREWALL=[ON|OFF] Controls whether setup should open Agent ports in the Windows Firewall [ON]
/AGENT:AUTOSELECTPORTS=[ON|OFF] Controls whether setup should automatically select the first available TCP/IP ports for the Agent service [OFF]
/AGENT:INSTALLADDINS=[ON|OFF] Controls whether setup should install the Visual Studio IDE integration [ON]
/AGENT:SERVICEPORT= Allows manual specification of the IncrediBuild Agent primary (service) port 31105
/AGENT:HELPERPORT= Allows manual specification of the IncrediBuild Agent secondary (Helper) port 31106
/AGENT:FILECACHE= Allows manual specification, in MBs, of the maximal size for the Agent's file cache folder 4096

Additional Command Line - General Options

The following options can be specified in all installation types:
Option Description Default Value
@<command filename> If specified, the command line options specified in the command file are added to the explicitly specified command line options.
/INSTALLDIR= Allows manual specification of the IncrediBuild installation folder "Xoreax\IncrediBuild" under the Program files system folder.
/ADDTOPATH=[ON|OFF] Controls whether the IncrediBuild installation folder is added to the system search path ON

Installing an IncrediBuild Primary Coordinator Using the Automated Installer

The syntax for installing a primary Coordinator using the automated installer is as follows:

IBSetupConsole.exe /Install /Components=Coordinator [General Options] [Coordinator Options]

Where:

Option Description Default Value
/COORD:OPENFIREWALL=[ON|OFF] Controls whether setup should open the Coordinator service ports in the Windows Firewall ON
/COORD:SERVICEPORT= Allows manual specification of the IncrediBuild Coordinator service port 31104

Installing both an IncrediBuild Primary Coordinator and Agent Using the Automated Installer

The syntax for installing both an Agent and primary Coordinator using the automated installer is as follows:

IBSetupConsole.exe /Install /Components=Coordinator,Agent /Coordinator={PRIMARYCOORDINATOR} [General Options] [Agent Options][Coordinator Options]
See above sections for the available options.

Installing an IncrediBuild Backup Coordinator Using the Automated Installer

A Backup Coordinator is a program that can take over the critical functions of the main Coordinator, if the main Coordinator fails or becomes unavailable. The Backup Coordinator enables distributed processing to continue unaffected.

The syntax for installing a backup Coordinator using the automated installer is as follows:

IBSetupConsole.exe /Install /Components=Coordinator /Coord:Backup /Coordinator={PRIMARYCOORDINATOR} [General Options] [Coordinator Options]

Where:

Option Description Default Value
/COORD:OPENFIREWALL=[ON|OFF] Controls whether setup should open the backup Coordinator service ports in the Windows Firewall ON
/COORD:SERVICEPORT= Allows manual specification of the IncrediBuild backup Coordinator service port 31104

Uninstalling IncrediBuild, Upgrading to a New Version, or Repairing an Existing Installation

To silently uninstall IncrediBuild, upgrade to a new version of the software, or repair an existing installation, run the automated installer with the corresponding command line options:

IBSetupConsole /uninstall
IBSetupConsole /update
IBSetupConsole /repair