mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-04-20 15:51:13 +00:00
b7145bc2cc
Host location and server location have very different meanings in IPA. ipahost uses 'location' as an optional hint to where the host may be physically located, ipaserever uses location to identify which DNS location the server is part of. This change updates documentation to make attribute description more clear. Surrounding text have been changed to match text style as used in other plugins. This patch is related to: https://github.com/freeipa/freeipa/pull/6840
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.