From a7846391a9d3910d5c28e3b65b0ec75afa3d96f6 Mon Sep 17 00:00:00 2001 From: Dag Wieers Date: Tue, 19 Feb 2019 21:46:23 +0100 Subject: [PATCH] ldap: Clean up parameter types (other) (#52541) This PR includes: - Parameter types added - Copyright format fixes - Short license statement This breaks out PR #52182 --- lib/ansible/plugins/doc_fragments/ldap.py | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/lib/ansible/plugins/doc_fragments/ldap.py b/lib/ansible/plugins/doc_fragments/ldap.py index e76a2ee7b32..42205ee4619 100644 --- a/lib/ansible/plugins/doc_fragments/ldap.py +++ b/lib/ansible/plugins/doc_fragments/ldap.py @@ -3,40 +3,43 @@ # Copyright: (c) 2016, Peter Sagerson # Copyright: (c) 2016, Jiri Tyr # Copyright: (c) 2017-2018 Keller Fuchs (@KellerFuchs) -# # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) class ModuleDocFragment(object): # Standard LDAP documentation fragment - DOCUMENTATION = ''' + 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 server_uri: - default: ldapi:/// 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: - default: 'no' - type: bool description: - If true, we'll use the START_TLS LDAP extension. - validate_certs: - default: 'yes' 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 version_added: "2.4" '''