Add an Ansible Automation Platform job template step to your automation orchestrator workflow to launch a single job template.
Before you begin
- An Ansible Automation Platform integration must exist and be enabled in automation orchestrator. If no integration is configured, the Integration dropdown displays "No AAP integrations configured" and an administrator must configure the integration.
- The Ansible Automation Platform instance must have at least one job template available in an organization that your credentials can access.
Procedure
- Navigate to the Workflows page and select the workflow you want to modify.
- Click Add step > AAP Execution > Launch AAP job template.
- Optional: In the Name field at the top left, enter a descriptive name for the step. If you do not enter a name, the system uses a default name.
- In the Integration field on the Parameters pane, select an Ansible Automation Platform integration from the dropdown.
After you select an integration, a credential status appears below the field. If a credential is already configured, its name appears. If no credential is configured, click Set up connection and select a credential from the dropdown. To create a new credential without leaving the step configuration, select Create new credential at the top of the dropdown.
If you open an existing step and the previously selected integration is no longer available, a warning appears. The system clears the integration and credential fields. Select a new integration to continue.
- For Job template, manually or dynamically select a job template:
- Optional: If you are not using expressions, a Prompt on launch section appears after you select a job template. This section is visible only if the template has at least one prompt-on-launch field enabled in Ansible Automation Platform. Configure any available fields:
- Run type: Select Run for normal execution or Check (Dry Run) to validate without making changes.
- Inventory: Override the default inventory.
- Credentials: Select one or more Ansible Automation Platform credentials to attach to the job.
- Execution environment: Override the default execution environment.
- Limit: Enter a host pattern to restrict which hosts the job runs against.
- Job tags: Enter tags to filter which tasks run. Type a tag and press Enter or comma to add it.
- Skip tags: Enter tags for tasks to skip.
- Extra variables: Enter additional variables as a JSON object. Click the expand icon to open a larger editor.
- Verbosity: Set the logging verbosity level from 0 (Normal) to 5 (WinRM Debug).
- Forks: Set the number of parallel processes.
- Job slicing: Set the number of job slices for parallel execution across inventory segments.
- Show changes: Enable diff mode to see detailed change output.
- Instance groups: Override the default instance groups.
- Labels: Select or create labels for the job.
- Optional: On the Settings tab, edit the defaults for the following fields:
-
On failure behavior: Controls what happens when a step fails.
- System default: Uses the system-wide setting configured by an administrator.
- Continue on failure: The step is marked as failed and the workflow continues to the next step.
- Stop workflow or branch on failure: The step fails and the workflow or current branch stops execution.
-
Timeout: The maximum number of seconds the step can run before automation orchestrator marks it as failed with a timeout error. If left unset, the step uses the global default for its step type.
-
Retry policy: Configures automatic retry behavior when a step fails due to transient errors. Toggle Override retry policy to enable the following fields:
max_retries: The number of retry attempts after the initial failure.
initial_interval: Seconds to wait before the first retry.
max_interval: Maximum seconds to wait between retries.
backoff_coefficient: Multiplier applied to the wait interval after each retry (1.0 = fixed interval, greater than 1.0 = exponential backoff).
When the toggle is off, the system default retry policy applies.
- Click Create or Update to save the step and add it to the canvas.
Results
- Run the workflow. Alternatively, click the options menu (⋮) on the step and select Run step to run the step with mock data or with live data from previous steps.
- In the Run details panel, confirm the run status.
-
After successful completion, click the step and check the details panel:
- Parameters shows the resolved configuration (
template, org, overrides).
- Output shows job results (
job_id, job_status, artifacts).
- Status badge shows Completed or Failed.
- If you used expressions, verify the resolved values match upstream output.
- If the run fails, click Workflow run > Run ID > Run details for detailed information and review the log files.