Install experimental F5 Modules

When you install Ansible, it includes F5 modules.

Other F5 modules are not installed when you install Ansible. These modules are experimental and live in GitHub.

You might need to use experimental modules when you want to test something, or when you just can’t wait for a module to be upstreamed to Ansible.

You can install experimental modules on your system in one of a few ways.

Method 2: Install in your Ansible install directory

Different systems can put Ansible in different locations. The recommended way to install Ansible (via pip) puts the modules here:

  • /usr/local/lib/PYTHON_VERSION/site-packages/ansible/modules/extras/network/f5/

To install the F5 modules in this repository, you can copy the contents of the library/modules/ directory that F5 provides into the location mentioned previously.

On Mac OS X, you can use the following location for the modules:

  • /Library/Frameworks/Python.framework/Versions/[PYTHON_VERSION]/lib/python[PYTHON_VERSION]/site-packages/ansible/modules/extras/network/f5

For example:

cp library/* /usr/local/lib/PYTHON_VERSION/site-packages/ansible/modules/extras/network/f5/

This command overwrites all of the modules with the ones in this repository. If you want only one or two modules, then just copy those. For example:

cp library/ /usr/local/lib/PYTHON_VERSION/site-packages/ansible/modules/extras/network/f5/

This example copies only the bigip_iapp_service module.

Additionally, you will need to copy the module utils files in library/module_utils/ to the appropriate location on disk. This location is similar to the modules path specified above, except that it is in the ansible/module_utils/network/f5/ directory instead.

Finally, you will need to update the action plugins that the F5 modules use. These can be found in the library/plugins/action/ directory. In the same way that you moved the modules and module utils files, you will also want to move the action plugins. The plugins have a similar location to modules and module utils. Their directory is found at ansible/plugins/action/.


If you use Method 1 and then update your Ansible installation, the update will remove the changes you made to your installation.

For this reason, F5 recommends you put modules in your own personal directory and reference that directory through your ansible.cfg file.