ipa_*: add common connection notes to modules (#10615)

russoz · felixfontein · web-flow · commit 993e3a736ec7 · 2025-08-11T06:44:38.000+02:00
* ipa_*: add common connection notes to modules

* Update plugins/doc_fragments/ipa.py

Co-authored-by: Felix Fontein &lt;felix@fontein.de&gt;

* Update plugins/doc_fragments/ipa.py

Co-authored-by: Felix Fontein &lt;felix@fontein.de&gt;

---------

Co-authored-by: Felix Fontein &lt;felix@fontein.de&gt;
diff --git a/plugins/doc_fragments/ipa.py b/plugins/doc_fragments/ipa.py
@@ -74,3 +74,11 @@ class ModuleDocFragment(object):
     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
@@ -113,6 +113,7 @@
     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
@@ -86,6 +86,7 @@
     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
@@ -42,6 +42,7 @@
     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
@@ -87,6 +87,7 @@
     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
@@ -109,6 +109,7 @@
     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
@@ -94,6 +94,7 @@
     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
@@ -63,6 +63,7 @@
     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
@@ -39,6 +39,7 @@
     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
@@ -105,6 +105,7 @@
     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
@@ -87,6 +87,7 @@
     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
@@ -84,6 +84,7 @@
     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
@@ -53,6 +53,7 @@
     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
@@ -44,6 +44,7 @@
     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
@@ -36,6 +36,7 @@
     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
@@ -43,6 +43,7 @@
     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
@@ -136,6 +136,7 @@
     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
@@ -110,6 +110,7 @@
     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
@@ -79,6 +79,7 @@
     default: true
 extends_documentation_fragment:
   - community.general.ipa.documentation
+  - community.general.ipa.connection_notes
   - community.general.attributes
 """
 
