Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

Ansible Tower is a web-based solution that makes Ansible easier to use for IT teams of all kinds. It is designed to be the hub for all of your automation tasks.

This document provides information about the Ansible Tower connector, which facilitates automated interactions with Ansible Tower using FortiSOAR™ playbooks. Add the Ansible Tower connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving job status and templates from Ansible Tower, or launching jobs on Ansible Tower.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-ansible-tower

For the detailed procedure to install a connector, click here

Prerequisites to configuring the connector

  • You must have the URL of Ansible Tower server to which you will connect and perform automated operations and credentials to access that server.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the connectors page, select the Ansible Tower connector and click Configure to configure the following parameters:

Parameter Description
Server URL URL of the Ansible Tower to which you will connect and perform automated operations.
Username Username to access the Ansible Tower.
Password Password to access the Ansible Tower.

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 and onwards:

Function Description Annotation and Category
Launch a Job Launch a new job based on a job template name. launch_job
Miscellaneous
Get Job Status Retrieve the job status of specified job ID. get_job_status
Miscellaneous
List Job Templates Retrieve a list of job templates from Ansible Tower. list_job_templates
Miscellaneous
Search Job Templates Search for a specific job template by name. search_job_templates
Miscellaneous
List Users Retrieve a list of users. list_users
Investigation

operation: Launch a Job

Input parameters

Parameter Description
Template Name Provide a name for the job template to launch a new job.

Output

The output contains the following populated JSON schema:
{
     "job_status": {}
}

operation: Get Job Status

Input parameters

Parameter Description
Job ID Primary key of the resource to retrieve status from.

Output

The output contains the following populated JSON schema:
{
     "job_status": {}
}

operation: List Job Templates

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
     "job_templates": {}
}

operation: Search Job Templates

Input parameters

Parameter Description
Template Name Provide a name of the job template to search.

Output

The output contains the following populated JSON schema:
{
     "job_templates": {}
}

operation: List Users

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
     "users": {}
}

Included playbooks

The Sample - Ansible Tower - 1.0.0 playbook collection comes bundled with the Ansible Tower connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Ansible Tower connector.

  • Get Job Status
  • Launch a Job
  • List Job Templates
  • List Users
  • Search Job Templates

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.

About the connector

Ansible Tower is a web-based solution that makes Ansible easier to use for IT teams of all kinds. It is designed to be the hub for all of your automation tasks.

This document provides information about the Ansible Tower connector, which facilitates automated interactions with Ansible Tower using FortiSOAR™ playbooks. Add the Ansible Tower connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving job status and templates from Ansible Tower, or launching jobs on Ansible Tower.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-ansible-tower

For the detailed procedure to install a connector, click here

Prerequisites to configuring the connector

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the connectors page, select the Ansible Tower connector and click Configure to configure the following parameters:

Parameter Description
Server URL URL of the Ansible Tower to which you will connect and perform automated operations.
Username Username to access the Ansible Tower.
Password Password to access the Ansible Tower.

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 and onwards:

Function Description Annotation and Category
Launch a Job Launch a new job based on a job template name. launch_job
Miscellaneous
Get Job Status Retrieve the job status of specified job ID. get_job_status
Miscellaneous
List Job Templates Retrieve a list of job templates from Ansible Tower. list_job_templates
Miscellaneous
Search Job Templates Search for a specific job template by name. search_job_templates
Miscellaneous
List Users Retrieve a list of users. list_users
Investigation

operation: Launch a Job

Input parameters

Parameter Description
Template Name Provide a name for the job template to launch a new job.

Output

The output contains the following populated JSON schema:
{
     "job_status": {}
}

operation: Get Job Status

Input parameters

Parameter Description
Job ID Primary key of the resource to retrieve status from.

Output

The output contains the following populated JSON schema:
{
     "job_status": {}
}

operation: List Job Templates

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
     "job_templates": {}
}

operation: Search Job Templates

Input parameters

Parameter Description
Template Name Provide a name of the job template to search.

Output

The output contains the following populated JSON schema:
{
     "job_templates": {}
}

operation: List Users

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
     "users": {}
}

Included playbooks

The Sample - Ansible Tower - 1.0.0 playbook collection comes bundled with the Ansible Tower connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Ansible Tower connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.