OpenLDAP Tuning Keys 8.0

Revision as of 03:02, 21 July 2012 by Quanah (talk | contribs)
Admin Article

Article Information

This article applies to the following ZCS versions.

ZCS 8.0 Article ZCS 8.0


OpenLDAP Tuning Keys

Starting with ZCS 8.0, Zimbra uses MDB as the database backend, and the configuration continues to be stored in a database. This allows the ability to make changes to the OpenLDAP configuration on the fly. To support this, a number of keys were added to Localconfig. When modified via zmlocalconfig, the values will automatically be updated in the OpenLDAP server configuration within 2 minutes. It is advised to also read over the OpenLDAP Performance Wiki as well.

OpenLDAP Common keys

These keys set the general, or common, settings for the slapd process. They are apply to both the master and replica servers. More detail on what these keys determine can be found by reading the slapd.conf(5) man page

  • Set the loglevel level to be used. The default is 49152
zmlocalconfig -e ldap_common_loglevel=49152
  • Set the threads count to an appropriate level. The ZCS default is 8, which is fine for 1 or 2 CPU servers. The general rule of thumb is 4 threads for every real core.
zmlocalconfig -e ldap_common_threads=8
  • Set whether or not an encrypted connection is required to establish communication with the LDAP server. 0 for no, 1 for yes. Default is 0. Changing this option requires a server restart for it to take effect.
ldap_common_require_tls=0
  • Set the toolthreads count to an appropriate level. The ZCS default is 2. It should be set to 2.
zmlocalconfig -e ldap_common_toolthreads=2
  • Set the writetimeout for how long to wait for a write to succeed. The default is 0, which is infinitely. Otherwise, forcefully close the connection after the specified number of seconds.
zmlocalconfig -e ldap_common_writetimeout=0

OpenLDAP Primary Database keys

These keys apply to the primary LDAP database. They are apply to both the master and replica servers. More detail on what these keys determine can be found by reading the slapd-mdb(5) man page

  • How frequently to checkpoint the database to disk. This flushes data from the cache to the database. Default is every 64KB or 5 minutes. It takes two values.
zmlocalconfig -e ldap_db_checkpoint="64 5"
  • Maximum allowable size for the primary database. WARNING: If your database reaches the size of this value, dataloss will occur. Defaults to 85GB
zmlocalconfig -e ldap_db_maxsize=85899345920

OpenLDAP Accesslog Database Keys

These keys apply to the Accesslog LDAP database used for replication. They are apply only to the master server. More detail on what these keys determine can be found by reading the slapd-mdb(5) man page

  • How frequently to checkpoint the accesslog database to disk. This flushes data from the cache to the database. Default is every 64KB or 5 minutes. It takes two values.
zmlocalconfig -e ldap_accesslog_checkpoint="64 5"
  • Maximum allowable size for the accesslog database. WARNING: If your database reaches the size of this value, dataloss will occur. Defaults to 85GB
zmlocalconfig -e ldap_accesslog_maxsize=85899345920

OpenLDAP Overlay Keys

The following keys are specific to the OpenLDAP overlays used by ZCS.

OpenLDAP Accesslog Overlay Keys

This key applies to the accesslog overlay. It is only meaningful on the LDAP master. More detail on what this key determines can be found by reading the slapo-accesslog(5) man page

  • How often to purge old entries from the accesslog database, and what age they need to be. The default is to purge all entries 1 day or older, and to run the purges every 4 hours. It takes two values, the first being the age of the entries to delete, the second being how frequently to run the deletion.
zmlocalconfig -e ldap_overlay_accesslog_logpurge="01+00:00  00+04:00"

OpenLDAP Syncprov Overlay Keys

The following keys apply to the syncprov overlay. It is only meaningful on the LDAP master. More detail on what these keys determine can be found by reading the slapo-syncprov(5) man page

  • How often to checkpoint the current CSN to the underlying database. The default is every 20 changes or 10 minutes. It takes two values.
zmlocalconfig -e ldap_overlay_syncprov_checkpoint="20 10"


Verified Against: ZCS 8.0 Date Created: 7/20/2012
Article ID: https://wiki.zimbra.com/index.php?title=OpenLDAP_Tuning_Keys_8.0 Date Modified: 2012-07-21



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search