- 23 Oct 2024
-
DarkLight
-
PDF
Add a New Playbook
- Updated on 23 Oct 2024
-
DarkLight
-
PDF
New playbooks must be added first before they can be viewed in Automation Gateway.
Default Location to Add Playbooks
The default location for custom content to add a playbook is /usr/share/automation-gateway/ansible/playbooks
, or you can customize the folder path and add it to the Configuration/Ansible/Playbook Paths
array (Figure 1). Once a Playbook is copied or downloaded to a folder in the Playbook Paths array and the Playbooks in Automation Gateway are refreshed, it will display.
Figure 1: Default Playbook Location
Add a Playbook to Automation Gateway
Once a new playbook is added to Ansible, it can be added to Automation Gateway.
- Navigate to the API Documentation within Automation Gateway.
- Find and expand the
POST /playbooks/refresh
. - Click Try it out!
- Click Execute to re-sync the playbooks.
- Verify the response code. Response Code 200 indicates the retrieval was successful.
- Go back to the Playbooks section of Automation Gateway to view the newly added playbook.
Figure 2: Add Playbook
Figure 3: Playbook Response
When viewing the execution result of an Ansible playbook run, Itential Automation Gateway has been updated to address issues related to using the UI to view execution output that exceeds 1MB. If IAG detects the output is greater than 1MB, the output will not be displayed in the browser. Users will be provided with the option of downloading the output to their local system.