mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-04-27 08:56:27 +00:00
Ansible's fail_json() method required that the message paramater was passed with a keyword parameter, rather than a positional one. Although this seems to work with ansible-core 2.13+, it might not work with previous versions of Ansible. This patch fixes the behaviour for all supported Ansible versions.
Writing a new Ansible FreeIPA module
A ansible-freeipa module should have:
-
Code:
- A module file placed in
plugins/modules/<ipa_module_name>.py
- A module file placed in
-
Documentation:
README-<module_name>.mdfile in the root directory and linked from the main README.md- Example playbooks in
playbooks/<module_name>/directory
-
Tests:
- Test cases (also playbooks) defined in
tests/<module_name>/test_<something>.yml. It's ok to have multiple files in this directory.
- Test cases (also playbooks) defined in
Use the script utils/new_module to create the stub files for a new module.