Last updated on: 2023-03-21 04:49:37.

F5 BIG-IP Ansible Collections

Welcome to the F5 BIG-IP Ansible documentation.

Use these Ansible Collections to create, edit, update, and delete configuration objects on BIG-IP, BIG-IQ and F5OS based platforms.

Collections Summary

F5 currently maintains three collections; two different Ansible Collections for BIG-IP/BIG-IQ products and an F5OS based platforms.

Collection Name	Primary Use Case	Connection Plugin
f5_modules	BIG-IP Imperative APIs and Tasks	LOCAL
f5_bigip	BIG-IP Declarative APIs and Tasks	HTTPAPI
f5os	F5OS based devices APIs and Tasks	HTTPAPI

Collection Links

Support Details

• Releases and Versioning
• Get help

f5_modules Collection (imperative)

• Install F5 Imperative Collection
• F5 LOCAL Connection Plugin in F5 Imperative Collection
• Example Playbook and Setup in F5 Imperative Collection
• F5 Module Index

f5_bigip Collection (declarative)

• F5 Declarative Collection
• Install F5 BIG-IP Collection v2
• F5 HTTPAPI Connection Plugin v2
• Example Playbook and Setup with F5 Declarative Collection
• F5 Module Index
• F5 Httpapi Plugin Index

F5OS Collection

• F5 F5OS Ansible Collection
• F5 Module Index
• F5 Httpapi Plugin Index

SSLO Information

• SSL Orchestrator Collection

Collection Porting Guides

• Porting Guides - Breaking Changes

Execution Environments with F5 Collections

• Installing and running collection from EE

Contributor's License Agreement

• F5 Networks Contributor License Agreement

The code is open source and available on GitHub. Links to the specific repositories are in the specific Collection docs above.