List of default keys for the bamboo-capabilities.properties file

Still need help?

The Atlassian Community is here for you.

Ask the community

You can define the capabilities for a specific remote agent by using a configuration file on the agent machine. Instructions on how to configure the capabilities properties file can be found here:

The purpose of this page is to provide a list of capabilities (keys) that can be used inside the capabilities properties file. You must use '\' to escape spaces, periods and backslashes ('\') as pointed out in the document aforementioned.


JDK capabilities

system.jdk.JDK
system.jdk.JDK 1.5
system.jdk.JDK 1.6
system.jdk.JDK 1.7
system.jdk.JDK 1.8
system.jdk.JDK 1.9
system.jdk.JDK 10
system.jdk.JDK 11

Examples:

system.jdk.JDK\ <jdk number>=<jdk location>

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


Executable capabilities

# Ant
system.builder.ant.Ant
system.builder.ant.Ant 1.10
system.builder.ant.Ant 1.9
# Grails
system.builder.grailsBuilder.Grails 2.4
system.builder.grailsBuilder.Grails 3.2
system.builder.grailsBuilder.Grails 3.3
# MSBuild
system.builder.msbuild.MSBuild v4.0 (32bit)
system.builder.msbuild.MSBuild v4.0 (64bit)
# Maven
system.builder.mvn2.Maven 2
system.builder.mvn2.Maven 2.0
system.builder.mvn2.Maven 2.1
system.builder.mvn2.Maven 2.2
system.builder.mvn3.Maven 3
system.builder.mvn3.Maven 3.2
system.builder.mvn3.Maven 3.3
system.builder.mvn3.Maven 3.5
system.builder.mvn3.Maven 3.6
# Nant
system.builder.nant.Nant
# Node.js
system.builder.node.Node.js
system.builder.node.Node.js 4
system.builder.node.Node.js 6
system.builder.node.Node.js 8
system.builder.node.Node.js 10
# PHPUnit
system.builder.phpunit.PHPUnit 3.7
system.builder.phpunit.PHPUnit 4.4

Examples:

system.builder.<executable type>.<executable label>=<executable path>

system.builder.ant.Ant=/opt/apache-ant-1.7.1
system.builder.mvn2.Maven\ 2=/opt/maven-2.0
system.builder.node.Node.js\ 0.12=/opt/node-0.12/bin/node
system.builder.node.Node.js\ 4=C:\\opt\\node-4\\node.exe
system.builder.msbuild.MSBuild\ v4.0\ (64bit)=C:\\Windows\\Microsoft.NET\\Framework64\\v4.0.30319\\MSBuild.exe


Docker capabilities

system.docker.executable

Examples:

system.docker.executable=<docker executable location>

system.docker.executable=/usr/bin/docker


Version control capabilities

system.git.executable
system.hg.executable

Examples:

system.<DVCS>.executable=<DVCS command location>

system.git.executable=/usr/bin/git
system.hg.executable=/usr/bin/hg
system.git.executable=C:\\opt\\git\\bin\\git.exe
system.hg.executable=C:\\opt\\mercurial\\hg.exe


Perforce capabilities

system.p4Executable

Examples:

system.p4Executable=<perforce executable location>

system.p4Executable=/usr/bin/p4


Custom capabilities

<custom capability name>=<custom capability value>

operating.system=osx
hello=world
capability=value

You can use pretty much whatever you want here as custom – however to prevent confusion between system capabilities and custom capabilities, you might want to avoid prefixing custom capabilities with system.


Additional notes

Your Bamboo instance might already contain several other (different/custom) capabilities. Ultimately, you might want to retrieve this information directly from your Bamboo database using the following SQL statement:

select distinct KEY_IDENTIFIER 
  from CAPABILITY;

You might also be interested in using the REST API to export the remote agent capabilities:

Last modified on Jan 17, 2022

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.