Versions Compared

Old Version 5

changes.mady.by.user Writer Tech

Saved on

compared with

New Version 6

changes.mady.by.user Shmuel Kaplan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Image Added

Section


Column

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.


Table of Content Zone
locationtop

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 include:

  • /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:


AttributeDescription
RoleEither "Backup" or "Primary", depending on the Coordinator's configuration
HostThe Coordinator's network name
PortThe Coordinator service's IP port
AgentCountThe 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.
ExportTimeThe time the XML file was created, in a 64-bit numeric value that corresponds to a Windows FILETIME structure
ExportTimeTextThe time the XML file was created, in text format
VersionThe installed IncrediBuild version build number
VersionTextThe installed IncrediBuild version text description
PrimaryCoordinatorOnlineBoolean value describing whether the primary Coordinator is reachable
BackupCoordinatorOnlineBoolean 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:


AttributeDescription
OnlineWhether the Agent is currently connected to the Coordinator
VersionThe version of IncrediBuild that the Agent is currently running (in numeric format)
Version TextThe version of IncrediBuild that the Agent is currently running (in text format)
HostThe network name of the Agent computer
PortThe IP port used by the Agent Service
BuildAssignedCPUCountThe total number of CPUs/cores assigned to the build that this Agent is running
WorkingForAgentsThe number of Agents currently assigned to the build that this Agent is running
LastConnectedThe last time this Agent connected to the Coordinator; in a 64-bit numeric value that corresponds to a Windows FILETIME structure




Column
width15


Div

The Coordinator:

Child pages (Children Display)
styleh4
pageThe Coordinator

User Manual:

Child pages (Children Display)
styleh4
pageIncrediBuild Windows User Manual




...