F5 Ansible Collections

Welcome to the F5 Ansible documentation.

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

Collections Summary

F5 currently maintains two different Ansible Collections for BIG-IP/BIG-IQ products.

Collection Name	Doc Reference Version	Primary Use Case	Connection Plugin
F5 Modules	v1	Imperative APIs and Tasks	LOCAL
F5 BIG-IP	v2 (Preview)	Declarative APIs and Tasks	HTTPAPI (some LOCAL)

Collection Links

Support Details

• Releases and Versioning
• Get help

F5 Modules Collection (v1)

• Install F5 Modules Collection
• F5 LOCAL Connection Plugin v1
• Example Playbook and Setup v1
• F5 Module Index

F5 BIG-IP Collection (v2 Preview)

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

Collection Porting Guides

• Porting Guides - Breaking Changes

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