Run Ansible Playbook (bash)

Octopus.Script exported 2023-02-16 by domrichardson belongs to ‘Ansible’ category.

Step template to run an ansible playbook using bash. Requires Ansible and Ansible-Playbook to run successfully.

Parameters

When steps based on the template are included in a project’s deployment process, the parameters below can be set.

Ansible Playbook Path

RunAnsible.Playbook.Path =

Enter the full path where the Ansible Playbook yaml is located.

Script body

Steps based on this template will execute the following Bash script.

ansibleInstalled=$(which -a ansible-playbook >/dev/null; echo $?)

if [ $ansibleInstalled -ne 0 ];then
	echo "Ansible Not Installed"
    exit 1;
fi


ansible-playbook $(get_octopusvariable "RunAnsible.Playbook.Path")
playbookRC=$?

if [ $playbookRC -ne 0 ]; then
  exit $playbookRC;
fi

Provided under the Apache License version 2.0.

Report an issue

To use this template in Octopus Deploy, copy the JSON below and paste it into the Library → Step templates → Import dialog.

{
  "Id": "02d3b753-e0eb-4bda-9bf3-09c77e54fce1",
  "Name": "Run Ansible Playbook (bash)",
  "Description": "Step template to run an ansible playbook using bash. Requires Ansible and Ansible-Playbook to run successfully.",
  "Version": 1,
  "ExportedAt": "2023-02-16T11:39:51.509Z",
  "ActionType": "Octopus.Script",
  "Author": "domrichardson",
  "Packages": [],
  "Parameters": [
    {
      "Id": "c9c94c61-07a7-4e7e-a52c-fec79ecd50d6",
      "Name": "RunAnsible.Playbook.Path",
      "Label": "Ansible Playbook Path",
      "HelpText": "Enter the full path where the Ansible Playbook yaml is located.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    }
  ],
  "Properties": {
    "Octopus.Action.Script.ScriptSource": "Inline",
    "Octopus.Action.Script.Syntax": "Bash",
    "Octopus.Action.Script.ScriptBody": "ansibleInstalled=$(which -a ansible-playbook >/dev/null; echo $?)\n\nif [ $ansibleInstalled -ne 0 ];then\n\techo \"Ansible Not Installed\"\n    exit 1;\nfi\n\n\nansible-playbook $(get_octopusvariable \"RunAnsible.Playbook.Path\")\nplaybookRC=$?\n\nif [ $playbookRC -ne 0 ]; then\n  exit $playbookRC;\nfi"
  },
  "Category": "Ansible",
  "HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates//opt/buildagent/work/75443764cd38076d/step-templates/ansible-run-playbook.json",
  "Website": "/step-templates/02d3b753-e0eb-4bda-9bf3-09c77e54fce1",
  "Logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAABmJLR0QAAAAAAAD5Q7t/AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH4gUIEhU7AxDPmAAAGmlJREFUeNrtnXd8VFXax7/TUiEFwlAmYYAElq4URZT+goiAqCiKFBsvKooiLSC66qtrQRAEFhAFFJcVEKQoIIgU3V0LunwUCxBQL+FSroaQTHomM+8fM2GzCOSmzMy9c8/388mHkjPnzj33/O7zPKc8BwQCgUAgEAgEAoFAIBAIBAKBQCAQCAQCgUAgEAgEAoFAIBAIBAKBQCAQCAQCgUAgEAgEAoFAIBAIBAItYnc4dVWv4D+YRBMETBRWIAGIA2KBhkAHoCXgABoDjQA7EHmZqvKAUxV+MoGf/D85/t/nKLKUc6F4FFkSD0IIJLSWoWIntDucHYAhQG+gKRDv/4kN0FdwlwsEyAa+B/YAmxVZyhJiEQIJpRgS/FahFzAcGKixr5wNbAHeA34ATiuyVCSepBBIoIUxChgHtACaAFYd3IbL7559ASxSZGm/eLJCILUiCrvDGQ+0Bv4XuD9MblEGFgKbgZ8VWSoRrpgQSFVF0gh4EegPJIfpbRYDR4EViiy9KkQiBHJRawGgyBJ2hzMKaA88C9xowOZ41i+W40IsQiAXulLjgUnAnwCzgZslH/gamKrI0tcVXyBCIAYTht3hjAauA1aGsRtVE9YBTyqylGFUi2JYC2J3OAcDc/wBuODSlAD/AkYpsnTSaCIxGVAYrYAFaG/eQg9MA5YrspRtFKGYDCCIinHGKuBWAjezbQRkIF2RpdXCgoSPMLoBm/CtfRLUDluBhxRZygznmwzb0ZoK4tjo96GFOGqXwcBBu8M5rfyFFI5YwtiCdI6NS/gW6IKY7wkUUcCA2LiEFsCn+a6cQrvDSb4rR1gQrbpV/j/n+a1GA9GHg8JY4Hu7w3mtf/hcCESLwgDi7A7nWnwTfpGi3waVxsA/7Q7nhIs8FxGkhzoYtzucacDHQDPRV0POR4osDQqHGzGFiTj64NsoJNAOGUAvRZZO63nOxBwG4pgAfCL6o+Zo6Y9L2us5LjHpURhwfvXt88As0Rc1ixcoBfoosvS5Hi2JLi2IXxzLhDh08QKOAPbZHc479WhJdGNBKjSsGXgLGCP6n67wAEMUWdquJ0uiKwvib1QhDn1iBrbaHc6xerIkurAgFQLyZfj2hgv0ixvor8jSPj1YEpOOxCEC8vASyUBFlnYLF6t2xDFBiCOssACb7A5n6gXxpbAg1RBHH3zzHGbRr8KOM4BTkaViIZDqiSQN34ysIHw5CHQFSrQYj1g0Kgxi4xLi8K3ITRB9KKxpCCQpsrRVi0vlNSmQfFcOsXEJq/BlHBGEP1fFxiWcUGTpgNZEokkXy7+fY5LRekmZx0NJcTFlZWWYzGYiIyKwWq1Guf0ioGN5iiGtYNaQKMr/7Aw8ZCRheL1eoqOiGDZ0MBvWvst3B/aze8d2Hnrgf2mQlITX6zVCM0Th2+cugvRKhKJgoJ2AXq+XuLg4du/cRtOUlD/8PivrLMPvGMmPPx3CZDLEzuE1iiyN1Mokokkjoigf0t0I3Gwk6xFhs7H74+20TEu7ZJni4mKat2pLWVmZEZrEA/RVZOlTLYhEEy6WXxzdgJuM5lp1varLZcUBEBkZyct/eY7S0lIjNIsZ+KC8X4gY5D9swmCTgQUFBUyf8riqsv379yOpfn2jNE2c3eFcXTE2NbRA/BkPDZW3yuv10qnTlXTv1k1V+caNGtGhQ3ujBOwAI+wOZwfDu1j+XLm3YjA8Hg8zp02t0mfSp06moKDAKE1kxbe1wZgCqWA6F2DAXLkNGzak29Vdq/SZq6/qSudOV+IxjhXpbHc4JxlSIP7AfDAGzLLu8XjodlVX6lcjppgxfSpej8dIzTXD7nAmhioWCclSE/9aq2hgA5BkNIHk5Oay8b01xMfFVfmz9RLrsX7DRiO5WnWAk4osfRmKZSjmUIjDH3hdhwEPr/F4PAy+YSApydU70Kp+/Xp0u/oqPMayIq/ZHU5rKAL2UAbpKzEo06dOrtHnn336SVwul9GabakhYhB/7DEeg54JmJKcTNs2bWpUR7LDweBBNxjNitxsdzgbBTsWCYWLFYUBV+oCuN1ubhh4PXFxdWtc17QpjxvtUIf6wLBgu1mhcLHa4ztq2ZACSa+he1VO27ZtSElOMVoTzglbF6uCaXwWA+4vLysrY/SokcTHx9VKfXF16zJo4PW43W4jNWMdu8P5aDAvGFQjbXc4GwGnjGg9TCYTu3dup22b2hu4y8nJpWlqK6KioozUlEf8XkhpMNytYL/JX8SgOJs2JbVFc1VlX3l1vqpy8fFxjBk10ijL4Mtp7v8JHxfL7nBidzjjgf5GFEdJSQkj7xxBZGTlh17l5rp4/Y03+Wr/16rqfvjBB7DZbEZqThtwb7DSlwZFIH5T2BqDDu1aLBYmTXxYVdlDRw5z7lwOs+e8qqp8ixbNL7oTMcyZUaFf6VsgFVRuyJy67rIyHlMpDoB5ry3CZDJx8IcfOX3mTKXlIyMjGXnnCEpKSgzVrnaHc0RYuFgVVH6/EQVSJzaGkXfcrqrsqdNn+HDrNsxmM79nZbHv089UfW7SxIexWCxGa9oJ4RSDjDJqcJ6WmkrzZs1UlZ0zbz4RERE+t8xsZvbceaqvM2niI7iNFay3tjuc9kDHIcEaxRpnRHEUFhYxftz9qt7uObm57Nmz93weLJPJxOHDGaqtyJ133Ead2BgjNW9DfHl9dR+DJAAtjCYOr9dLvXoJ3HH7cFXlDx8+QqYs/9f/xcREM3feAlWfb96sGWmpqUZr5uGBvoA5wOIoV3oTwwXnbjd/nvWE+uB8wULfkZcVMJlM/HT4ECdPVT63arFYGD/ufgoLi4zUzPdW6Gf6E4jf/PXCt7/YUCQmJjLwenXTPllnz7Jx0weYzX98HFlZZ9m791NV9dxx+3Dq1UswUmIHu93hbBpINysYMchwo4nD6/XStk1rHE3UGc7nX3iZOnUuvi3farXy7F9eUH3tP896wmjrs27Te5BuuD3nBQWFTJ2sbkW/y+Vi76efXjKQN5lMnDx5ih07P1bX2Nf3JzEx0UjNfaOeY5AORrQe7du1oXfPHiqD8wxk+eRly0RHR7Pgr0tU1edo0oS2bVobyc1qZnc4Y3QpEGCI0QTi8XiYMV19vqt5CxdV2pl9Q75HyDxxQlWdUydPoqCw0ChNngQkBSpQD7RAehtNIPYGDbiue3d1gxjKb2z5YOtFg/MLyT53TrWb1btnD9q1aWMUKxJPAE8hC5hA7A6nFWhqNOvRpUsnGjRQl8lozqvziYhQtxLXYrFUaWZ95vSpRtqz3i5QI1mBtCAJfnUbhlyXi2eeUndadW6ui12796g+QcpkMnHq9Bk2b/lAVfnrru2OvYFhjlnpqccYJM5IAvF4PAzo15fUFuoWDRw+coQTF8ycV0ZMdDSLlryuqmyDBkl06dLJKFaku64E4g+YYjFQzl2v10t6FYLz1xb+tVoxwtGjx8jMVBes/3nWTHKNkT+rXYV+p32B+P3BhkZyr5KTk+nYvp2qstnZ51j//kZVwfmF5OS6+GDrNlVlW6al0b9vHyNYEVuFfqcbF8swcyBut5v+/foSH6/Oo3zuhZeIrVOnWteyWi28MFt99psZ6dMMMZpldzjbBaLeQAqkpVEEUlpaysx0de6Vy+Viz759WKu5wclkMuHKzWXN2vfUvaXatyM52WGEx9BSbwIxxFMpKyvj9ttupX69eqrKH8k4WunMeWVERUXx5sq3KCur3HVKiI+nf9++Rlif5dCbQBobQSC+hAyPqC6/YNHiWnF5jh47hnRcnc89Y/oUIxwA2lgIRIM0TUmhZZq6jUq/Z2Xx/uYt1QrO/+iq5bFx0xZVZZOSkrh9+C3hnj9LdwIJ+1mqkpISbh9+i+rMhouXLMNirp0mt1iszJ2/QHX5xx59JNwTOzTQm0Aiw10gXrxVOutj4sMP0q9P71pxd0wmyM/PZ+Xb76iLYNPSwj1/VqzeBBL2wfnECVXLPJOQkMD7763hrjt8KZ1qGotERUWx4q1Vqlyn6Kgobr1lGCXhG4tYhUA0RHR0NGNG3VnFt74vV/iiBfN4a/my8/+uCb/++ivHMzPVBevTpuD1hu2kobAgWiIttQUtmlc/h/Kggdeza8dWGtob1Gimu6CwkL+vWadaoI88+GC4ButeIRCNUFRUxH13j1W9EvdSdGjXjs/27KJ3rx4UFVUvG4nVamX+wkWqy48ZfRfR0dHh+FhMQiBaeE15vdStW5cxo++qlfri4+NZv+bvPP7YxGq7XKUlbpa8/oaqsi2aN1O94lhn5AiBaAC3282smem1Xu8zT81i/ZrVeDyeKgfvkZERvLt2naoE1jabjXvvHlNti6XlR6M3geSFo0ASEuIZOnhQQOrucd21HDywn5ZpqZRWcWnIL7/8yi+//Kqq7N1jRlGnTp1wW8SYpzeBhN1Ra16vl9Z/akWyI3DLzBo1bMjH2z/k3rGjq3SkQWFREe/8/V3V5Z9In4bbHVbB+mkhkBBTUFjI5EfVnyE5NX0mi1XGBhWJiYlh7uyXmD5lMlarVdWb3mKxsHjJMtXXGDZ0SK0dKKoRTgmBhNh6tGrZkv79+6kq78rLY+++z3jm/55n9D3VOxplZvpUNm9Yp3rUyYuXea8tVFU2OdnBn1q1DCc366TeBJIZTgLx5buaorr8kYwMMk+cwGQysf2jHVzbuy8nT1b9ndG1S2e+/eZLWrVMq3S+JCIigjXvrVftmj3+2EQKwyd/VqbeBHIonASSlJSkOlsiwKLFr5+fkLNarWRkHKN3/4F8smdv1QcG4uP5ZMc27h4zGlcle8yPH8/kV0ndMviBA/qTlpoaLlbkkN4E8mM4WY9OV3Skod2uzr1yuXh37br/Wj1rNptx5eZy56ixrFu/ocrfISIigjkvv8CyxYuIiIi4ZKcuLS3l9TdXqK53+rTJYbFnXZEl/VgQf3aJHAI0Nh1sXHl5PDVrhuryz7/4MrExMReJEXxCefjRx7n/gQnnY5uqMHrUSHbv3EZiYuJFdxRaLBaWr3hb9Yrhfr17kVS/vt4fUVaFfqd9gfizS+QRBnMhHo+H67p3p22bNqrK5+Xl8/Enuy+7DMVsNrNx02aG3nIb585VfQK4ZVoa333zJdd0u+qiW2nNZhOvqjyZqmHDhlxxRUe9u1nfVuh3unGxcgjQ9H8w8Xq9VbIeGRkZnDhReUI4m83G5198Sc9+A/j+h6p7o5GRkWxav5anZ838g7Ww2Wxs3PIBBQXqAvAnZ6ZXGttonH8GquKACUSRpRwgW+8CadKkCVd0UJ/BaMHiJXhUvo0tFguKotC9Rx82qkwpWhGr1cqjEx9m4fy5xMbE/FcsIR0/ztFjx1TV06F9O67pdrWeY5F/6U4gfn7QszjKysro17sXiYnqkodnZ2ez4f1NVdpWazKZiImN4YGHHuGxydOq9T1HjbyTj7d/SJMmTc6PnJWWlrKsCsH6U7Nm6tXNcgOSXo8/2K1ngRSXlJBehbmPV+cvxGazVetaJpOJVX9bzaChN3P2bNUNb2pqC779+gv69O6Jx+PFYrHw1qp3KC4uVvX5K6/oSOPGusyzkQ1k6zG7O8BmPQfnN980hMaNGqkMzvPYvnNnjfaIRERE8PU3/6Znv/58d/Bgtep4793VPPfMU+Tk5hIREcELL81W9bl6iYn06dlDj5upsoDfdedi2R1OFFnK0mscYjabmfyY+nVXRzKOqk4qXdl1f/89i+tvvImduz6pliV6cPw4dm3/kAYNktjy4TYKCgpUfXbG9CkUV2GBpEb4VpElt+4EUsHkbdGjQFL8a5XUsnjpslp9+3o8Hsbccz9T02dW6/M9rruWz/bsIql+fX78Sd0ks8Ph4KbBN+otWA9o/wrGhqn39CaO0tJSbho6hJgYdWdD5uXns/rdtbWad6p8d+Hylau4b/yDuPKqPqVkb9CAj7ZuVr30BGDypMdqJZlEENkQyMoD2hL+kYVmwHdAXb20eGFhEWfPnFAdT8x86mmWvbG8xnvULzlM43bTokVz3l/7LikpyQG99/z8fHr1u77Kh/uEiC8VWbrG787rz4L4v/RpArSZJRCUlZXx4Phxqjt7fn4+O3fuCpg4wDffIUnHueKqa/j0s38E9P5jY2MZMniQXnL5vn2BO68/F0uRpSLgc70IJCoqinvvHqO6fMbRY2QG4W1rMpmwWa2MuGsMz7/4ckCv9eTMdEpLNC+QUmBfwAdrgnQzi/QiEF/WD/X5rhYtXooniEOjXq+X2XNeZfQ995Ofnx+Qa9hsNsaPH6f1Id8TBGHPUVAEosjSfkDzTm1xcTFjR48iIiJCVfnc3FzWrX8/6Emho6Oj2bHzY3r3H1jjs0Yuxf33jCEyUtPplfcpsuQKC4H4Wah1gURHRzPuvntUl587f0FAY4/LPjizmczME3Tr0Zsvvvyq1utPTU2tUebIILAgKO0cxBvaDBRrtbXdbjczpqlfVpKXn8+2j3Zgs1lD+r1LSkq4dcRI/lLLcUlkRASjRt6heqlKkPlZkaUD4SaQn4GjWhVI3bp1uPXmYeqD81qaOa+N4L2srIy58xcw/YknKSysvYRwD44fR2RkhBYf13NBs9TBupAiSyXASq0KpFVayyrNMSxd9oamzv2z2WwsX/EWNwwdRnZ27a3umTZlstbON8wGdgVq9e4fXkDBvju7w6m5NdUFBQWsWb2KwYNuUFe+sJCkxinUreZRzoHE4/EQHRXFh5vfp2OH9jWu7/jxTHr2G6ClVKWfKbLUK+wsSAXFP6ulDuX1emnWzKlaHAAvvDSbaJXHroUieC8qLmbQ0Jt5Y0XNDXZKSjJpaZpKdp0e1PYMootVLpIVQL5WWrvM42HGtKmqy+cXFLB9x86QjV6pjUvcbjeTJk9j8rT0KqUwvVhdD40fT6E2LMgBRZY+D5Z7FRIXy29N9gK9tdDiCQnx7N21Q/W+j+8Ofs+AQUPQCx6Ph7ZtWrNtyyZiY2OqXU98UiPVh5UGkL6KLO0NSwtyYeynFfeqQ/v2qsUBsGjJUl1tKjKbzfx06DAdu1zNwe+/r3Y97du3C/WW3KPA18G0HiERiH/l5X5gXag7jysvj1kzpqt3r/LzWLtuve6OUzaZTLhcLgYPG87SZW9Wq47aOr66BrykyFJeIBcmakIgFWKRJ4GQbV/zeLx07dyJTldeofozc+Yt0O1Z4yaTieLiYp546mlmz5lHaWnVhm4PfPttKPeJHFdkaXmwrUcoXSwUWcoggOlaKhdIGU8/+UQVrEcBW7d9VO2kDFrBZrPx8py5DBt+O0VF6mbJX3plLjZrSO/7npC5qCESR/lfR4fqxh1NmtClc2f1DvCxo6qPW9Y6VquVr/Z/Q5drruXozz9ftuwPP/7EG8tXhvLF8G/gH4HcFHXZtgrVXftvWLY7nNOB2cG8tsfjoX27tuS6XGSfO1dp+cjISF5buBi3261bF+sPMYXFzG+//U6/ATfwwLhxzJr5x1hs+cq3efHlV3C5XKF0r+5RZClkm1NCuvnY71MmAgcBRzCvXVrqpqi4SFUDeL0QHR2l6bmPmlBSUkp0dBQjbruVlJRkTp06wwdbt3H6zBmiQrvkfYkiSxNCZT1CLpAKQhkF/A1ByPB6fXGZ1wsmk294OMTJG7KAdoosnQnllzBrQBwosrQa2Cq6aegwmXy5gq1WCxaLRQuZTZ4NtTg0Y0H8Qknxu1rxorsang8VWRqqiVhNKy2S78rJjY1L8AADRP8wNDnADbFxCXn5rtCfnmHWUssosjQbeEf0EUPziCJLmjkhWVMp9PyjWvWA74HGoq8YjncUWRobylErTQukglCuJYCnBgk0iQy0AVxaEYemYpCKVkSRpczYuITfgMGi3xgCD3CNIksntRB3aFog+a6ccldrP9AdSBP9J+wZUr4RSmsC0Xwab7vDeQRoKfpQ2BLy2fLLYdawMMr/2gvfrKpX9KWwY6kiSxMATYpDFxbEL5YOwDeATfSpsOEroCdQolVxaNqCXBC0H8S3h71U9Kuw4CDQR5ElTYtDk0H6pYJ2RZZOxMYlZAC36sXyCS7KMaAbUBAbl6C5oFx3FqTcP/WLZA0wVMQjuuUkcLUiS7mAV+vWQxcW5CKWJCM2LuFXYIheBC44bzk6A2dj4xLQgzjQWwerYEneBvoDbmFNdBNzdFZk6Wz5c9QLuvTly8fM7Q7n/wAb0dEBoQbkK6APUKQXt0q3FuQiluQToBNwRvRDTbIU6KnIUqEexaFbC3IRixKJb2lKB9EnNYOmZ8jD2oJcxN0qBrr631iC0OIBBmt9htwwAqnwAEoUWXoIGOf3dwXBR8aXaGFbKLIgCoGoi0uWAx3R8HFvYco7QBtFlg7p3a0KS4FcIJIMRZZaAmv8Jl8QOHKAMYosjQVc4eBWhV2QXkmM0gv4AIgTfbnW+RAYr8jSqXCyGmFrQS4RwH+qyFI88C6+iUVBzckCHvWn5glbcRjFgpx/eP5l82/hW/IgqB5L0EhSNyGQwAnlcXyHQTYU/V01/8aXSPqgkW7asMvG7Q5nIjAGeE30/ctyHN/5HP9QZKk0nN0pw8UglZCtyNICfEdArPD71YL/cBQYp8iSU5GlPfg3qxlJHIa2IBdxuxoBNwOvAHUM3CwHgMnA14os5ZVP+BlNGEIglxfLo8AjQDOMsQ8+G182y3RFlj6/sD2MjBDIpQVjA5oD9/kD+nDkZ+A5YJciSyeEMIRAqmRRKroWdodzBDABaI1+R79KgRPAPmCBIksHhCiEQGrN9fL/2w44geHAvYBdB7fxBbDKL4xMRZZc4skKgQRLME7gNuBGv3CSCN0hQG5/PJEFfAtsATb4twMIhEBCLpbYCgJpD/TAl1+4XYCC/XIh/BPfmfOSXyC/K7LkvtT3FAiBaCZ2ueB37fDlGXbgO/+ksd9Fi8E3HxOLLwmFCd8qWTeQB5wGTuFLm5MJHFJkKbMywQoEuhKNXuoVCAQCgUAgEAgEAoFAIBAIBAKBQCAQCAQCgUAgEAgEAoFAIBAIBAKBQCAQCAQCgUAgEAgEAoFAUDn/D8eck5/Vh1jbAAAAAElFTkSuQmCC",
  "$Meta": {
    "Type": "ActionTemplate"
  }
}

History

Page updated on Thursday, February 16, 2023