Sending a pipeline parameter to a bash or Ansible script is easy, but the reverse is less obvious.<\/p>\n\n\n\n
In this article, we’ll look at how to return parameters from an Ansible script to a Cloudbees CD\/RO job.<\/p>\n\n\n\n
You can easily transfer a parameter from the Cloudbees CD\/RO procedure to an Ansible script. Simply pass the parameter or variable to the command to execute:<\/p>\n\n\n\n
ansible-playbook playbooks\/pipeline_action.yml -l $[ansibleHost] -e myAnsibleParam=\"${myCDParams}\"<\/code><\/pre>\n\n\n\nTypes of arguments<\/h3>\n\n\n\n
Many kinds of data can be used to transfer values to Ansible script:<\/p>\n\n\n\n
\n- Input Parameter, from pipeline or procedure form. Exemple: $[myParameter] <\/li>\n\n\n\n
- Properties, from any object in Cloudbees CD\/RO. Exemple: $[\/projects\/my_project_name\/my_property]<\/li>\n\n\n\n
- Variable, define on procedure runtime. Exemple: ${my_varaibles}<\/li>\n<\/ul>\n\n\n\n
Getting data, the hard way<\/h2>\n\n\n\n
Sending data is easy, but receiving data from a script to use it into a pipeline is more complicated.<\/p>\n\n\n\n
To obtain data from a script, you need to run a script that creates a property for the job. After that, the property can be used in the procedure run.<\/p>\n\n\n\n
Running a script to get data<\/h3>\n\n\n\n
Simply run a script, such as:<\/p>\n\n\n\n
ansible-playbook playbooks\/get_values.yml <\/code><\/pre>\n\n\n\nParameter transfer takes place inside the script using the Cloudbees CD\/RO command ectool:<\/p>\n\n\n\n
- name: Define environment\n command: \"ectool setProperty \/myJob\/environmentCreated {{ success_state }}\"<\/code><\/pre>\n\n\n\nThis task defines an “environmentCreated” property in the job scope with as value for the ansible variable success_state.<\/p>\n\n\n\n
You can create as many properties as you need.<\/p>\n\n\n\n
Using the property<\/h3>\n\n\n\n
Like all properties, it can be accessed using $[\u2026]
Example: <\/p>\n\n\n\n
if [[ \"$[\/myJob\/environmentCreated]\" == \"success\" ]]; then\n ...\n<\/code><\/pre>\n\n\n\nConclusion<\/h2>\n\n\n\n
Retrieving values from a script in Cloudbees pipelines is perfectly possible using ectool, however, scripts need to be adapted to define properties that can be used in procedures.<\/p>\n\n\n\n