IncrediBuild Silent Installations let you use the command line to install IncrediBuild components. This type of installation is the most appropriate for the following cases: - When you have an enterprise or a VM farm with a large number of machines that need IncrediBuild component installed. In this case, you can perform a large number of installations without having to interact with the setup screens.
- When white labeling is required, and you do not want your users to be aware of IncrediBuild setup.
To use the silent installation, first you need to generate an Automated Installer file using IncrediBuild Setup wizard. Then, via the CMD, you enter the required command and options to install the required IncrediBuild component on the host machine. This section describes the installation of IncrediBuild components using an Automated Silent Installer, as follows: | Table of Content Zone |
|---|
| location | topGenerating the Silent Installer
IncrediBuild standard Setup file allows you to generate an Automated Installer file. After its generation, this Automated Installer can be run on machines in your network, to silently install IncrediBuild Coordinator and Agents 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.
> To generate an Automated Installer:
- Double-click IncrediBuild Setup file.
IncrediBuild Setup wizard appears. - On the Welcome page, click Next.
- On the Setup Options page, select the Create Automated Installer. Then, click the Save As button, and save the Automated Installer file in your desired location:
Image Modified
The Automated Installer is created, and it is saved under the name "IBSetupConsole.exe" in your specified location.
Using the Automated Installer to Install IncrediBuild Components
The following instructions describe the general flow of the installation of IncrediBuild components using the Automated Installer. The syntax of the specific commands for the installation of each component is presented in the sections below.
> To use the Automated Installer to install IncrediBuild Components:
- Run the CMD as Administrator.
- On the CMD, go to the directory that contains the Automated Installer file you previously generated.
Enter the required installation command and options, according to the component you want to install and the following syntax:
| Code Block |
|---|
IBSetupConsole.exe /Install /Components={Component Name}
/Coordinator={Coordinator IP Address/Hostname}
[General Options] [Component Options] |
Where:
Components [Mandatory] – the name of the component to install. Can be one of the following: Agent; Coordinator; Agent,Coordinator; Agent,oneuse.
Coordinator – the IP address or hostname of the connected Coordinator. Mandatory for the installation of an Agent and a Backup Coordinator.
If the Coordinator does NOT use the default port number (31104), you should add the required port number to the Coordinator name in quotation marks, as follows: "Coordinator_Name:Port_No."
For example:"192.100.00.01:12345"
General Options [Optional] – general installation options that can be added to all installation commands. See below.
Component Options [Optional] – installation options that are specific to each installed component.
For example: Installing an Agent using the Automated Installer
The following command is entered in the CMD to install an Agent on the local machine. This Agent will communicate with a Coordinator, whose hostname is "Win10-1":
| Code Block |
|---|
IBSetupConsole.exe /Install /Components=Agent /Coordinator=Win10-1 |
Additional Command Line - General Options
The following options can be added to all installation commands:
| General Option | Description | Default Value |
/AddToPath={ON|OFF} | Controls whether the IncrediBuild installation folder is added to the system search path. | ON |
/InstallDir={Install dir path} | Allows manual specification of the IncrediBuild installation folder. | C:\Program Files (x86)\IncrediBuild |
Installing IncrediBuild Components Using the Automated Installer
Installing an Agent Using the Automated Installer
The syntax for installing an Agent using the Automated Installer is as follows:
| Code Block |
|---|
|
IBSetupConsole.exe /Install /Components=Agent
/Coordinator={Coordinator IP Address/Hostname}
[General Options] [Agent Options] |
The following options can be added to the installation of an Agent:
| Agent Option | Description | Default Value |
/Agent:AutoSelectPorts={ON|OFF} | Controls whether setup should automatically select the first available TCP/IP ports for the Agent Service and Helper cores. If this option is ON, the default port numbers will be used (31105 and 31106), and any manual port specification will be overridden. | OFF |
| /Agent:FILECACHE={Number in MBs} | Allows manual specification, in MBs, of the maximum size of the Agent file cache folder. | 4096 |
/Agent:Group={Build Group name} | (For Enterprise Edition only) Allows the assignment of the Agent to a specific Build Group, by entering the name of the required Build Group as the value of the {Group name}.
For more information, see: Assigning an Agent to a Build Group via the Silent Installer. | Default Build Group |
/Agent:HelperPort={Port no.} | Allows manual specification of the Agent Helper port, required for the communication between an Initiator and the Helper cores. This manual specification will take effect only if the /Agent:AutoSelectPorts option is OFF. | 31106 |
/Agent:InstallAddins={ON|OFF} | Controls whether the installation procedure should also install IncrediBuild Add-in/Extension in Visual Studio IDE. | ON |
/Agent:OpenFirewall={ON|OFF} | Controls whether setup should open Agent ports in the Windows Firewall. | ON |
/Agent:ServicePort={Port no.} | Allows manual specification of the IncrediBuild Agent Service port, required for the communication with the Coordinator. This manual specification will take effect only if the /Agent:AutoSelectPorts option is OFF. | 31105 |
For example: Installing an Agent with specific Agent options
The following command is entered to install an Agent on the local machine. This Agent will communicate with a Coordinator, whose hostname is "Win10-1"; the maximum file cache size will be 4500 MBs; and the Agent will be assigned to the "Dev" Build Group.
| Code Block |
|---|
IBSetupConsole.exe /Install /Components=Agent /Coordinator=Win10-1
/Agent:FileCache=4500 /Agent:Group=Dev |
Installing a Primary Coordinator Using the Automated Installer
The syntax for installing a primary Coordinator using the Automated Installer is as follows:
| Code Block |
|---|
IBSetupConsole.exe /Install /Components=Coordinator
[General Options] [Coordinator Options] |
The following options can be added to the installation of a Coordinator:
| Coordinator Option | Description | Default Value |
/Coord:OpenFirewall={ON|OFF} | Controls whether setup should open the Coordinator service ports in the Windows Firewall. | ON |
/Coord:ServicePort={Port no.} | Allows manual specification of the Coordinator service port. | 31104 |
Installing Both a Primary Coordinator and an Agent Using the Automated Installer
The syntax for installing both an Agent and a primary Coordinator using the Automated Installer is as follows:
| Code Block |
|---|
IBSetupConsole.exe /Install /Components=Coordinator,Agent
/Coordinator={Primary Coordinator IP Address/Hostname}
[General Options] [Agent Options][Coordinator Options] |
Installing a 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. Install the Backup Coordinator on a machine that has a connection to the primary Coordinator.
The syntax for installing a backup Coordinator using the Automated Installer is as follows:
| Code Block |
|---|
IBSetupConsole.exe /Install /Components=Coordinator /Coord:Backup
/Coordinator={Primary Coordinator IP Address/Hostname}
[General Options] [Coordinator Options] |
Note: The Coordinator options that can be added to this command are the same as for the primary Coordinator.
Installing an Agent with a Single-Use VM License Using the Automated Installer
(For Enterprise Edition only) The syntax for installing an Agent with a Single-Use VM license using the Automated Installer is as follows:
| Code Block |
|---|
IBSetupConsole.exe /Install /Components=Agent,oneuse
/Coordinator={Coordinator IP Address/Hostname}
[General Options] [Agent Options] [Coordinator Options] |
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:
> To uninstall IncrediBuild:
| Code Block |
|---|
IBSetupConsole /uninstall |
> To update IncrediBuild:
| Code Block |
|---|
IBSetupConsole /update |
> To repair IncrediBuild Installation:
| Code Block |
|---|
IBSetupConsole /repair |
|---|