Ansible

Flow Designer has built-in steps to help you integrate Ansible Automation Controller into your event management and incident response flows.

Prerequisites

All requests from xMatters to Ansible Automation Controller must be made through the Agent. If you do not already have an agent installed and running, see Download and install the agent.

The following step is available:

  • Launch Job Template: Launch a job template in Ansible Automation Controller.

 

To add an Ansible step to your flow:

  1. Go to the Apps tab of the palette, expand the Ansible section, and drag the Launch Job Template step onto the canvas.
  2. Connect the step to the previous step in the flow. This gives you access to the alert properties and outputs of previous steps when you configure this step's inputs.
  3. Double-click the step to edit it, and use the Setup tab to configure the inputs. You can use plain text and input variables (or both). See the following section for detailed information on the inputs, including which are required.
  4. Click the Run Location tab and select the Agent to use to send requests to Ansible.
  5. Click Done.

Launch Job Template

Use the Launch Job Template step to launch an Ansible job template. Map outputs from previous steps to the inputs to create the comment and determine what incident to comment on.

Inputs

Inputs with an asterisk* are required. Any additional fields not covered by the following table must be added to your Ansible job template. For examples of additional fields, see the Ansible documentation.

Label

 Description

Ansible Base URL*

 Base URL of Ansible automation controller server to connect to.
Username* Username to log into Ansible Automation Platform.
Password* Password to log into Ansible Automation Platform.
Job Template ID* Unique ID of the Ansible job template.
Inventory ID Unique ID of the Ansible inventory used to run the playbook.
Job Type

Type of job to run. Available values are:

  • run
  • check
Variables JSON-formatted list of key/value pairs (required or extra) to run the job with.
Forks Number of parallel or simultaneous processes to use while executing the playbook.
Limit Pattern used to constrain the hosts managed or affected by the playbook. Multiple patterns must be separated with colons.
Verbosity Numerical level of output Ansible produces as the playbook executed. Default value is: 0 – Normal.
Job Slicing Number of job template slices at runtime. Each slice runs the same tasks against a portion of the inventory.

Outputs

Label

 Description

Job ID

 Unique ID of the job in Ansible.
Raw Request JSON representation of the request that can be parsed separately to get additional context on outputs.