This documentation relates to an earlier version of Bamboo.
View

Unknown macro: {spacejump}

or visit the current documentation home.

You can define the capabilities for a specific remote agent by configuring a bamboo-capabilities.properties file on the agent machine. When the bamboo agent starts up, it will look in the current runtime directory (i.e. <bamboo-agent-home>/bin) for a file named bamboo-capabilities.properties. The capabilities defined in that file will then be published for the bamboo agent after registering.

We are aware of an issue that prevents a remote agent capability from being updated once it has been added using the bamboo-capabilities.properties file. If you choose to add capabilities with the bamboo-capabilities.properties file, you will only be able to update them by deleting the capability in Bamboo and restarting the remote agent. Please see BAM-4213 for further details.

To configure remote agent capabilities:

  1. Shut down the remote agent, if it is running.
  2. Create a file named bamboo-capabilities.properties on the agent machine.
  3. Edit the bamboo-capabilities.properties file and add the desired capabilities to the agent as desired. You need to follow the capability formats below in the file:
    (tick) Tip: Use '\' to escape the spaces, periods and backslashes ('\').

    • JDK capabilities — system.jdk.JDK\ <jdk number>=<jdk location>
      Examples:

      system.jdk.JDK\ 1.6=/System/Library/Frameworks/JavaVM.framework/Versions/1.6
system.jdk.JDK\ 1.6=C:\\Program Files\\Java\\jdk6.0.17

      Note the double backslashes in the path for the example above.

    • Builder capabilities — system.builder.<builder type>.<builder label>=<builder path>
      Examples:

      system.builder.ant.Ant=/opt/apache-ant-1.7.1
system.builder.maven.Maven\ 1=/opt/maven-1.0.2
system.builder.mvn2.Maven\ 2=/opt/maven-2.0

    • Perforce capabilities — system.perforce=<perforce executable location>
      Example:

      system.perforce=/usr/bin/p4

    • Custom capabilities — <custom capability name>=<custom capability value>
      Example:

      system.os=osx
  4. Save your changes to the bamboo-capabilities.properties file.
  5. Start up your remote agent. The capabilities defined in the bamboo-capabilities.properties file will be configured for your agent.

4 Comments

  1. Haikal Saadh

    Jan 13, 2010

    It's worth noting that capabilities MUST start with system. Any properties not starting with system seem to be ignored.

    1. Shihwei Li

      Nov 01, 2011

      Except for the custom capabilities

  2. Charles Albrecht

    Mar 03, 2011

    Note that the perforce capability listed is incorrect. It should be system.p4Executable:

     
system.p4Executable=/usr/bin/p4

    1. Ivan Ivanov

      Feb 21, 2012

      I confirm system.p4Executable is the correct name for the perforce capability.



Log a request with our support team.



Raise an issue for our developers.



See answers from the community.



Blog and update our documentation.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.