[PR #10615/993e3a73 backport][stable-10] ipa_*: add common connection notes to modules (#10640)

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

* ipa_*: add common connection notes to modules

* Update plugins/doc_fragments/ipa.py



* Update plugins/doc_fragments/ipa.py



---------


(cherry picked from commit 993e3a736e)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>

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.
+"""

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
 """
 

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
 """
 

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
 """
 

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
 """
 

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
 """
 

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
 """
 

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
 """
 

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
 """
 

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
 """
 

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
 """
 

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
 """
 

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
 """
 

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
 """
 

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
 """
 

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
 """
 

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
 """
 

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:

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
 """