[PR #9528/838cdaab backport][stable-10] lmn*: style adjustments (#9543)

lmn*: style adjustments (#9528)

* lmn*: style adjustments

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 838cdaab42)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2025-01-07 18:45:30 +01:00 committed by GitHub
parent 1f29fa2e39
commit 75f649648e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
43 changed files with 440 additions and 378 deletions

View file

@ -52,21 +52,22 @@ options:
default: false
type: bool
description:
- Set to V(true) to return the full attribute schema of entries, not their attribute values. Overrides O(attrs) when provided.
- Set to V(true) to return the full attribute schema of entries, not their attribute values. Overrides O(attrs) when
provided.
page_size:
default: 0
type: int
description:
- The page size when performing a simple paged result search (RFC 2696). This setting can be tuned to reduce issues with timeouts and server
limits.
- The page size when performing a simple paged result search (RFC 2696). This setting can be tuned to reduce issues
with timeouts and server limits.
- Setting the page size to V(0) (default) disables paged searching.
version_added: 7.1.0
base64_attributes:
description:
- If provided, all attribute values returned that are listed in this option will be Base64 encoded.
- If the special value V(*) appears in this list, all attributes will be Base64 encoded.
- All other attribute values will be converted to UTF-8 strings. If they contain binary data, please note that invalid UTF-8 bytes will
be omitted.
- All other attribute values will be converted to UTF-8 strings. If they contain binary data, please note that invalid
UTF-8 bytes will be omitted.
type: list
elements: str
version_added: 7.0.0
@ -90,17 +91,15 @@ EXAMPLES = r"""
register: ldap_group_gids
"""
RESULTS = """
RESULTS = r"""
results:
description:
- For every entry found, one dictionary will be returned.
- Every dictionary contains a key C(dn) with the entry's DN as a value.
- Every attribute of the entry found is added to the dictionary. If the key
has precisely one value, that value is taken directly, otherwise the key's
value is a list.
- Note that all values (for single-element lists) and list elements (for multi-valued
lists) will be UTF-8 strings. Some might contain Base64-encoded binary data; which
ones is determined by the O(base64_attributes) option.
- Every attribute of the entry found is added to the dictionary. If the key has precisely one value, that value is taken
directly, otherwise the key's value is a list.
- Note that all values (for single-element lists) and list elements (for multi-valued lists) will be UTF-8 strings. Some
might contain Base64-encoded binary data; which ones is determined by the O(base64_attributes) option.
type: list
elements: dict
"""