Ansible AWX is a free, open-source automation platform that provides a web-based user interface, REST API, and task engine for managing Ansible automation workflows. It’s essentially the open-source equivalent of Ansible Tower, a commercial Ansible automation platform. For more information refer Ansible AWX Documentation.
Integration Method: Data Collector (API Ingest)
Tables: Account change (3001), Device Inventory (5001), Device Config State (5002), Group Management (3006), Scheduled Job Activity (1006)
This integration supports the following events.
Event | Description |
---|---|
Activity Stream | Retrieves the list of all the activities performed. |
This integration supports the following versions.
Ansible AWX Version | 24.6.0 |
Ansible AWX API version | V2 |
Prerequisites
The user should have access to the Ansible AWX portal with an account that has the Administrator privileges.
The user should have a compatible version of the system in which we can configure the data collector. For installation steps, please follow the Data Collector configuration steps.
The user should have access to the DataBee console.
Configuration Overview
Configure the Data Collector.
Generate an API token with the required scope.
Add the Ansible AWX data feed in the DataBee console with the below parameters.
DataBee Parameter
Ansible AWX Parameter
Token
Token
Base URL
http://<host_ip>:<port> (e.g. http://x.x.x.x:9000)
Ansible AWX Configuration
On the top right corner, click on the drop down with your username.
In the dropdown menu, click User Details.
On the user details page, click Tokens.
On the “Tokens” page, click Add.
Fill in the required information in the ‘Description’ field and select Read in ‘Scope’, then click Save.
Click on the copy button.
DataBee Configuration
Login to the DataBee UI, navigate to Data > Data Feeds and click the Add New Data Feed button.
Search for the Ansible AWX and click it as shown below.
Click on the Data Collector option for collection method.
Select API Ingest as the polling mechanism.
Enter the feed contact information, select the collector which we have created previously and click Next.
In the configuration page, confirm the following:
Base URL: Paste the Base URL, including the port number, which would be the Ip address of the Ansible AWX Server.
Event Types: Preselected for all the event types that integration pulls.
Note:
Limit is set to 500 requests/60s for a high-spec (8GB RAM) setup. Use 100 requests/60s for lower-spec setups.
Paste the token generated and then click Next.
Click Submit.
Troubleshooting Tips
Ensure the token is pasted correctly. Since you cannot view the token after the 1st time, re-create the token, paste it on a text editor to ensure no spaces or unexpected characters are included and reconfigure the DataBee feed.
Ensure the Ansible AWX scopes/permissions are correct.