How to add a requirement to a deployment environment using Bamboo Command Line Interface (CLI)

This article explains how to add a requirement to a deployment environment using the Bamboo Command Line Interface (CLI) app.

Instructions

Use the addEnvironmentRequirement action to add a requirement to a deployment environment.

  1. Execute the following CLI action: 

    --action addEnvironmentRequirement --deploymentProject "DeployProjectQA" --environment "DEV" --requirement "system.builder.ant.Ant"

    For this example, the output of the above action is as follows:

    Requirement added with id 2392067.
  2. Verify the requirements under Agents assignment as follows:

    In the mentioned action:

    • --deploymentProject value refers to the deployment project name or ID.
    • --requirement value refers to the plan requirement key, either a custom key or a system capability key.
    • --environment value refers to the deployment environment name or ID.

It is recommended to test the commands in a non-production environment or run the action with--simulate parameter to verify the behaviour before deploying.