mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-05 10:10:31 -07:00
Optimize ldap modules auth note in a doc fragment (#9486)
Optimize ldap auth doc fragment
This commit is contained in:
parent
d81f56e10b
commit
01244237a1
6 changed files with 4 additions and 18 deletions
|
@ -13,6 +13,10 @@ __metaclass__ = type
|
|||
class ModuleDocFragment(object):
|
||||
# Standard LDAP documentation fragment
|
||||
DOCUMENTATION = r"""
|
||||
notes:
|
||||
- The default authentication settings will attempt to use a SASL EXTERNAL bind over a UNIX domain socket. This works well with the default Ubuntu
|
||||
install for example, which includes a C(cn=peercred,cn=external,cn=auth) ACL rule allowing root to modify the server configuration. If you need
|
||||
to use a simple bind to access your server, pass the credentials in O(bind_dn) and O(bind_pw).
|
||||
options:
|
||||
bind_dn:
|
||||
description:
|
||||
|
|
|
@ -19,9 +19,6 @@ description:
|
|||
- Add or remove multiple LDAP attribute values.
|
||||
notes:
|
||||
- This only deals with attributes on existing entries. To add or remove whole entries, see M(community.general.ldap_entry).
|
||||
- The default authentication settings will attempt to use a SASL EXTERNAL bind over a UNIX domain socket. This works well with the default Ubuntu
|
||||
install for example, which includes a C(cn=peercred,cn=external,cn=auth) ACL rule allowing root to modify the server configuration. If you need
|
||||
to use a simple bind to access your server, pass the credentials in O(bind_dn) and O(bind_pw).
|
||||
- For O(state=present) and O(state=absent), all value comparisons are performed on the server for maximum accuracy. For O(state=exact), values
|
||||
have to be compared in Python, which obviously ignores LDAP matching rules. This should work out in most cases, but it is theoretically possible
|
||||
to see spurious changes when target and actual values are semantically identical but lexically distinct.
|
||||
|
|
|
@ -17,10 +17,6 @@ short_description: Add or remove LDAP entries
|
|||
description:
|
||||
- Add or remove LDAP entries. This module only asserts the existence or non-existence of an LDAP entry, not its attributes. To assert the attribute
|
||||
values of an entry, see M(community.general.ldap_attrs).
|
||||
notes:
|
||||
- The default authentication settings will attempt to use a SASL EXTERNAL bind over a UNIX domain socket. This works well with the default Ubuntu
|
||||
install for example, which includes a C(cn=peercred,cn=external,cn=auth) ACL rule allowing root to modify the server configuration. If you need
|
||||
to use a simple bind to access your server, pass the credentials in O(bind_dn) and O(bind_pw).
|
||||
author:
|
||||
- Jiri Tyr (@jtyr)
|
||||
requirements:
|
||||
|
|
|
@ -34,9 +34,6 @@ notes:
|
|||
- This only deals with integer attribute of an existing entry. To modify attributes
|
||||
of an entry, see M(community.general.ldap_attrs) or to add or remove whole entries,
|
||||
see M(community.general.ldap_entry).
|
||||
- The default authentication settings will attempt to use a SASL EXTERNAL
|
||||
bind over a UNIX domain socket. If you need to use a simple bind to access
|
||||
your server, pass the credentials in O(bind_dn) and O(bind_pw).
|
||||
author:
|
||||
- Philippe Duveau (@pduveau)
|
||||
requirements:
|
||||
|
|
|
@ -15,10 +15,6 @@ short_description: Set passwords in LDAP
|
|||
description:
|
||||
- Set a password for an LDAP entry. This module only asserts that a given password is valid for a given entry. To assert the existence of an
|
||||
entry, see M(community.general.ldap_entry).
|
||||
notes:
|
||||
- The default authentication settings will attempt to use a SASL EXTERNAL bind over a UNIX domain socket. This works well with the default Ubuntu
|
||||
install for example, which includes a C(cn=peercred,cn=external,cn=auth) ACL rule allowing root to modify the server configuration. If you
|
||||
need to use a simple bind to access your server, pass the credentials in O(bind_dn) and O(bind_pw).
|
||||
author:
|
||||
- Keller Fuchs (@KellerFuchs)
|
||||
requirements:
|
||||
|
|
|
@ -15,10 +15,6 @@ version_added: '0.2.0'
|
|||
short_description: Search for entries in a LDAP server
|
||||
description:
|
||||
- Return the results of an LDAP search.
|
||||
notes:
|
||||
- The default authentication settings will attempt to use a SASL EXTERNAL bind over a UNIX domain socket. This works well with the default Ubuntu
|
||||
install for example, which includes a C(cn=peercred,cn=external,cn=auth) ACL rule allowing root to modify the server configuration. If you
|
||||
need to use a simple bind to access your server, pass the credentials in O(bind_dn) and O(bind_pw).
|
||||
author:
|
||||
- Sebastian Pfahl (@eryx12o45)
|
||||
requirements:
|
||||
|
|
Loading…
Add table
Reference in a new issue