From 993e3a736ec712a95bf3287f2e087bec3631f198 Mon Sep 17 00:00:00 2001 From: Alexei Znamensky <103110+russoz@users.noreply.github.com> Date: Mon, 11 Aug 2025 16:44:38 +1200 Subject: [PATCH] ipa_*: add common connection notes to modules (#10615) * ipa_*: add common connection notes to modules * Update plugins/doc_fragments/ipa.py Co-authored-by: Felix Fontein * Update plugins/doc_fragments/ipa.py Co-authored-by: Felix Fontein --------- Co-authored-by: Felix Fontein --- plugins/doc_fragments/ipa.py | 8 ++++++++ plugins/modules/ipa_config.py | 1 + plugins/modules/ipa_dnsrecord.py | 1 + plugins/modules/ipa_dnszone.py | 1 + plugins/modules/ipa_group.py | 1 + plugins/modules/ipa_hbacrule.py | 1 + plugins/modules/ipa_host.py | 1 + plugins/modules/ipa_hostgroup.py | 1 + plugins/modules/ipa_otpconfig.py | 1 + plugins/modules/ipa_otptoken.py | 1 + plugins/modules/ipa_pwpolicy.py | 1 + plugins/modules/ipa_role.py | 1 + plugins/modules/ipa_service.py | 1 + plugins/modules/ipa_subca.py | 1 + plugins/modules/ipa_sudocmd.py | 1 + plugins/modules/ipa_sudocmdgroup.py | 1 + plugins/modules/ipa_sudorule.py | 1 + plugins/modules/ipa_user.py | 1 + plugins/modules/ipa_vault.py | 1 + 19 files changed, 26 insertions(+) diff --git a/plugins/doc_fragments/ipa.py b/plugins/doc_fragments/ipa.py index 63ea94b465..a08539a94b 100644 --- a/plugins/doc_fragments/ipa.py +++ b/plugins/doc_fragments/ipa.py @@ -74,3 +74,11 @@ options: type: int default: 10 """ + + CONNECTION_NOTES = r""" +options: {} +notes: + - This module uses JSON-RPC over HTTP(S) to communicate with the FreeIPA server. + If you need to enroll the managed node into FreeIPA realm, you might want to consider using the collection + L(freeipa.ansible_freeipa, https://galaxy.ansible.com/ui/repo/published/freeipa/ansible_freeipa/), but that will require shell access to the managed node. +""" diff --git a/plugins/modules/ipa_config.py b/plugins/modules/ipa_config.py index ea08f8f8ba..404e1905ac 100644 --- a/plugins/modules/ipa_config.py +++ b/plugins/modules/ipa_config.py @@ -113,6 +113,7 @@ options: version_added: '2.5.0' extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_dnsrecord.py b/plugins/modules/ipa_dnsrecord.py index 3cba35b11c..49df878d4e 100644 --- a/plugins/modules/ipa_dnsrecord.py +++ b/plugins/modules/ipa_dnsrecord.py @@ -86,6 +86,7 @@ options: type: str extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_dnszone.py b/plugins/modules/ipa_dnszone.py index 81a99bc54b..afe750f893 100644 --- a/plugins/modules/ipa_dnszone.py +++ b/plugins/modules/ipa_dnszone.py @@ -42,6 +42,7 @@ options: version_added: 4.3.0 extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_group.py b/plugins/modules/ipa_group.py index 934e533dff..f27f312006 100644 --- a/plugins/modules/ipa_group.py +++ b/plugins/modules/ipa_group.py @@ -87,6 +87,7 @@ options: type: str extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_hbacrule.py b/plugins/modules/ipa_hbacrule.py index cb828f68e9..10767398c0 100644 --- a/plugins/modules/ipa_hbacrule.py +++ b/plugins/modules/ipa_hbacrule.py @@ -109,6 +109,7 @@ options: elements: str extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_host.py b/plugins/modules/ipa_host.py index c88f3c0adb..89461a7bf2 100644 --- a/plugins/modules/ipa_host.py +++ b/plugins/modules/ipa_host.py @@ -94,6 +94,7 @@ options: type: bool extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_hostgroup.py b/plugins/modules/ipa_hostgroup.py index ffe87fca4c..c4d3e691ef 100644 --- a/plugins/modules/ipa_hostgroup.py +++ b/plugins/modules/ipa_hostgroup.py @@ -63,6 +63,7 @@ options: type: str extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_otpconfig.py b/plugins/modules/ipa_otpconfig.py index 3c07c7eda3..e562b63585 100644 --- a/plugins/modules/ipa_otpconfig.py +++ b/plugins/modules/ipa_otpconfig.py @@ -39,6 +39,7 @@ options: type: int extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_otptoken.py b/plugins/modules/ipa_otptoken.py index e8c99bd302..e2d25c5274 100644 --- a/plugins/modules/ipa_otptoken.py +++ b/plugins/modules/ipa_otptoken.py @@ -105,6 +105,7 @@ options: type: int extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_pwpolicy.py b/plugins/modules/ipa_pwpolicy.py index 5b41651e09..a7bdd24047 100644 --- a/plugins/modules/ipa_pwpolicy.py +++ b/plugins/modules/ipa_pwpolicy.py @@ -87,6 +87,7 @@ options: version_added: 8.2.0 extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_role.py b/plugins/modules/ipa_role.py index 6057deec7b..f7cc3f8a10 100644 --- a/plugins/modules/ipa_role.py +++ b/plugins/modules/ipa_role.py @@ -84,6 +84,7 @@ options: elements: str extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_service.py b/plugins/modules/ipa_service.py index 51ace78760..7d84093b4f 100644 --- a/plugins/modules/ipa_service.py +++ b/plugins/modules/ipa_service.py @@ -53,6 +53,7 @@ options: type: str extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_subca.py b/plugins/modules/ipa_subca.py index ddb551689d..5f8e1e8769 100644 --- a/plugins/modules/ipa_subca.py +++ b/plugins/modules/ipa_subca.py @@ -44,6 +44,7 @@ options: type: str extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_sudocmd.py b/plugins/modules/ipa_sudocmd.py index f52d3e9e6d..b50353fdf2 100644 --- a/plugins/modules/ipa_sudocmd.py +++ b/plugins/modules/ipa_sudocmd.py @@ -36,6 +36,7 @@ options: type: str extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_sudocmdgroup.py b/plugins/modules/ipa_sudocmdgroup.py index 4298032121..592f544bdd 100644 --- a/plugins/modules/ipa_sudocmdgroup.py +++ b/plugins/modules/ipa_sudocmdgroup.py @@ -43,6 +43,7 @@ options: elements: str extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_sudorule.py b/plugins/modules/ipa_sudorule.py index ae3730da62..c2711594a7 100644 --- a/plugins/modules/ipa_sudorule.py +++ b/plugins/modules/ipa_sudorule.py @@ -136,6 +136,7 @@ options: type: str extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """ diff --git a/plugins/modules/ipa_user.py b/plugins/modules/ipa_user.py index 6e61f89600..4956a48cfb 100644 --- a/plugins/modules/ipa_user.py +++ b/plugins/modules/ipa_user.py @@ -110,6 +110,7 @@ options: version_added: '1.2.0' extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes requirements: diff --git a/plugins/modules/ipa_vault.py b/plugins/modules/ipa_vault.py index 23002b7ce0..96725e90b5 100644 --- a/plugins/modules/ipa_vault.py +++ b/plugins/modules/ipa_vault.py @@ -79,6 +79,7 @@ options: default: true extends_documentation_fragment: - community.general.ipa.documentation + - community.general.ipa.connection_notes - community.general.attributes """