Configuring Ansible AWX Observer jobs
Using the Ansible AWX Observer, you can define load jobs that will gather and read data from a defined Ansible AWX instance. When a load job is run, it will load a baseline topology data view from Ansible AWX through its REST APIs.
Before you begin
Important: The Ansible AWX Observer supports the on-premises Ansible AWX version 21.14.0 and Tower API version 3.8.6.
Ensure you have the Ansible AWX details to hand, such as the host, port, user and token before defining and running the observer job.
Required: Before defining the observer load job, you must obtain a personal access token (PAT) from AWX. The token authentication is recommended for the usage of Tower's API.
- Access the AWX UI.
- From the menu bar, navigate to the Users page that is under the Access section.
- Select a username, then click the Token option.
- Click the + (plus) icon.
- Leave the application field blank, and choose read for the token’s access.
Enabling access to the URL routes
To access the URL routes for the topology Swagger documentation, see the Enabling access to URL routes topic.
About this task
You define and start the following job.
Full Topology Upload job (through restapi)
By default, Load jobs are one-off, transient jobs that upload all of the requested topology data as soon as they are triggered.
You can also run these jobs (again) from the Observer UI, or schedule them to run at set times when configuring them.
Procedure
Define or edit the following parameters, then click Run job to save and run the job.
Encryption requirement: See the Configuring observer jobs security topic for more information.
| Parameter | Action | Details |
|---|---|---|
| Unique ID | Enter a unique name for the job. | Required |
| Ansible AWX hostname | Specify the Ansible AWX hostname | Required |
| Ansible AWX host port | Specify the Ansible AWX host port | Required |
| Username (owner) of the personal access token (PAT) | Specify the username (owner) of the personal access token (PAT) | Required |
| Personal access token (PAT) | Specify the personal access token (PAT) | Required. |
| HTTPS truststore file name | Specify the truststore file name. The observer generates the trust store file based on the file name provided. Tip: You can use the observer name as file name (<observer>.jks), for example Ansible.jks. |
Required. The supported format is JKS and the file is relative to $ASM_HOME/security. |
| truststore file password | Specify the truststore password the observer will use to decrypt the HTTPS truststore file. Use a password that conforms to your internal security requirements. | Required |
| Target system certificate | Specify a certificate by name to automatically create and load into the truststore | Required |
| SSL verification | Choose whether SSL validation is true or false. Turning SSL validation to false will use HTTPS without host verification. |
Optional |
| Number of jobs to display for each template | Specify the number of recent jobs that will be modeled on the topology for each of the job template. Max value is 50. Larger value might result in the topology being less perceptible | Optional |
| Connection timeout (milliseconds) | Enter a connection timeout in milliseconds | Optional. Must be a value greater than 0 (zero), and the default is 5000 (5 seconds). |
| Read timeout (milliseconds) | Enter a read timeout in milliseconds | Optional |
| Access scope | Enter text to provide a scope for the resources. Access scope can help map alerts to resources when resources in different scopes share the same parameters, such as matchTokens. | Optional. Tip: You can define access scope for locations, project names, namespaces, etc. |
| Generate debug support file | Set this parameter to 'True' in order to capture the output of the next scheduled job run as a file. This file will be stored with an observer's log files and can be used to debug observer issues, for example at the request of your designated support team, or while using a test environment. For one-off jobs (that is, Load jobs), this parameter reverts to 'False' after the next completed run. To examine the output produced, you can load the generated debug file using the File Observer. | Optional |
| Observer job description | Enter additional information to describe the job | Optional |
| Job schedule | Specify when the job runs | Optional. Load jobs only. |