cdist-web/src/extra/manual/6.9.8/man7/cdist-type__openldap_server...

629 lines
42 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>16.99. cdist-type__openldap_server(7) &mdash; cdist 6.9.8 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="16.100. cdist-type__package(7)" href="cdist-type__package.html" />
<link rel="prev" title="16.98. cdist-type__mysql_user(7)" href="cdist-type__mysql_user.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home"> cdist
<img src="../_static/cdist-logo.jpeg" class="logo" alt="Logo"/>
</a>
<div class="version">
6.9.8
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../cdist-why.html">1. Why should I use cdist?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-features.html">2. Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-os.html">3. Supported operating systems</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-install.html">4. How to install cdist</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-upgrade.html">5. How to upgrade cdist</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-support.html">6. Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-quickstart.html">7. Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-real-world.html">8. Dive into real world cdist</a></li>
<li class="toctree-l1"><a class="reference internal" href="../man1/cdist.html">9. cdist(1)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../man1/cdist-dump.html">10. cdist-dump(1)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../man1/cdist-new-type.html">11. cdist-new-type(1)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-bootstrap.html">12. Bootstrap</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-configuration.html">13. Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-manifest.html">14. Manifest</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-type.html">15. cdist type</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../cdist-types.html">16. cdist types</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cdist-type__acl.html">16.1. __acl</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_backports.html">16.2. __apt_backports</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_default_release.html">16.3. __apt_default_release</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_key.html">16.4. __apt_key</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_key_uri.html">16.5. __apt_key_uri</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_mark.html">16.6. __apt_mark</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_norecommends.html">16.7. __apt_norecommends</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_pin.html">16.8. __apt_pin</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_ppa.html">16.9. __apt_ppa</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_source.html">16.10. __apt_source</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_unattended_upgrades.html">16.11. __apt_unattended_upgrades</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_update_index.html">16.12. __apt_update_index</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__block.html">16.13. __block</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__ccollect_source.html">16.14. __ccollect_source</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__cdist.html">16.15. __cdist</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__cdistmarker.html">16.16. __cdistmarker</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__check_messages.html">16.17. __check_messages</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__chroot_mount.html">16.18. __chroot_mount</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__chroot_umount.html">16.19. __chroot_umount</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__clean_path.html">16.20. __clean_path</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__config_file.html">16.21. __config_file</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul.html">16.22. __consul</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_agent.html">16.23. __consul_agent</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_check.html">16.24. __consul_check</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_reload.html">16.25. __consul_reload</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_service.html">16.26. __consul_service</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_template.html">16.27. __consul_template</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_template_template.html">16.28. __consul_template_template</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_checks.html">16.29. __consul_watch_checks</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_event.html">16.30. __consul_watch_event</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_key.html">16.31. __consul_watch_key</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_keyprefix.html">16.32. __consul_watch_keyprefix</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_nodes.html">16.33. __consul_watch_nodes</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_service.html">16.34. __consul_watch_service</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_services.html">16.35. __consul_watch_services</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__cron.html">16.36. __cron</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__daemontools.html">16.37. __daemontools</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__daemontools_service.html">16.38. __daemontools_service</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__debconf_set_selections.html">16.39. __debconf_set_selections</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__directory.html">16.40. __directory</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__docker.html">16.41. __docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__docker_compose.html">16.42. __docker_compose</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__docker_config.html">16.43. __docker_config</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__docker_secret.html">16.44. __docker_secret</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__docker_stack.html">16.45. __docker_stack</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__docker_swarm.html">16.46. __docker_swarm</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__dog_vdi.html">16.47. __dog_vdi</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__dot_file.html">16.48. __dot_file</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__download.html">16.49. __download</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__dpkg_architecture.html">16.50. __dpkg_architecture</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__file.html">16.51. __file</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__filesystem.html">16.52. __filesystem</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__firewalld_rule.html">16.53. __firewalld_rule</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__firewalld_start.html">16.54. __firewalld_start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__git.html">16.55. __git</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__go_get.html">16.56. __go_get</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__golang_from_vendor.html">16.57. __golang_from_vendor</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__grafana_dashboard.html">16.58. __grafana_dashboard</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__group.html">16.59. __group</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__hostname.html">16.60. __hostname</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__hosts.html">16.61. __hosts</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__hwclock.html">16.62. __hwclock</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_bootloader_grub.html">16.63. __install_bootloader_grub</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_chroot_mount.html">16.64. __install_chroot_mount</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_chroot_umount.html">16.65. __install_chroot_umount</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_config.html">16.66. __install_config</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_coreos.html">16.67. __install_coreos</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_directory.html">16.68. __install_directory</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_file.html">16.69. __install_file</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_fstab.html">16.70. __install_fstab</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_generate_fstab.html">16.71. __install_generate_fstab</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_mkfs.html">16.72. __install_mkfs</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_mount.html">16.73. __install_mount</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_partition_msdos.html">16.74. __install_partition_msdos</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_partition_msdos_apply.html">16.75. __install_partition_msdos_apply</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_reboot.html">16.76. __install_reboot</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_reset_disk.html">16.77. __install_reset_disk</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_stage.html">16.78. __install_stage</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_umount.html">16.79. __install_umount</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__iptables_apply.html">16.80. __iptables_apply</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__iptables_rule.html">16.81. __iptables_rule</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__issue.html">16.82. __issue</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__jail.html">16.83. __jail</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__jail_freebsd10.html">16.84. __jail_freebsd10</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__jail_freebsd9.html">16.85. __jail_freebsd9</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__key_value.html">16.86. __key_value</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__keyboard.html">16.87. __keyboard</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__letsencrypt_cert.html">16.88. __letsencrypt_cert</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__line.html">16.89. __line</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__link.html">16.90. __link</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__locale.html">16.91. __locale</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__locale_system.html">16.92. __locale_system</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__localedef.html">16.93. __localedef</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__motd.html">16.94. __motd</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__mount.html">16.95. __mount</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__mysql_database.html">16.96. __mysql_database</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__mysql_privileges.html">16.97. __mysql_privileges</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__mysql_user.html">16.98. __mysql_user</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">16.99. __openldap_server</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#name">16.99.1. NAME</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">16.99.2. DESCRIPTION</a></li>
<li class="toctree-l3"><a class="reference internal" href="#required-parameters">16.99.3. REQUIRED PARAMETERS</a></li>
<li class="toctree-l3"><a class="reference internal" href="#required-multiple-parameters">16.99.4. REQUIRED MULTIPLE PARAMETERS</a></li>
<li class="toctree-l3"><a class="reference internal" href="#optional-parameters">16.99.5. OPTIONAL PARAMETERS</a></li>
<li class="toctree-l3"><a class="reference internal" href="#optional-multiple-parameters">16.99.6. OPTIONAL MULTIPLE PARAMETERS</a></li>
<li class="toctree-l3"><a class="reference internal" href="#boolean-parameters">16.99.7. BOOLEAN PARAMETERS</a></li>
<li class="toctree-l3"><a class="reference internal" href="#examples">16.99.8. EXAMPLES</a></li>
<li class="toctree-l3"><a class="reference internal" href="#see-also">16.99.9. SEE ALSO</a></li>
<li class="toctree-l3"><a class="reference internal" href="#authors">16.99.10. AUTHORS</a></li>
<li class="toctree-l3"><a class="reference internal" href="#copying">16.99.11. COPYING</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package.html">16.100. __package</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_apk.html">16.101. __package_apk</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_apt.html">16.102. __package_apt</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_dpkg.html">16.103. __package_dpkg</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_emerge.html">16.104. __package_emerge</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_emerge_dependencies.html">16.105. __package_emerge_dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_luarocks.html">16.106. __package_luarocks</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_opkg.html">16.107. __package_opkg</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_pacman.html">16.108. __package_pacman</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_pip.html">16.109. __package_pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_pkg_freebsd.html">16.110. __package_pkg_freebsd</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_pkg_openbsd.html">16.111. __package_pkg_openbsd</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_pkgng_freebsd.html">16.112. __package_pkgng_freebsd</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_rubygem.html">16.113. __package_rubygem</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_update_index.html">16.114. __package_update_index</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_upgrade_all.html">16.115. __package_upgrade_all</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_yum.html">16.116. __package_yum</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_zypper.html">16.117. __package_zypper</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__pacman_conf.html">16.118. __pacman_conf</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__pacman_conf_integrate.html">16.119. __pacman_conf_integrate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__pf_apply_anchor.html">16.120. __pf_apply_anchor</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__pf_ruleset.html">16.121. __pf_ruleset</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__ping.html">16.122. __ping</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postfix.html">16.123. __postfix</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postfix_master.html">16.124. __postfix_master</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postfix_postconf.html">16.125. __postfix_postconf</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postfix_postmap.html">16.126. __postfix_postmap</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postfix_reload.html">16.127. __postfix_reload</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postgres_conf.html">16.128. __postgres_conf</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postgres_database.html">16.129. __postgres_database</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postgres_extension.html">16.130. __postgres_extension</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postgres_role.html">16.131. __postgres_role</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__process.html">16.132. __process</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__prometheus_alertmanager.html">16.133. __prometheus_alertmanager</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__prometheus_exporter.html">16.134. __prometheus_exporter</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__prometheus_server.html">16.135. __prometheus_server</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__pyvenv.html">16.136. __pyvenv</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__qemu_img.html">16.137. __qemu_img</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rbenv.html">16.138. __rbenv</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rsync.html">16.139. __rsync</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rvm.html">16.140. __rvm</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rvm_gem.html">16.141. __rvm_gem</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rvm_gemset.html">16.142. __rvm_gemset</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rvm_ruby.html">16.143. __rvm_ruby</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__sensible_editor.html">16.144. __sensible_editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__service.html">16.145. __service</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__snakeoil_cert.html">16.146. __snakeoil_cert</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__ssh_authorized_key.html">16.147. __ssh_authorized_key</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__ssh_authorized_keys.html">16.148. __ssh_authorized_keys</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__ssh_dot_ssh.html">16.149. __ssh_dot_ssh</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__sshd_config.html">16.150. __sshd_config</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__staged_file.html">16.151. __staged_file</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__start_on_boot.html">16.152. __start_on_boot</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__sysctl.html">16.153. __sysctl</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__systemd_service.html">16.154. __systemd_service</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__systemd_unit.html">16.155. __systemd_unit</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__timezone.html">16.156. __timezone</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__uci.html">16.157. __uci</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__uci_section.html">16.158. __uci_section</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__ufw.html">16.159. __ufw</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__ufw_rule.html">16.160. __ufw_rule</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__unpack.html">16.161. __unpack</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__update_alternatives.html">16.162. __update_alternatives</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__user.html">16.163. __user</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__user_groups.html">16.164. __user_groups</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__xymon_apache.html">16.165. __xymon_apache</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__xymon_client.html">16.166. __xymon_client</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__xymon_config.html">16.167. __xymon_config</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__xymon_server.html">16.168. __xymon_server</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__yum_repo.html">16.169. __yum_repo</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__zypper_repo.html">16.170. __zypper_repo</a></li>
<li class="toctree-l2"><a class="reference internal" href="cdist-type__zypper_service.html">16.171. __zypper_service</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-explorer.html">17. Explorer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-messaging.html">18. Messaging</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-parallelization.html">19. Parallelization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-inventory.html">20. Inventory</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-preos.html">21. PreOS</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-scan.html">22. Scan</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-integration.html">23. cdist integration / using cdist as library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-reference.html">24. Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-best-practice.html">25. Best practice</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-stages.html">26. Execution stages</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-cache.html">27. Local cache overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-saving-output-streams.html">28. Saving output streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-remote-exec-copy.html">29. Remote exec and copy commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-hacker.html">30. Hacking</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-troubleshooting.html">31. Troubleshooting</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">cdist</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li><span class="section-number">16.99. </span>cdist-type__openldap_server(7)</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/man7/cdist-type__openldap_server.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-openldap-server-7">
<h1><span class="section-number">16.99. </span>cdist-type__openldap_server(7)<a class="headerlink" href="#cdist-type-openldap-server-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2><span class="section-number">16.99.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__openldap_server - Setup an openldap(4) server instance</p>
</div>
<div class="section" id="description">
<h2><span class="section-number">16.99.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This type can be used to bootstrap an LDAP environment using openldap as slapd.</p>
<p>It bootstraps the LDAP server with sane defaults and creates and manages the
base DN defined by <cite>suffix</cite>.</p>
</div>
<div class="section" id="required-parameters">
<h2><span class="section-number">16.99.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>manager-dn</dt><dd><p>The rootdn to set up in the directory.
E.g. <cite>cn=manager,dc=ungleich,dc=ch</cite>. See <cite>slapd.conf(5)</cite>.</p>
</dd>
<dt>manager-password</dt><dd><p>The password for <cite>manager-dn</cite> in the directory.
This will be used to connect to the LDAP server on the first <cite>slapd-url</cite>
with the given <cite>manager-dn</cite>.</p>
</dd>
<dt>manager-password-hash</dt><dd><p>The password for <cite>manager-dn</cite> in the directory.
This should be valid for <cite>slapd.conf</cite> like <cite>{SSHA}qV+mCs3u8Q2sCmUXT4Ybw7MebHTASMyr</cite>.
Generate e.g. with: <cite>slappasswd -s weneedgoodsecurity</cite>.
See <cite>slappasswd(8C)</cite>, <cite>slapd.conf(5)</cite>.
TODO: implement this: <a class="reference external" href="http://blog.adamsbros.org/2015/06/09/openldap-ssha-salted-hashes-by-hand/">http://blog.adamsbros.org/2015/06/09/openldap-ssha-salted-hashes-by-hand/</a>
to derive from the manager-password parameter and ensure idempotency (care with salts).
At that point, manager-password-hash should be deprecated and ignored.</p>
</dd>
<dt>serverid</dt><dd><p>The server for the directory.
E.g. <cite>dc=ungleich,dc=ch</cite>. See <cite>slapd.conf(5)</cite>.</p>
</dd>
<dt>suffix</dt><dd><p>The suffix for the directory.
E.g. <cite>dc=ungleich,dc=ch</cite>. See <cite>slapd.conf(5)</cite>.</p>
</dd>
</dl>
</div>
<div class="section" id="required-multiple-parameters">
<h2><span class="section-number">16.99.4. </span>REQUIRED MULTIPLE PARAMETERS<a class="headerlink" href="#required-multiple-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>slapd-url</dt><dd><p>A URL for slapd to listen on.
Pass once for each URL you want to support,
e.g.: <cite>--slapd-url ldaps://my.fqdn/ --slapd-url ldap://my.fqdn/</cite>.
The first instance that is passed will be used as the main URL to
connect to this LDAP server
See the <cite>-h</cite> flag in <cite>slapd(8C)</cite>.</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2><span class="section-number">16.99.5. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>syncrepl-credentials</dt><dd><p>Only has an effect if <cite>replicate</cite> is set; required in that case.
This secret is shared amongst the hosts that will replicate the directory.
Note that each replication server needs this secret and it is saved in
plain text in the directory.</p>
</dd>
<dt>syncrepl-searchbase</dt><dd><p>Only has an effect if <cite>replicate</cite> is set; required in that case.
The searchbase to use for replication.
E.g. <cite>dc=ungleich,dc=ch</cite>. See <cite>slapd.conf(5)</cite>.</p>
</dd>
<dt>admin-email</dt><dd><p>Passed to <cite>cdist-type__letsencrypt_cert</cite>; has otherwise no use.
Required if using <cite>__letsencrypt_cert</cite>.
Where to send Let's Encrypt emails like &quot;certificate needs renewal&quot;.</p>
</dd>
<dt>tls-cipher-suite</dt><dd><p>Setting for TLSCipherSuite.
Defaults to <cite>NORMAL</cite> in a Debian-like OS and <cite>HIGH:MEDIUM:+SSLv2</cite> on FreeBSD.
See <cite>slapd.conf(5)</cite>.</p>
</dd>
<dt>tls-cert</dt><dd><p>If defined, <cite>__letsencrypt_cert</cite> is not used and this must be the path in
the remote hosts to the PEM-encoded TLS certificate.
Requires: <cite>tls-privkey</cite> and <cite>tls-ca</cite>.
Permissions, existence and renewal of these files are left up to the
type's user.</p>
</dd>
<dt>tls-privkey</dt><dd><p>Required if <cite>tls-cert</cite> is defined.
Path in the remote hosts to the PEM-encoded private key file.</p>
</dd>
<dt>tls-ca</dt><dd><p>Required if <cite>tls-cert</cite> is defined.
Path in the remote hosts to the PEM-encoded CA certificate file.</p>
</dd>
<dt>extra-config</dt><dd><p>Custom settings to be added in <cite>slapd.conf(5)</cite>.</p>
</dd>
</dl>
</div>
<div class="section" id="optional-multiple-parameters">
<h2><span class="section-number">16.99.6. </span>OPTIONAL MULTIPLE PARAMETERS<a class="headerlink" href="#optional-multiple-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>syncrepl-host</dt><dd><p>Only has an effect if <cite>replicate</cite> is set; required in that case.
Set once per host that will replicate the directory.</p>
</dd>
<dt>module</dt><dd><p>LDAP module to load. See <cite>slapd.conf(5)</cite>. Some dependencies might have to
be installed beforehand. Default value is OS-dependent, see manifest.</p>
</dd>
<dt>schema</dt><dd><p>Name of LDAP schema to load. Must be the name without extension of a
<cite>.schema</cite> file in slapd's schema directory (usually <cite>/etc/slapd/schema</cite> or
<cite>/usr/local/etc/openldap/schema</cite>).
Example value: <cite>inetorgperson</cite>
The type user must ensure that the schema file is deployed.
This defaults to a sensible subset, for details see the type definition.</p>
</dd>
<dt>description</dt><dd><p>The description of the base DN passed in the <cite>suffix</cite> parameter.
Defaults to <cite>Managed by cdist, do not edit manually.</cite></p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2><span class="section-number">16.99.7. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>staging</dt><dd><p>Passed to <cite>cdist-type__letsencrypt_cert</cite>; has otherwise no use.
Obtain a test certificate from a staging server.</p>
</dd>
<dt>replicate</dt><dd><p>Whether to setup replication or not.
If present <cite>syncrepl-credentials</cite> and <cite>syncrepl-host</cite> are also required.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2><span class="section-number">16.99.8. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Example of a simple server with manual certificate management.</span>
<span class="nv">pki_prefix</span><span class="o">=</span><span class="s2">&quot;/usr/local/etc/pki/realms/ldap.camilion.cloud&quot;</span>
__openldap_server <span class="se">\</span>
--manager-dn <span class="s1">&#39;cn=manager,dc=camilion,dc=cloud&#39;</span> <span class="se">\</span>
--manager-password <span class="s2">&quot;foo&quot;</span> <span class="se">\</span>
--manager-password-hash <span class="s1">&#39;{SSHA}foo&#39;</span> <span class="se">\</span>
--serverid <span class="m">0</span> <span class="se">\</span>
--suffix <span class="s1">&#39;dc=camilion,dc=cloud&#39;</span> <span class="se">\</span>
--slapd-url <span class="s1">&#39;ldaps://ldap.camilion.cloud&#39;</span> <span class="se">\</span>
--tls-cert <span class="s2">&quot;</span><span class="si">${</span><span class="nv">pki_prefix</span><span class="si">}</span><span class="s2">/default.crt&quot;</span> <span class="se">\</span>
--tls-privkey <span class="s2">&quot;</span><span class="si">${</span><span class="nv">pki_prefix</span><span class="si">}</span><span class="s2">/default.key&quot;</span> <span class="se">\</span>
--tls-ca <span class="s2">&quot;</span><span class="si">${</span><span class="nv">pki_prefix</span><span class="si">}</span><span class="s2">/CA.crt&quot;</span>
<span class="c1"># The created basedn looks as follows:</span>
<span class="c1">#</span>
<span class="c1"># dn: dc=camilion,dc=cloud</span>
<span class="c1"># objectClass: top</span>
<span class="c1"># objectClass: dcObject</span>
<span class="c1"># objectClass: organization</span>
<span class="c1"># o: Managed by cdist, do not edit manually.</span>
<span class="c1"># dc: camilion</span>
<span class="c1">#</span>
<span class="c1"># Do not change it manually, the type will overwrite your changes.</span>
<span class="c1">#</span>
<span class="c1"># Changing to a replicated setup is a simple change to something like:</span>
<span class="c1">#</span>
<span class="c1"># Example for multiple servers with replication and automatic</span>
<span class="c1"># Let&#39;s Encrypt certificate management through certbot.</span>
<span class="nv">id</span><span class="o">=</span><span class="m">1</span>
<span class="k">for</span> host in ldap-test1.ungleich.ch ldap-test2.ungleich.ch<span class="p">;</span> <span class="k">do</span>
<span class="nb">echo</span> <span class="s2">&quot;__ungleich_ldap \</span>
<span class="s2"> --manager-dn &#39;cn=manager,dc=ungleich,dc=ch&#39; \</span>
<span class="s2"> --manager-psasword &#39;foo&#39; \</span>
<span class="s2"> --manager-password-hash &#39;{SSHA}fooo&#39; \</span>
<span class="s2"> --serverid &#39;</span><span class="si">${</span><span class="nv">id</span><span class="si">}</span><span class="s2">&#39; \</span>
<span class="s2"> --suffix &#39;dc=ungleich,dc=ch&#39; \</span>
<span class="s2"> --slapd-url ldap://</span><span class="si">${</span><span class="nv">host</span><span class="si">}</span><span class="s2"> \</span>
<span class="s2"> --searchbase &#39;dc=ungleich,dc=ch&#39; \</span>
<span class="s2"> --syncrepl-credentials &#39;fooo&#39; \</span>
<span class="s2"> --syncrepl-host &#39;ldap-test1.ungleich.ch&#39; \</span>
<span class="s2"> --syncrepl-host &#39;ldap-test2.ungleich.ch&#39; \</span>
<span class="s2"> --description &#39;Ungleich LDAP server&#39;&quot;</span> <span class="se">\</span>
--staging <span class="se">\</span>
<span class="p">|</span> cdist config -i - -v <span class="si">${</span><span class="nv">host</span><span class="si">}</span>
<span class="nv">id</span><span class="o">=</span><span class="k">$((</span>id <span class="o">+</span> <span class="m">1</span><span class="k">))</span>
<span class="k">done</span>
<span class="c1"># The created basedn looks as follows:</span>
<span class="c1">#</span>
<span class="c1"># dn: dc=ungleich,dc=ch</span>
<span class="c1"># objectClass: top</span>
<span class="c1"># objectClass: dcObject</span>
<span class="c1"># objectClass: organization</span>
<span class="c1"># o: Ungleich LDAP server</span>
<span class="c1"># dc: ungleich</span>
<span class="c1">#</span>
<span class="c1"># Do not change it manually, the type will overwrite your changes.</span>
</pre></div>
</div>
</div>
<div class="section" id="see-also">
<h2><span class="section-number">16.99.9. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__letsencrypt_cert</strong>(7)</p>
</div>
<div class="section" id="authors">
<h2><span class="section-number">16.99.10. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>ungleich &lt;<a class="reference external" href="mailto:foss--&#37;&#52;&#48;--ungleich&#46;ch">foss--<span>&#64;</span>--ungleich<span>&#46;</span>ch</a>&gt;
Evilham &lt;<a class="reference external" href="mailto:contact--&#37;&#52;&#48;--evilham&#46;com">contact--<span>&#64;</span>--evilham<span>&#46;</span>com</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2><span class="section-number">16.99.11. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2020 ungleich glarus ag. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cdist-type__package.html" class="btn btn-neutral float-right" title="16.100. cdist-type__package(7)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cdist-type__mysql_user.html" class="btn btn-neutral float-left" title="16.98. cdist-type__mysql_user(7)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright ungleich GmbH 2021.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>