Roles, Modules & Playbooks
  • 23 Oct 2024
  • Dark
    Light
  • PDF

Roles, Modules & Playbooks

  • Dark
    Light
  • PDF

Article summary

Automation Gateway aggregates all of your Ansible modules, roles, and playbooks. Along with this attribute is the ability to decorate or enhance each module, role, and playbook. With decoration, users have the flexibility to edit JSON schemas for identifying and modifying metadata such as input parameters, descriptions, or types. Decoration is currently stored in the database.

Itential Automation Gateway has been updated to address issues related to using the UI to view execution output and execution output history for Ansible playbooks when the output exceeds 1MB. In both cases, if IAG detects the output is greater than 1MB, the raw output will not be displayed in the browser. Users will have the option of downloading the output to their system.

  1. Log in to Automation Gateway. The main page displays.
  2. Click the appropriate group (Module, Roles, and Playbooks) from the left navigation menu. The navigation tree expands to display a family of configurable items in your Ansible deployment.
  3. Click the accordian arrow to expand the family, or select a card from the main canvas.
  4. From the card view, click the "eye" icon to display details for the selected item such as required parameters and other inputs.
  5. Click the Edit icon to display the metadata file (JSON schema).
  6. Modify the metadata file properties, as needed.
  7. Click Cancel ("X") to exit the file; changes will not be saved.
  8. Click Save to apply your changes.

Figure 1: Main Canvas
5_AG_ModuleFamily_Details_Icon

Figure 2: Edit Metadata Properties
02_IAG_edit_metadata_props_23.1

Figure 3: Cancel or Save Changes
03_IAG_save_cancel_changes_23.1


Click for IAG 2022.1

Import and export icons are not displayed on the Parameters tab.

IAG 2022.1 UI - Edit Icon
IAG 2022.1 Edit Properties

IAG 2022.1 UI - Schema Editor
IAG 2022.1 Schema Editor


Was this article helpful?

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.