Ansible Platform Collection

Changelog for v2.7.20260313

• Added OIDC User Identity support for Ansible Automation Platform Gateway
• New modules: feature_flag, ca_certificates, role_team_assignment, role_definition
• Add request_timeout_seconds and idle_timeout_seconds to route modules
• Add enable_mtls attribute to route module for mutual TLS support
• Add associated_authenticators parameter to users module
• Add Gateway UI plugin Route Collection Module
• Enhanced organization association logic and auditor user support
• Multiple bug fixes for role assignment, object deletion, and URL handling
• Deprecated authenticator_uid and authenticators fields

Upgrading to AAP 2.7?

Ensure you are on ansible.platform >= 2.7.x before upgrading. Connection variables have changed — replace controller_host with aap_hostname pointing to your gateway URL.

See the AAP 2.7 documentation for the full upgrade guide.

Description

This collection contains modules that can be used to automate the creation of resources on an install of Ansible Automation Platform.

Requirements

This collection supports python versions >=3.11 and requires an ansible-core version of >=2.16.0.

It also requires an existing install of Ansible Automation Platform as a target.

Installation

Before using this collection, you need to install it with the Ansible Galaxy command-line tool:

ansible-galaxy collection install ansible.platform

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

collections:
  - name: ansible.platform

Note that if you install any collections from Ansible Galaxy, they will not be upgraded automatically when you upgrade the Ansible package. To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install ansible.platform --upgrade

You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 2.5.0:

ansible-galaxy collection install ansible.platform:==2.5.0

See using Ansible collections for more details.

Use Cases

This collection can be used to automate to the creation of resources inside of the Ansible Automation Platform. Things such as users, organizations and teams can be created using this collection.

Adding services (Controller, Event Driven Automation, Automation) can also be done with this collection. Nodes for those services can also be added.

Authenticating to AAP in a playbook

Connecting to AAP requires specifying authentication variables (the ones prefixed by aap_ here) in the task. Alternatively, AAP_ environment variables can also be set. For a complete list of authentication variables that can be used, please refer to the module specific documentations.

- name: Manage AAP
  hosts: localhost
  tasks:
    - name: Example for auth
      ansible.platform.<module-name>:
        your-module-parameters: parameter-values
        aap_hostname: your-hostname
        aap_username: your-username
        aap_password: your-password

Testing

This collection is tested using integration tests which can be called via ansible-test integration. If you wish to run the tests manually, we recommend using the parent Makefile via make collection-test. It will require a running version of Ansible Automation Platform.

The collection is tested against current version of Ansible Automation Platform.

Support

This collection is supported by Red Hat Engineering.

• Open a support case at Red Hat Customer Portal
• Report collection bugs or request features using the Create issue button on the Automation Hub collection page
• For community discussion, see the Ansible Forum

Release Notes and Roadmap

Changelogs can be found in the changelogs directory.

Related Information

• Ansible Automation Platform Documentation
• Using Ansible Collections
• Ansible Certified Collections README Template

License Information

GPLv3

Authors

Sean Sullivan Martin Slemr Jake Jackson Brennan Paciorek John Westcott Jessica Steurer Bryan Havenstein