mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
ldap: Clean up parameter types (other) (#52541)
This PR includes: - Parameter types added - Copyright format fixes - Short license statement This breaks out PR #52182
This commit is contained in:
parent
4c97481337
commit
a7846391a9
1 changed files with 10 additions and 7 deletions
|
@ -3,40 +3,43 @@
|
||||||
# Copyright: (c) 2016, Peter Sagerson <psagers@ignorare.net>
|
# Copyright: (c) 2016, Peter Sagerson <psagers@ignorare.net>
|
||||||
# Copyright: (c) 2016, Jiri Tyr <jiri.tyr@gmail.com>
|
# Copyright: (c) 2016, Jiri Tyr <jiri.tyr@gmail.com>
|
||||||
# Copyright: (c) 2017-2018 Keller Fuchs (@KellerFuchs) <kellerfuchs@hashbang.sh>
|
# 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)
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
|
|
||||||
|
|
||||||
class ModuleDocFragment(object):
|
class ModuleDocFragment(object):
|
||||||
# Standard LDAP documentation fragment
|
# Standard LDAP documentation fragment
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = r'''
|
||||||
options:
|
options:
|
||||||
bind_dn:
|
bind_dn:
|
||||||
description:
|
description:
|
||||||
- A DN to bind with. If this is omitted, we'll try a SASL bind with the EXTERNAL mechanism.
|
- 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.
|
- If this is blank, we'll use an anonymous bind.
|
||||||
|
type: str
|
||||||
bind_pw:
|
bind_pw:
|
||||||
description:
|
description:
|
||||||
- The password to use with I(bind_dn).
|
- The password to use with I(bind_dn).
|
||||||
|
type: str
|
||||||
dn:
|
dn:
|
||||||
required: true
|
required: true
|
||||||
description:
|
description:
|
||||||
- The DN of the entry to add or remove.
|
- The DN of the entry to add or remove.
|
||||||
|
type: str
|
||||||
server_uri:
|
server_uri:
|
||||||
default: ldapi:///
|
|
||||||
description:
|
description:
|
||||||
- A URI to the LDAP server.
|
- 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.
|
- 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:
|
start_tls:
|
||||||
default: 'no'
|
|
||||||
type: bool
|
|
||||||
description:
|
description:
|
||||||
- If true, we'll use the START_TLS LDAP extension.
|
- If true, we'll use the START_TLS LDAP extension.
|
||||||
validate_certs:
|
|
||||||
default: 'yes'
|
|
||||||
type: bool
|
type: bool
|
||||||
|
default: no
|
||||||
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If set to C(no), SSL certificates will not be validated.
|
- If set to C(no), SSL certificates will not be validated.
|
||||||
- This should only be used on sites using self-signed certificates.
|
- This should only be used on sites using self-signed certificates.
|
||||||
|
type: bool
|
||||||
|
default: yes
|
||||||
version_added: "2.4"
|
version_added: "2.4"
|
||||||
'''
|
'''
|
||||||
|
|
Loading…
Reference in a new issue