Puppet Class: ldap::client

Inherits:
ldap::params
Inherited by:
ldap::client::config
ldap::client::install
Defined in:
manifests/client.pp

Overview

Class: ldap::client

This class manages the installation and configuration of the OpenLDAP client

Parameters

uri

The URI to the LDAP server(s) queries should be performed against.

base

The domain for which the LDAP server provides information for.

ssl

Whether the client should attempt to connect over SSL (false, true).

ssl_cacert

Name of the CA Cert (OpenSSL: a filename, MozNSS: cert name in the certdb).

ssl_cacertdir

Directory of the CA cert file (OpenSSL: a dirname, MozNSS: dirname where the certdb is).

ssl_cert

SSL Certificate (OpenSSL: A filename, MozNSS: a cert name in the certdb).

ssl_key

(OpenSSL: key file matching ssl_cert, MozNSS: filename to the password file for certdb).

ssl_reqcert

How CA validation is being handled (never, allow, try, demand).

ssl_ciphersuite

specify tls ciphersuite.

manage_package_dependencies

Whether to automatically install additional software packages such as net-ldap (Default: true).

net_ldap_package_name

The name of the net-ldap package to install (Default: OS-dependant ruby-net-ldap or net-ldap).

net_ldap_package_ensure

The ensure of the net-ldap package (Default: present).

net_ldap_package_provider

The provider of the net-ldap package (Default: OS-dependant apt or gem).

sizelimit

Maximum number of entries to return by default.

timelimit

Maximum number of seconds to wait for answers by default.

Examples

class { 'ldap::client':
  uri  => 'ldap://ldapserver01 ldap://ldapserver02',
  base => 'dc=example,dc=com',
}

Parameters:

  • uri (Any)
  • base (Any)
  • ssl (Any) (defaults to: $ldap::params::client_ssl)
  • ssl_cacertdir (Any) (defaults to: $ldap::params::client_ssl_cacertdir)
  • ssl_cacert (Any) (defaults to: $ldap::params::client_ssl_cacert)
  • ssl_cert (Any) (defaults to: $ldap::params::client_ssl_cert)
  • ssl_key (Any) (defaults to: $ldap::params::client_ssl_key)
  • ssl_reqcert (Any) (defaults to: $ldap::params::client_ssl_reqcert)
  • ssl_ciphersuite (Any) (defaults to: $ldap::params::client_ssl_ciphersuite)
  • package_name (Any) (defaults to: $ldap::params::client_package_name)
  • package_ensure (Any) (defaults to: $ldap::params::client_package_ensure)
  • config_directory (Any) (defaults to: $ldap::params::ldap_config_directory)
  • config_file (Any) (defaults to: $ldap::params::client_config_file)
  • config_template (Any) (defaults to: $ldap::params::client_config_template)
  • manage_package_dependencies (Any) (defaults to: $ldap::params::manage_package_dependencies)
  • net_ldap_package_name (Any) (defaults to: $ldap::params::net_ldap_package_name)
  • net_ldap_package_ensure (Any) (defaults to: $ldap::params::net_ldap_package_ensure)
  • net_ldap_package_provider (Any) (defaults to: $ldap::params::net_ldap_package_provider)
  • sizelimit (Any) (defaults to: $ldap::params::client_sizelimit)
  • timelimit (Any) (defaults to: $ldap::params::client_timelimit) 


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'manifests/client.pp', line 61

class ldap::client (
  $uri,
  $base,
  $ssl              = $ldap::params::client_ssl,
  $ssl_cacertdir    = $ldap::params::client_ssl_cacertdir,
  $ssl_cacert       = $ldap::params::client_ssl_cacert,
  $ssl_cert         = $ldap::params::client_ssl_cert,
  $ssl_key          = $ldap::params::client_ssl_key,
  $ssl_reqcert      = $ldap::params::client_ssl_reqcert,
  $ssl_ciphersuite  = $ldap::params::client_ssl_ciphersuite,
  $package_name     = $ldap::params::client_package_name,
  $package_ensure   = $ldap::params::client_package_ensure,
  $config_directory = $ldap::params::ldap_config_directory,
  $config_file      = $ldap::params::client_config_file,
  $config_template  = $ldap::params::client_config_template,
  $manage_package_dependencies = $ldap::params::manage_package_dependencies,
  $net_ldap_package_name       = $ldap::params::net_ldap_package_name,
  $net_ldap_package_ensure     = $ldap::params::net_ldap_package_ensure,
  $net_ldap_package_provider   = $ldap::params::net_ldap_package_provider,
  $sizelimit        = $ldap::params::client_sizelimit,
  $timelimit        = $ldap::params::client_timelimit,
) inherits ldap::params {

  include stdlib

  validate_string($uri)
  validate_string($base)
  validate_bool($ssl)
  if $ssl == true {
    if $ssl_cacertdir {
      validate_absolute_path($ssl_cacertdir)
    }
    validate_absolute_path($ssl_cacert)
    if $ssl_cert {
      validate_absolute_path($ssl_cert)
    }
    if $ssl_key {
      validate_absolute_path($ssl_key)
    }
    if $ssl_ciphersuite {
      validate_string($ssl_ciphersuite)
    }
    if $ssl_reqcert {
      validate_re($ssl_reqcert, ['never', 'allow', 'try', 'demand'])
    }
  }

  validate_bool($manage_package_dependencies)
  validate_string($net_ldap_package_name)
  validate_string($net_ldap_package_ensure)
  validate_string($net_ldap_package_provider)

  anchor { 'ldap::client::begin': } ->
  class { '::ldap::client::install': } ->
  class { '::ldap::client::config': } ->
  anchor { 'ldap::client::end': }
}