Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article explains how to get the list of deployment projects to a file in the Bamboo server using the app, Bamboo Command Line Interface.

...

  • Use the getDeploymentProjectList to get a list of deployment projects based on regex filtering of project names.


    Execute the below CLI action with outputFormat 999:

    To get the list of all deployment projects in a project with Id, Name, Description, Plan fields.

    Code Block
    themeMidnight
    --action getDeploymentProjectList --outputFormat 999 --file projects.csv


    Below is the output of the file projects.csv:


    Execute

The parameters used in the

...

CLI action

...

themeMidnight

...

are 

--file  
The parameters used in the CLI action are 
--file  
--outputFormat--outputFormat

...

Code Block
themeMidnight
--action getDeploymentProjectList --outputFormat 1

7 deployment projects in list
"Id","Name","Description","Plan"
"3342338","Bamboo CLI","","DEMO-DEM"
"3342337","Bamboo UI","","DEMO-DEM"
"3342340","Bobswift_Project","","DEMO-DEM"
"2588673","DeployProject1","DeployProject1 Description","DEMO-DEM"
"2850817","DeployProject2","DeployProject2 Description","DEMO-DEM"
"3342341","SQL","","DEMO-DEM"
"3342339","Witti","","DEMO-DEM"



To get the resultant output in the same terminal remove --file and add --outputFormat 1 in the above CLI action.

Info
  • It is recommended to test the commands in a non-production environment, or run the action with --simulate parameter to verify the behavior before deploying.
  • Ensure that the Bamboo Command Line Interface app is installed in your Bamboo instance.

...