Skip to end of metadata
Go to start of metadata

TeamCity vSphere integration allows using TeamCity agent cloud features with VMware vSphere and vCenter installation. It requires configuring TeamCity with your VMware vSphere/vCenter account and then handles automatic creation/starting/stopping/deleting of the virtual machines with TeamCity agents on-demand, based on the queued builds.

The functionality is implemented as a plugin bundled since TeamCity 10.

On this page:



 The integration requires a write access for vSphere/vCenter via API, which is available in the licensed versions; the API support of free versions is limited to read-only  access.


The TeamCity vSphere integration allows you to:

  • select the type of behavior:
    • either to start/stop an existing virtual machine
    • or clone a virtual machine or a template, deleting the clone once it becomes idle (when the build is finished or an idle timeout elapses, depending on the profile settings)
  • select a virtual machine snapshot to start
  • specify the folder for clones and the resource pool where your machine will be allocated
  • configure the maximum number of started instances.


The following steps are required to set up TeamCity-VMware vSphere agent cloud integration:

  1. Create a virtual machine where your builds will run. Refer to the VMware vSphere web site for details on creating virtual machines.

Prepare a machine with an installed TeamCity agent.


When configuring the TeamCity build agent, be sure to specify the valid TeamCity server URL in the build agent properties.

  1. If you want TeamCity to start/stop this machine on demand or to clone it, proceed to configuring the VMware cloud profile on the TeamCity server.  When the profile is modified, TeamCity detects the changes immediately, and forces shutdown of the agents started prior to these changes once the agents finish the current build.

  2. If you want to create a template of this machine and clone it, refer to the VMware vSphere web site for details on creating templates and proceed to configuring the VMware cloud profile on the TeamCity server. Make sure to specify the valid vCenter SDK URL.

Notes on configuring Agent cloud profile

  • You can limit a number of instances across all images and /or set the limit per image. 
  • It is possible to specify unique hostnames for cloud agents: when adding an image, choose a customization spec from the corresponding field. The option is available for Windows and Linux virtual machines.
  • When using the same image in different cloud profiles, to avoid possible conflicts, it is possible to use a custom agent image name when configuring a cloud profile in TeamCity. This can be also useful with naming patterns for agents. 
    When a custom agent image name is specified, the names of cloud agent instances cloned from the image will be based on this name.



  • No labels