Ansible Tower¶

Release Notes¶

Release	Date	Notes
v1.0.3	7/2021	Bug fix to handle results data
v1.0.2	2/2021	Bug fix for paged results from templates, jobs, etc.
v1.0.1	12/2020	App Host support
v1.0.0	2/2020	Initial release

Resilient Circuits Components for ‘fn_ansible_tower’

This integration provides the capability to execute jobs and return job results from Ansible Tower.

Specific features include:

List Job Templates filtering by Project
Execute Job Templates, specifying name/value pairs for job template substitution
Execute ad-hoc Jobs, specifying name/value pairs for module parameters
List Jobs run filtered by status or date
Return Job run results

screenshot: main

Resilient platform >= v36.0
An Integration Server running resilient_circuits>=30.0.0
- To set up an Integration Server see: ibm.biz/res-int-server-guide

All the components for running this integration in a container already exist when using the App Host app.

To install,

Navigate to Administrative Settings and then the Apps tab.
Click the Install button and select the downloaded file: app-fn_ansible_tower-x.x.x.zip.

Go to the Configuration tab and edit the app.config file, editing the url, access credentials, etc.

Config	Required	Example	Description
username	Yes	``	User name for API access to Ansible Tower
password	Yes	``	Password for above user name
url	Yes	``	URL to Ansible Tower
cafile	Yes	`False`	False for no SSL certificate verification or path to certificate file

Install the package:

$ pip install fn_ansible_tower-x.x.x.tar.gz

Import the configurations into your app.config file:
```
$ resilient-circuits config -u
```
Import the fn_ansible_tower customizations into the Resilient platform:
```
$ resilient-circuits customize -y -l fn-ansible-tower
```

Open the config file, scroll to the bottom and edit your fn_ansible_tower configurations:

$ nano ~/.resilient/app.config

Config	Required	Example	Description
username	Yes	``	User name for API access to Ansible Tower
password	Yes	``	Password for above user name
url	Yes	``	URL to Ansible Tower
cafile	Yes	`False`	False for no SSL certificate verification or path to certificate file

Save and Close the app.config file.
[Optional]: Run selftest to test the Integration you configured:
```
$ resilient-circuits selftest -l fn-ansible-tower
```
Run resilient-circuits or restart the Service on Windows/Linux:
```
$ resilient-circuits run
```

SSH into your Integration Server.
Uninstall the package:
```
$ pip uninstall fn-ansible-tower
```
Open the config file, scroll to the [fn_ansible_tower] section and remove the section or prefix # to comment out the section.
Save and Close the app.config file.

There are several ways to verify the successful operation of a function.

When viewing an incident, use the Actions menu to view Action Status.
By default, pending and errors are displayed.
Modify the filter for actions to also show Completed actions.
Clicking on an action displays additional information on the progress made or what error occurred.

A separate log file is available to review scripting errors.
This is useful when issues occur in the pre-processing or post-processing scripts.
The default location for this log file is: /var/log/resilient-scripting/resilient-scripting.log.

By default, Resilient logs are retained at /usr/share/co3/logs.
The client.log may contain additional information regarding the execution of functions.

The log is controlled in the .resilient/app.config file under the section [resilient] and the property logdir.
The default file name is app.log.
Each function will create progress information.
Failures will show up as errors and may contain python trace statements.

No additional configuration is requirement for Ansible Tower.

Name	Version	Author	Support Email
fn_ansible_tower	1.0.0	IBM Resilient	support@resilientsystems.com