Coordinator Console Utility (xgCoordConsole.exe)

The Coordinator Console utility (xgCoordConsole.exe) can be used for two purposes:

  • Generating an XML file containing information about the Agents in the Incredibuild environment and their current status. This can be used for a variety of purposes such as real-time monitoring and generating custom statistics about your Incredibuild environment.

  • Performing Coordinator-related maintenance tasks, such as cleaning the file cache on all connected Agents.

Coordinator Maintenance Tasks

To clear the file cache on all connected Agent machines:

  •  Run the following command:xgCoordConsole.exe /ResetAllFileCaches

Note: This option can only be run from the machine running the Coordinator service.

Generating the Coordinator Status XML File

To generate an XML file with the current information, run the following command:

xgCoordConsole.exe /ExportStatus=MyFilePath.xml

Where MyFilePath.xml is the path to the target xml file.

Additional command line options:

  • /nologo – suppresses the copyright message

  • /local – exports status of the Coordinator running on the local machine, regardless of the Coordinator specified in the Agent Settings dialog

Root Element Description

The XML file's root "CoordinatorStatus" element includes the attributes described in the following table:

Attribute Description
Role Either "Backup" or "Primary", depending on the Coordinator's configuration
Host The Coordinator's network name
Port The Coordinator service's IP port
AgentCount The number of Agents in the report. The report includes all subscribed Agents (both offline and online), as well as any unsubscribed Agents currently connected to the Coordinator and pending subscription.
ExportTime The time the XML file was created, in a 64-bit numeric value that corresponds to a Windows FILETIME structure
ExportTimeText The time the XML file was created, in text format
Version The installed Incredibuild version build number
VersionText The installed Incredibuild version text description
PrimaryCoordinatorOnline Boolean value describing whether the primary Coordinator is reachable
BackupCoordinatorOnline Boolean value describing whether the backup Coordinator is reachable

Note: If both PrimaryCoordinatorOnline and BackupCoordinatorOnline are "True", this implies that the primary Coordinator is active; if PrimaryCoordinatorOnline="False" and BackupCoordinatorOnline="True", this implies that the Backup Coordinator is currently active.

Agent Element Description

The XML includes an "Agent" element for every included Agent. The following table provides a description of the attributes:

Attribute Description
Online Whether the Agent is currently connected to the Coordinator.
Version The version of Incredibuild that the Agent is currently running (in numeric format).
Version Text The version of Incredibuild that the Agent is currently running (in text format).
Host The network name of the Agent computer.
Port The IP port used by the Agent Service.

AgentType

Whether the agent is a physical (on prem) machine, or a cloud machine.

CPUSpeed The CPU speed of the Agent computer.
CPUCount The CPU count of the Agent computer.
CPUAvailablePercent The current percentage of CPU of the Agent available for helping builds (Incredibuild can ignore specified processes when calculating this to avoid skewing availability). See Coordinator Settings.
CPUBrandString The human‑readable CPU identification string.
Description The free‑text description field shown in Incredibuild UI to document machine purpose/owner (useful in large pools).
FileCacheSize The size limit of the Agent’s file cache that stores files used during distributed builds. If too small, performance can degrade.
FileCacheUsed The current utilization of the Agent’s file cache; high utilization near the limit can trigger recommendations to increase the cache.
OSVersion The operating system version of the Agent; used for eligibility and distribution rules (newest/oldest allowed helper OS constraints).
LogLevel The Agent’s logging verbosity; Support may ask you to temporarily raise it, but the recommended default is Minimal to avoid overhead.

The following logging levels are available:

  • 0 – Minimal: Generates the fewest logs for optimal performance.

  • 1 – Basic (Default): Recommended setting. Produces limited logs, sufficient for most scenarios.

  • 2 – Intermediate: Provides additional details, useful for analyzing build cache hits and misses.

  • 3 – Extended: Includes extensive details, helpful for most distribution-related cases.

  • 4 – Detailed: Captures all log messages, ideal for troubleshooting environment or customer-specific setups.
RoutingIP The IP/hostname used by the Agent/Coordinator for coordination and utility traffic; part of network settings that define how Agents reach the Coordinator.
PerformanceRating A value indicating the rating of the helper for assignments to builds.
UpTimeSec The Agent machine uptime (seconds) since the last restart; useful when correlating performance issues or eligibility changes.
ScreenSaverRunning Whether the screen saver is currently active; when enabled, Incredibuild treats the CPU as idle and raises task priority to improve helping performance.
Enabled The current Agent state (enabled/disabled) controlling whether the Agent can participate in builds; can be scheduled or toggled automatically (e.g., when screen saver starts).
Building Whether the Agent is initiating a build (not helping).
WorkingForAgents A list of initiator machine names that this helper is currently helping.
TotalPhysical The total physical RAM on the Agent.
TotalVirtual The total virtual memory/page file capacity on the Agent.
AvailPhysical The physical RAM currently available (free); a factor in helper participation thresholds.
AvailVirtual The currently available virtual memory; also considered in eligibility.
InitiatorRegType The Initiator license type, for example, Fixed.
CIInitiatorRegType The CI Initiator license type. CI Initiators are specialized Initiator licenses for CI use cases.
HelperRegType The Helper license type, for example, Floating.
HelperCores The maximum number of cores on this Helper that the Coordinator may use for distributed tasks.
RegisteredInitiator Whether this Agent is registered/licensed to act as an Initiator. (Once an Agent is installed and points to the Coordinator, it registers and takes its role based on license.)
RegisteredCores The number of licensed cores available to the Agent (local + remote) for Incredibuild tasks, as determined by Coordinator and package allocation.
InitiatorQueued Indicates whether it’s a floating initiator that is queued for receiving a license.
BuildCacheAllowed Whether the Agent is permitted to use Build Cache features (shared or local) to accelerate repeatable tasks.
BuildGroup The logical grouping used to control which Agents participate together (e.g., to segment helpers by project or policy).
LastConnected The last time this Agent connected to the Coordinator; in a 64-bit numeric value that corresponds to a Windows FILETIME structure.
LastConnectedText The last time ths Agent connected to the Coordinator; in standard date format.
TotalDiskSpace The total disk capacity on the Agent (for working/temp and cache usage); the Coordinator can require minimum free space for helpers.
AvailDiskSpace The virtual memory currently available ; also considered in eligibility.
MSVCVersion The Microsoft Visual C++ compiler version installed on the Agent. This is relevant for builds that depend on specific MSVC toolchains.
NetFrameworkVersion The .NET Framework versions installed on the Agent (e.g., CDF;v4;v4.0 means .NET Framework 4.x is present). Useful for tasks requiring .NET runtime.
LoggedOnUsers The currently logged-in user accounts on the machine. Helpful for auditing and troubleshooting build permissions.
SchedulerEnabled Whether the Agent’s availability is controlled by a time-based scheduler. When False, the Agent is always available unless manually disabled.
SchedulerStartTime The time when the Agent becomes available for builds if the scheduler is enabled (e.g., 18:00).
SchedulerStopTime The time when the Agent stops participating in builds under scheduler control (e.g., 09:00).
SchedulerRunning Whether the scheduler is currently active and controlling the Agent’s state (True means scheduler rules are applied).
LogicalCoresCount The number of logical CPU cores (includes hyper-threaded cores). Used by Incredibuild to allocate parallel tasks.
PhysicalsCoresCount The number of physical CPU cores (actual hardware cores).

Builds Element Description

When the Agent initiatesbuilds, there is a Builds list described in the following table:

Attribute Description
BuildTitle The build title.
BuildProgressPercent The build progress percentage.
BuildAssignedCPUCount The number of remote cores assigned to the build.
WorkPowerCPUs The total number of cores assigned to the build, including local initiator cores (unless Avoid Local is enabled).
WorkPowerMHz The total CPU power assigned to the build.