47Modules9Plugins
Ansible content that interacts with the AWX or Automation Platform Controller API.
This Ansible collection allows for easy interaction with an Red Hat Ansible Automation Platform server via Ansible playbooks.
This source for this collection lives in the awx_collection
folder inside of the
AWX GitHub repository.
The previous home for this collection was inside the folder lib/ansible/modules/web_infrastructure/ansible_tower in the Ansible repo,
as well as other places for the inventory plugin, module utils, and
doc fragment.
This collection should be installed from Content Hub
Non-deprecated modules in this collection have no Python requirements, but
may require the AWX CLI
in the future. The DOCUMENTATION
for each module will report this.
You can specify authentication by a combination of either:
The OAuth2 token is the preferred method. You can obtain a token via the
login
command with the AWX CLI.
These can be specified via (from highest to lowest precedence):
tower_config_file
parameter~/.tower_cli.cfg
/etc/tower/tower_cli.cfg
Config file syntax looks like this:
[general]
host = https://localhost:8043
verify_ssl = true
oauth_token = LEdCpKVKc4znzffcpQL5vLG8oyeku6
Notable releases of the ansible.controller
collection:
The following notes are changes that may require changes to playbooks:
credential
module no longer allows kind
as a parameter; additionally, inputs
must now be used with a variety of key/value parameters to go with it (e.g., become_method
)job_wait
module no longer allows min_interval
/ max_interval
parameters; use interval
insteadnotification_template
requires various notification configuration information to be listed as a dictionary under the notification_configuration
parameter (e.g., use_ssl
)inventory_source
module, the source_project
(when provided) lookup defaults to the specified organization in the same way the inventory is looked uptower_notification
was renamed tower_notification_template
. In ansible >= 2.10
there is a seamless redirect. Ansible 2.9 does not respect the redirect.wait
parameter, if desired.TOWER_CERTIFICATE
environment variable no longer works.Type changes of variable fields:
extra_vars
in the tower_job_launch
module worked with a list
previously, but now only works with a dict
type
extra_vars
in the tower_workflow_job_template
module worked with a string
previously but now expects a dict
extra_vars
parameter is used with the tower_job_launch
module, the launch will fail unless ask_extra_vars
or survey_enabled
is explicitly set to True
on the Job TemplateThe variables
parameter in the tower_group
, tower_host
and tower_inventory
modules now expects a dict
type and no longer supports the use of @
syntax for a file
Type changes of other types of fields:
inputs
or injectors
in the tower_credential_type
module worked with a string previously but now expects a dict
schema
in the tower_workflow_job_template
module worked with a string
previously but not expects a list
of dict
s
tower_group
used to also service inventory sources, but this functionality has been removed from this module; use tower_inventory_source
instead.
tower_config
file used to handle k=v
pairs on a single line; this is no longer supported. Please use a file formatted as yaml
, json
or ini
only.credential_type
) have been removed. Use of id
is recommended.tower_job_template
no longer supports the deprecated extra_vars_path
parameter, please use extra_vars
with the lookup plugin to replace this functionality.notification_configuration
parameter of tower_notification_template
has changed from a string to a dict. Please use the lookup
plugin to read an existing file into a dict.tower_credential
no longer supports passing a file name to ssh_key_data
.notification_type
has been removed and can no longer be created using the tower_notification_template
module.lookup
as opposed to query
All content in this folder is licensed under the same license as Ansible, which is the same as the license that applied before the split into an independent collection.
Product |
---|
Red Hat Ansible Automation Platform 2.4 |
Red Hat Ansible Automation Platform 2.5 |
The Red Hat Ecosystem Catalog is the official source for discovering and learning more about the Red Hat Ecosystem of both Red Hat and certified third-party products and services.
We’re the world’s leading provider of enterprise open source solutions—including Linux, cloud, container, and Kubernetes. We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.