mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-06 10:40:32 -07:00
cd022c3e2a
* switch off client-chasing referrals * Add changelog fragment * Add comment to module * Sanity check * Update changelogs/fragments/1618-ldap_search-switch-off-cheasing-referrals.yaml Co-authored-by: Felix Fontein <felix@fontein.de> * Add module ref_chasing param to ldap module_utils * test acces token gitlab * test acces token gitlab: revert * Complete referrals_chasing parameter documentation * Fix parameter value check * Fix issue #963 * fix sanity check * Update plugins/doc_fragments/ldap.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update changelogs/fragments/1618-ldap_search-switch-off-cheasing-referrals.yaml Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/doc_fragments/ldap.py Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Mickael Foucher <mikael.foucher@groupama.com>
56 lines
1.7 KiB
Python
56 lines
1.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2016, Peter Sagerson <psagers@ignorare.net>
|
|
# Copyright: (c) 2016, Jiri Tyr <jiri.tyr@gmail.com>
|
|
# Copyright: (c) 2017-2018 Keller Fuchs (@KellerFuchs) <kellerfuchs@hashbang.sh>
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
# Standard LDAP documentation fragment
|
|
DOCUMENTATION = r'''
|
|
options:
|
|
bind_dn:
|
|
description:
|
|
- A DN to bind with. If this is omitted, we'll try a SASL bind with the EXTERNAL mechanism.
|
|
- If this is blank, we'll use an anonymous bind.
|
|
type: str
|
|
bind_pw:
|
|
description:
|
|
- The password to use with I(bind_dn).
|
|
type: str
|
|
dn:
|
|
required: true
|
|
description:
|
|
- The DN of the entry to add or remove.
|
|
type: str
|
|
referrals_chasing:
|
|
choices: [disabled, anonymous]
|
|
default: anonymous
|
|
type: str
|
|
description:
|
|
- Set the referrals chasing behavior.
|
|
- C(anonymous) follow referrals anonymously. This is the default behavior.
|
|
- C(disabled) disable referrals chasing. This sets C(OPT_REFERRALS) to off.
|
|
version_added: 2.0.0
|
|
server_uri:
|
|
description:
|
|
- A URI to the LDAP server.
|
|
- The default value lets the underlying LDAP client library look for a UNIX domain socket in its default location.
|
|
type: str
|
|
default: ldapi:///
|
|
start_tls:
|
|
description:
|
|
- If true, we'll use the START_TLS LDAP extension.
|
|
type: bool
|
|
default: no
|
|
validate_certs:
|
|
description:
|
|
- If set to C(no), SSL certificates will not be validated.
|
|
- This should only be used on sites using self-signed certificates.
|
|
type: bool
|
|
default: yes
|
|
'''
|