F5 Modules for Ansible¶
Welcome to the F5 Modules for Ansible documentation.
Use these modules to create, edit, update, and delete configuration objects on BIG-IP 12.0.0 and later, and BIG-IQ 5.4.0 and later.
The code is open source and available on github. Additionally, some modules have been promoted to the Ansible core product and Ansible extras.
Support Details
User's Guide
Module Reference
Developer's Guide
- F5 Networks Contributor License Agreement
- How to get involved
- Guidelines
- Tutorial: Writing a module
- Code conventions
- Use the complex/structure map format
- Alphabetize the module’s parameters
- Use double quotes for strings
- Do not use quotes for numbers
- Begin YAML files with a triple-dash
- Give each task a name
- Always include a DOCUMENTATION variable
- Always include an EXAMPLES variable
- Always include a RETURN variable
- Make the author field a list
- Use GitHub handle for the author name
- Use 2 spaces in DOCUMENTATION, EXAMPLES, and RETURN
- Use Ansible lookup plugins where appropriate
- Always expand lists in the various documentation variables
- Specify the BIG-IP version
- Never raise a general exception
- Support check mode
- Do not use local_action in your EXAMPLES
- Set default EXAMPLE parameters
- Assign values before returning them
- Create a functional test for each code fix
- Exclude code from unit test coverage
- Put exception message on a new line
- Put list contents on a new line
- Include the license header
- Include the ANSIBLE_METADATA variable
- Do not include required key for non-required parameters
- Do not include default key for parameters without defaults
- Do not decompose to a *_device method if the using method is itself a *_device method
- Parameter classes
- Design patterns
- CRUDable
- Only Updatable
- Executable
- CRUDable Reference
- List item as member
- Class variables
- Common classes
- Exceptions to common classes
- Defaulting to None
- What is the layer of @property decorators all about?
- Why are they not all setters?
- Use the module_utils test suite to verify AnsibleF5Parameters classes
- Never import *
- The Changes class
- The Difference class
- API Map Adapter
- 1-to-1 Adapter
- Using SSH to configure the modules
- Tests
- Upstreaming
- Securing sensitive information
- Playbook metadata
- Deprecating functionality
- Backporting Changes