TeamCity Cloud 2023.05 Help

Build Agent

A TeamCity build agent is a piece of software which listens for the commands from the TeamCity server and starts the actual build processes. There are two types of agents in TeamCity Cloud: JetBrains-hosted and self-hosted. The first ones are maintained and configured by JetBrains. They are started on-demand as soon as each new build requires to be run. The second ones are stored and configured by the customer. Both types of agents can be successfully combined in one TeamCity Cloud installation. Please see Subscription and Licensing on details between these agents in terms of the TeamCity Cloud subscription.

A TeamCity build agent contains two processes:

  • Agent launcher — a Java process that launches the agent process.

  • Agent — the main process for a build agent; runs as a child process for the agent launcher.

An agent typically checks out the source code, downloads artifacts of other builds and runs the build process. An agent can run a single build at a time. The number of agents basically limits the number of parallel builds and environments in which your build processes are run.
An agent can run builds of any compatible build configuration.

The TeamCity server monitors all the connected agents and assigns queued builds to the agents based on compatibility requirements, agent pools, build configuration restrictions configured for an agent and the selection algorithm described here.

Build Agent Status

In TeamCity, a build agent can have following statuses:



Connected/ Disconnected

An agent is connected if it is registered on the TeamCity server and responds to server commands, otherwise it is disconnected. This status is determined automatically.

Authorized/ Unauthorized

Agents are manually authorized via the web UI on the Agents page. Only authorized build agents can run builds. The number of authorized agents at any given time cannot exceed the number of agent licenses entered on the server. When an agent is unauthorized, a license is freed and a different build agent can be authorized. Purchase additional licenses to expand the number of agents that can concurrently run builds. When a new agent is registered on the server for the first time, it is unauthorized by default and requires manual authorization to run the builds.

If a build agent is installed and running on the same computer as the TeamCity build server, it is authorized automatically.

Enabled/ Disabled (Disabled for maintenance for cloud agents)

Agents are manually enabled/disabled via the web UI. The TeamCity server only distributes builds to agents that are enabled.

Agent disabling does not affect (stop) the build which is currently running on the agent.

Disabled agents can still run builds when the build is assigned to a special agent (for example, by triggering a custom build). This feature is generally used to temporarily remove agents from the build grid to investigate agent-specific issues.

All agents connected to the server must have unique agent names.

Only users with certain roles can manage agents. See this article for more information.

For a build agent configuration, refer to this section.

Agent Upgrade

JetBrains hosted agents are upgraded automatically when the server is upgraded.

The upgrade of self-hosted agents is also automated and involves downloading new agent files from the TeamCity server and restarting the agent on the new files. In order to successfully accomplish this, the user under whose account the agent runs should have enough permissions.

Typically, an agent upgrade happens when the server is upgraded.

Last modified: 24 October 2022