The F5OS Ansible Collection enables automation and lifecycle management of F5OS devices, including Velos chassis and rSeries platforms. It provides resources for managing tenants, partitions, users, and device configurations via the F5OS OpenAPI. This collection is ideal for network engineers, DevOps teams, and IT administrators seeking to automate F5OS device operations, streamline deployments, and ensure consistent configuration management.
Key Benefits:
- Automate F5OS device onboarding, configuration, and lifecycle tasks
- Integrate with Ansible Automation Platform and Execution Environments
- Support for Velos and rSeries platforms with F5OS API access
- Ansible: >= 2.16
- Python: >= 3.9
- Dependencies:
- ansible.netcommon
- F5OS device with API access
- Additional prerequisites may include network connectivity and authentication credentials for F5OS devices.
Install the collection from Ansible Galaxy:
ansible-galaxy collection install f5networks.f5os
To install the collection in a custom path (e.g., ./collections), use the -p option:
ansible-galaxy collection install f5networks.f5os -p ./collections
Or via a requirements.yml file:
collections:
- name: f5networks.f5osTo upgrade to the latest version:
ansible-galaxy collection install f5networks.f5os --upgrade
To install a specific version (e.g., 1.0.0):
ansible-galaxy collection install f5networks.f5os:==1.0.0
See using Ansible collections for more details.
Authentication:
- Ensure you have valid credentials and API access to your F5OS device.
- See f5execenv for Execution Environment setup.
To use a module from this collection, please refer f5os-guide
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.f5osWhen building your EE container, include this requirements file. For more information on building and using EEs, see the execenv
- User and Role Management: Automate creation, update, and deletion of users and roles on F5OS devices.
- Device Onboarding: Provision new Velos or rSeries devices with initial configuration and tenant setup.
- Partition and Tenant Operations: Create, update, and remove partitions and tenants declaratively.
- The collection is tested on Python 3.9+ and Ansible 2.16+.
- Functional and unit tests are run against Velos and rSeries platforms.
Contributions are welcome! Please review the F5 Contributor License Agreement and submit it to Ansible_CLA@f5.com before submitting code. For guidelines, see repoinstall.
If you encounter a bug or other issue while using the Ansible Provider, use F5 Technical Support to submit it to our team.
Important: As of July 2026, GitHub issues are no longer being monitored by F5 support staff.
Be sure to see the Ansible documentation for more details and supported versions of the Ansible Provider.
Published under GPL V3. See the LICENSE file included in the collection for details.
Copyright 2025 F5 Networks Inc.