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.
Connector Version: 1.0.0
Authored By: Fortinet
Certified: No
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
For the procedure to configure a connector, click here
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. |
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 |
Parameter | Description |
---|---|
Template Name | Provide a name for the job template to launch a new job. |
The output contains the following populated JSON schema:
{
"job_status": {}
}
Parameter | Description |
---|---|
Job ID | Primary key of the resource to retrieve status from. |
The output contains the following populated JSON schema:
{
"job_status": {}
}
None.
The output contains the following populated JSON schema:
{
"job_templates": {}
}
Parameter | Description |
---|---|
Template Name | Provide a name of the job template to search. |
The output contains the following populated JSON schema:
{
"job_templates": {}
}
None.
The output contains the following populated JSON schema:
{
"users": {}
}
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.
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.
Connector Version: 1.0.0
Authored By: Fortinet
Certified: No
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
For the procedure to configure a connector, click here
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. |
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 |
Parameter | Description |
---|---|
Template Name | Provide a name for the job template to launch a new job. |
The output contains the following populated JSON schema:
{
"job_status": {}
}
Parameter | Description |
---|---|
Job ID | Primary key of the resource to retrieve status from. |
The output contains the following populated JSON schema:
{
"job_status": {}
}
None.
The output contains the following populated JSON schema:
{
"job_templates": {}
}
Parameter | Description |
---|---|
Template Name | Provide a name of the job template to search. |
The output contains the following populated JSON schema:
{
"job_templates": {}
}
None.
The output contains the following populated JSON schema:
{
"users": {}
}
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.