mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-05-01 19:03:19 +00:00
75d481c6ff
ansible_freeipa_module is providing netaddr and also DNSName, therefore it is not needed to have own imports in the module. These own imports would need an addional try exception clause to be able to pass the ansible-test fake execution test.
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.