Skip to main content
Last updated on Sep 12, 2023 Some settings can be modified using the command line or scripts. These commands require root user permissions.

​
Get Status

Run this on any agent to view if an agent is enabled or disabled to participate as a helper in builds (returns true if enabled, false if disabled).

​
Set Status

Run these on any agent to modify enable or disable it’s ability to participate as a helper in builds.

​
Get Coordinator

To view the Coordinator that a helper is associated with, run this on any agent machine:

​
Set Coordinator

To change the Coordinator that a helper is associated with, run this on any agent machine:
After this is done, you also need unsubscribe the licenses on the original Coordinator and resubscribe them on the new Coordinator.For example:

​
Get Maximum Number of Local Helpers

To view the maximum number of available local cores required to start a new build, run this command on any agent machine:

​
Set Maximum Number of Local Helpers

To change the maximum number of cores that an Agent can use when participating in builds, run this command on any agent machine:
For example:

​
Get Minimum Number of Local Helpers

To view the minimum number of available local cores required to start a new build, run this command on any agent machine:

​
Set Minimum Number of Local Helpers

To change the minimum number of available local cores required to start a new build, run this command on any agent machine:
For example:

​
Get the Proxy Server for HTTP Communication

Get the proxy server that will be used for outgoing external HTTP communication from Incredibuild.

​
Set the Proxy Server for HTTP Communication

Set the proxy server that will be used for outgoing external HTTP communication from Incredibuild. To remove the proxy server, use this command with an empty value:

​
Get the Proxy Server for HTTPS Communication

Get the proxy server that will be used for outgoing external HTTPS communication from Incredibuild.

​
Set the Proxy Server for HTTPS Communication

Set the proxy server that will be used for outgoing external HTTPS communication from Incredibuild. To remove the proxy server, use this command with an empty value:

​
Get No Proxy Exceptions

To get the list of IP addresses, hostnames, and domains that bypass your proxy, use the following command:

​
Set No Proxy Exceptions

To set the list of IP addresses, hostnames, and domains that bypass your proxy, use the following command:
For example:

​
Get Maximum Initiator Cores

To view the maximum number of cores that can be used by the agent when acting as the Initiator of a build, run this on any agent:

​
Set Maximum Initiator Cores

To set the maximum number of cores that can be used by the agent when acting as the Initiator of a build, run this on any agent:
For example:

​
Get Build Group

To view what Build Group an agent is in, run this on the agent:

​
Set Build Group

Run this on your Primary Coordinator to assign an agent to a build group. You can use add the —include-offline flag (optional) at the end to implement the assignment even if the agent is offline.
For example:
These commands control the Build Cache settings on Initiator machines.

​
Get Local Build Cache Information

Return information about the location and size of your local build cache:

​
Set Local Build Cache Size

Set the local build cache size. By default, the size is 100GB:

​
Get Build Cache Service

You can retrieve the default Build Cache Service used by an Initiator. This service is used for shared Build Cache.

​
Set Build Cache Service

You can set the default Build Cache Service used by an Initiator. This service is used for shared Build Cache.
For example:

​
Clear Build Cache

Clear the local build cache:
These commands control the Build Cache settings on Build Cache Service machines.

​
Get Build Cache Size

To view the Build Cache size (in GB) on the Build Cache Service machine:

​
Set Build Cache Size

To set the Build Cache size (in GB) on the Build Cache Service machine:
For example:

​
Clear Build Cache

To clear the Build Cache on the Build Cache Service machine:

​
View Build Cache Location

To view the path where the Build Cache is stored on the Build Cache Service machine:

​
Get Build Cache Used Size

To view the currently used size of the Build Cache on the Build Cache Service machine: