F5 BIG-IP Imperative Collection for Ansible

Description

This collection provides imperative Ansible modules and plugins for managing F5 BIG-IP and BIG-IQ devices. It enables automation of configuration, deployment, and management tasks for F5 devices, making it easier for network and automation engineers to integrate F5 solutions into their infrastructure-as-code workflows. The collection is designed for users who need to automate F5 device management, streamline operations, and ensure consistency across environments.

Requirements

• Ansible >= 2.16
• Python >= 3.9
• packaging (Python library)

Installation

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

ansible-galaxy collection install f5networks.f5_modules

To specify the installation location, use the -p option. For example:

ansible-galaxy collection install f5networks.f5_modules -p ./collections

If you specify a folder, make sure to update your ansible.cfg so Ansible will check this folder as well. For example, add:

collections_paths = ./collections

to your ansible.cfg.

You can also include it in a requirements.yml file and install with:

collections:
  - name: f5networks.f5_modules

ansible-galaxy collection install -r requirements.yml

To upgrade to the latest version:

ansible-galaxy collection install f5networks.f5_modules --upgrade

To install a specific version (e.g., 1.0.0):

ansible-galaxy collection install f5networks.f5_modules:==1.0.0

See using Ansible collections for more details.

Example Usage

To use a module from this collection, reference the full namespace, collection, and module name:

---
- name: Using F5 BIG-IP Collection
  hosts: f5
  connection: local
  tasks:
    - f5networks.f5_modules.bigip_pool:
        name: my-pool
        ...

Running the Collection in an Execution Environment (EE)

You can run this collection inside an Ansible Execution Environment (EE) container. This approach ensures all required package dependencies and minimum supported Python versions are installed in an isolated container, minimizing environment-related issues during runtime.

To use the collection in an EE, add it to your requirements.yml file. For example:

---
collections:
  - name: ansible.netcommon
    version: ">=2.0.0"
  - name: f5networks.f5_modules

When building your EE container, include this requirements file. For more information on building and using EEs, see the execenv

For F5-specific EE usage and advanced scenarios, refer to the F5 execenv documentation.

Testing

This collection has been tested on:

• F5 BIG-IP and BIG-IQ virtual editions
• Supported Ansible versions (>=2.16)
• Python 3.9+

Testing includes unit, integration, and system tests. Some modules may require access to a live F5 device or a suitable test environment. Known exceptions and workarounds are documented in the module documentation.

Support

As Red Hat Ansible Certified Content, this collection is entitled to support through the Ansible Automation Platform (AAP) using the Create issue button on the top right corner.

If a support case cannot be opened with Red Hat and the collection has been obtained either from Galaxy or GitHub, you can report issues on the GitHub issue tracker.

Please refer to the support_policy for details

Release Notes

See the Changelog for release notes

License Information

Published under GPL V3. See the LICENSE file included in the collection for details.

Contributor License Agreement

Individuals or business entities who contribute to this project must complete and submit the F5 Contributor License Agreement to [email protected] prior to their code submission being included in this project.

Copyright

Copyright 2025 F5 Networks Inc.