Documentation homepage Last update: Sep 22, 2021

Test plugins

Test plugins evaluate template expressions and return True or False. With test plugins you can create conditionals to implement the logic of your tasks, blocks, plays, playbooks, and roles. Ansible uses the standard tests shipped as part of Jinja, and adds some specialized test plugins. You can create custom Ansible test plugins.

Enabling test plugins

You can add a custom test plugin by dropping it into a test_plugins directory adjacent to your play, inside a role, or by putting it in one of the test plugin directory sources configured in ansible.cfg.

Using test plugins

The User Guide offers detailed documentation on using test plugins.

seealso:

about_playbooks An introduction to playbooks

playbooks_tests Using tests

playbooks_conditionals Using conditional statements

filter_plugins Filter plugins

playbooks_filters Using filters

lookup_plugins Lookup plugins User Mailing List Have a question? Stop by the google group!

communication_irc How to join Ansible chat channels