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, or from Agent machines that have been granted Remote Administration rights.
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, which are not explained in the Coordinator Monitor section:
| 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 |
| BuildAssignedCPUCount | The total number of CPUs/cores assigned to the build that this Agent is running |
| WorkingForAgents | The number of Agents currently assigned to the build that this Agent is running |
| LastConnected | The last time this Agent connected to the Coordinator; in a 64-bit numeric value that corresponds to a Windows FILETIME structure |
|
PhysicalCores |
The number of physical cores available to act as Helpers |
|
LogicalCores |
The number of logical cores available to act as Helpers |