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

​
Agent Settings

​
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. If run on a helper, it will stop any running tasks and reassign them to an available helper or the initiator. If run an Initiator, any builds started by that initiator will be aborted.If the new Coordinator is not the same version of Incredibuild as the Agents, the Agents will be automatically upgraded or downgraded.
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:
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:
To unset this parameter, call it with the value "":

​
Clear Build Cache

Clear the local build cache:

​
Coordinator Settings

​
Create Build Group

Run this on your Primary Coordinator to create a new Build Group.
For example:

​
Delete Build Group

Run this on your Primary Coordinator to Delete a Build Group.
For example:

​
Get All Build Groups

Run this on your Primary Coordinator to return a list of all Build Groups in JSON format.

​
Get List of Agents in Build Group

Run this on your Primary Coordinator to returns a list of all Agents (in JSON) assigned to the specified Build Group.
For example:

​
Set Build Group

Run this on your Primary Coordinator to assigns an Agent to an existing Build Group.
For example:

​
Get Build Group

To view what Build Group an agent is in, run this on the agent:
Returns license information in JSON format including: GUID, name, expiration date, number of server cores and SUVM cores.
Returns the total number of cores and the total number of available (unsubscribed) cores for each type of license (server \ SUVM).
Creates a key file (.pk) for the coordinator in the given path with the given name (should have .pk extension). This is required to generate a first license or renew an existing license (similar to the UI option to generate key file).
For example:
Loads the specified license file. If the coordinator already has a valid license, this will replace it without any downtime to the Grid and running builds. If the load fails for any reason, the CLI will provide an error and revert back to the previous license (if applicable).
Unloads the existing license.
Returns the coordinator type (primary \ secondary) and status (offline, standby, active) in JSON format.

​
Get Secondary Coordinator IP/Name

When run on the Primary Coordinator, it returns the IP address or machine name for the Secondary Coordinator (if one is defined).

​
Set Secondary Coordinator

Sets the specified machine as the Secondary Coordinator for this Primary Coordinator.
For example:

​
Get Secondary Coordinator Status

Returns the status of the Secondary Coordinator in JSON format (can be unconfigured, offline, standby, or active)

​
Build Cache Service Settings

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: