Add a New Playbook
  • 23 Oct 2024
  • Dark
    Light
  • PDF

Add a New Playbook

  • Dark
    Light
  • PDF

Article summary

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
01_Playbooks_2023_1 copy

Add a Playbook to Automation Gateway

Once a new playbook is added to Ansible, it can be added to Automation Gateway.

  1. Navigate to the API Documentation within Automation Gateway.
  2. Find and expand the POST /playbooks/refresh.
  3. Click Try it out!
  4. Click Execute to re-sync the playbooks.
  5. Verify the response code. Response Code 200 indicates the retrieval was successful.
  6. Go back to the Playbooks section of Automation Gateway to view the newly added playbook.

Figure 2: Add Playbook
15_AG_API_Add_NewPlaybook_Screen_2019-04-01


Figure 3: Playbook Response
16_AG_API_New_Playbook_Responses_2019-04-01

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.


Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.