OpenLDAP Online Configuration Reference

By | 2019-03-16

My OpenLDAP Online Configuration (OLC) Reference provides the OLC equivalents of the configuration file options. It should be pretty accurate as I read the source code to determine which OLC attributes correspond to the configuration file options.

For a description of what the various options do, consult the appropriate man page or the official Administrator’s Guide.

For your convenience, the following links will take you to the relevant section:

If you know the object class the option applies to, you can jump to it on the page by selecting it from this menu and clicking the “Go” button:

Global Configuration Options

cn=config

Class NameolcGlobal
Configuration FileOnline Configuration
argsfileolcArgsFile
attributeoptionsolcAttributeOptions
attributeolcAttributeTypes
authid-rewriteolcAuthIDRewrite
authz-policyolcAuthzPolicy
authz-regexpolcAuthzRegexp
concurrencyolcConcurrency
conn_max_pendingolcConnMaxPending
conn_max_pending_autholcConnMaxPendingAuth
disallowsolcDisallows
gentlehupolcGentleHUP
idletimeoutolcIdleTimeout
index_substr_if_minlenolcIndexSubstrIfMinLen
index_substr_if_maxlenolcIndexSubstrIfMaxLen
index_substr_any_lenolcIndexSubstrAnyLen
index_substr_any_stepolcIndexSubstrAnyStep
index_intlenolcIndexIntLen
listener-threadsolcListenerThreads
localSSFolcLocalSSF
logfileolcLogFile
loglevelolcLogLevel
ditcontentruleolcDitContentRules
ldapsyntaxolcLdapSyntaxes
objectidentifierolcObjectIdentifier
rootDSEolcRootDSE
password-crypt-salt-formatolcPasswordCryptSaltFormat
password-hasholcPasswordHash
pidfileolcPidFile
pluginolcPlugin
readonlyolcReadOnly
referralolcReferral
TLSCACertificateFileolcTLSCACertificateFile
TLSCACertificatePatholcTLSCACertificatePath
TLSCertificateFileolcTLSCertificateFile
TLSCertificateKeyFileolcTLSCertificateKeyFile
TLSCipherSuiteolcTLSCipherSuite
TLSCRLCheckolcTLSCRLCheck
TLSCRLFileolcTLSCRLFile
TLSRandFileolcTLSRandFile
TLSVerifyClientolcTLSVerifyClient
TLSDHParamFileolcTLSDHParamFile
TLSProtocolMinolcTLSProtocolMin
reverse-lookupolcReverseLookup
sasl-auxpropsolcSaslAuxprops
sasl-hostolcSaslHost
sasl-realmolcSaslRealm
sasl-secpropsolcSaslSecProps
serverIDolcServerID
securityolcSecurity
sizelimitolcSizeLimit
sockbuf_max_incomingolcSockbufMaxIncoming
sockbuf_max_incoming_autholcSockbufMaxIncomingAuth
tcp-bufferolcTCPBuffer
threadsolcThreads
timelimitolcTimeLimit
tool-threadsolcToolThreads
writetimeoutolcWriteTimeout

olcDatabase=backend,cn=config

Class NameolcDatabaseConfig
Configuration FileOnline Configuration
accessolcAccess
add_content_aclolcAddContentAcl
allowsolcAddContentAcl
databaseolcDatabase
extra_attrsolcExtraAttrs
hiddenolcHidden
lastmodolcLastMod
limitsolcLimits
maxDerefDeptholcMaxDerefDepth
mirrormodeolcMirrorMode
replicaolcReplica
replica-argsfileolcReplicaArgsFile
replica-pidfileolcReplicaPidFile
replicationIntervalolcReplicationInterval
replogfileolcReplogFile
requireolcRequires
restrictolcRestrict
monitoringolcMonitoring
rootdnolcRootDN
rootpwolcRootPW
schemadnolcSchemaDN
subordinateolcSubordinate
suffixolcSuffix
sync_use_subentryolcSyncUseSubentry
syncreplolcSyncrepl
ucdata-patholcUpdateDN
updaterefolcUpdateRef

olcBackend=backend,cn=config

Class NameolcBackendConfig
Configuration FileOnline Configuration
backendolcBackend

olcDatabase={-1}frontend,cn=config

Class NameolcFrontendConfig
Configuration FileOnline Configuration
defaultSearchBaseolcDefaultSearchBase
sortvalsolcSortVals
password-hasholcPasswordHash

cn=schema_name,cn=schema,cn=config

Class NameolcSchemaConfig
Configuration FileOnline Configuration
ldapsyntaxolcLdapSyntaxes
objectclassolcObjectClasses
ditcontentruleolcDitContentRules
objectidentifierolcObjectIdentifier
attributeolcAttributeTypes

olcOverlay=overlay,olcDatabase=backend,cn=config

Class NameolcOverlayConfig
Configuration FileOnline Configuration
overlayolcOverlay

cn=include,cn=config

Object ClassolcIncludeFile
Configuration FileOnline Configuration
includeolcInclude
rootDSEolcRootDSE

cn=module,cn=config

Class NameoldModuleList
Configuration FileOnline Configuration
moduleloadolcModuleLoad
modulepatholcModulePath

Modules

autogroup module

Class NameolcAutomaticGroups
Configuration FileOnline Configuration
autogroup-memberof-adolcAGmemberOfAd

cloak module

Class NameolcCloakConfig
Configuration FileOnline Configuration
cloak-attrolcCloakAttribute

nssov module

Class NameolcNssOvConfig
Configuration FileOnline Configuration
nssov-ssdolcNssSsd
nssov-mapolcNssMap
nssov-pamolcNssPam
nssov-pam-defhostolcNssPamDefHost
nssov-pam-group-dnolcNssPamGroupDN
nssov-pam-group-adolcNssPamGroupAD
nssov-pam-min-uidolcNssPamMinUid
nssov-pam-max-uidolcNssPamMaxUid
nssov-pam-template-adolcNssPamTemplateAD
nssov-pam-templateolcNssPamTemplate
nssov-pam-sessionolcNssPamSession
nssov-pam-password-prohibit-messageolcNssPamPwdProhibitMsg
nssov-pam-pwdmgr-dnolcPamPwdmgrDn
nssov-pam-pwdmgr-pwdolcPamPwdmgrPwd

smbk5 module

Class NameolcSmbK5PwdConfig
Configuration FileOnline Configuration
smbk5pwd-enableolcSmbK5PwdEnable
smbk5pwd-must-changeolcSmbK5PwdMustChange
smbk5pwd-can-changeolcSmbK5PwdCanChange

Overlays

accesslog overlay

Class NameolcAccessLogConfig
Configuration FileOnline Configuration
logdbolcAccessLogDB
logopsolcAccessLogOps
logpurgeolcAccessLogPurge
logsuccessolcAccessLogSuccess
logoldolcAccessLogOld
logoldattrolcAccessLogOldAttr
logbaseolcAccessLogBase

auditlog overlay

Class NameolcAuditlogConfig
Configuration FileOnline Configuration
auditlogolcAuditlogFile

collect overlay

Class NameolcCollectConfig
Configuration FileOnline Configuration
collectinfoolcCollectInfo

constraint overlay

Class NameolcConstraintConfig
Configuration FileOnline Configuration
constraint_attributeolcConstraintAttribute

dds overlay

Class NameolcDDSConfig
Configuration FileOnline Configuration
dds-stateolcDDSstate
dds-max-ttlolcDDSmaxTtl
dds-min-ttlolcDDSminTtl
dds-default-ttlolcDDSdefaultTtl
dds-intervalolcDDSinterval
dds-toleranceolcDDStolerance
dds-max-dynamicObjectsolcDDSmaxDynamicObjects

dyngroup overlay

Class NameolcDGConfig
Configuration FileOnline Configuration
attrpairolcDGAttrPair

dynlist overlay

Class NameolcDynamicList
Configuration FileOnline Configuration
dynlist-attrsetolcDlAttrSet

memberof overlay

Class NameolcMemberOf
Configuration FileOnline Configuration
memberof-dnolcMemberOfDN
memberof-danglingolcMemberOfDangling
memberof-refintolcMemberOfRefInt
memberof-group-ocolcMemberOfGroupOC
memberof-member-adolcMemberOfMemberAD
memberof-memberof-adolcMemberOfMemberOfAD
memberof-dangling-errorolcMemberOfDanglingError

pcache overlay

Class NameolcPcacheConfig
Configuration FileOnline Configuration
pcacheolcPcacheolcProxyCache
pcacheAttrsetolcPcacheAttrsetolcProxyAttrset
pcacheTemplateolcPcacheTemplateolcProxyCacheTemplate
pcachePositionolcPcachePosition
pcacheMaxQueriesolcPcacheMaxQueriesolcProxyCacheQueries
pcachePersistolcPcachePersistolcProxySaveQueries
pcacheValidateolcPcacheValidateolcProxyCheckCacheability
pcacheOfflineolcPcacheOffline
pcacheBindolcPcacheBind

ppolicy overlay

Class NameolcPPolicyConfig
Configuration FileOnline Configuration
ppolicy_defaultolcPPolicyDefault
ppolicy_hash_cleartextolcPPolicyHashCleartext
ppolicy_forward_updatesolcPPolicyForwardUpdates
ppolicy_use_lockoutolcPPolicyUseLockout

refint overlay

Class NameolcRefintConfig
Configuration FileOnline Configuration
refint_attributesolcRefintAttribute
refint_nothingolcRefintNothing
refint_modifiersNameolcRefintModifiersName

retcode overlay

Class NameolcRetcodeConfig
Configuration FileOnline Configuration
retcode-parentolcRetcodeParent
retcode-itemolcRetcodeItem
retcode-indirolcRetcodeInDir
retcode-sleepolcRetcodeSleep

rwm overlay

Class NameolcRwmConfig
Configuration FileOnline Configuration
rwm-rewriteolcRwmRewrite
rwm-t-f-supportolcRwmTFSupport
rwm-mapolcRwmMap
rwm-normalize-mapped-attrsolcRwmNormalizeMapped
rwm-drop-unrequested-attrsolcRwmDropUnrequested

sssvlv overlay

Class NameolcSssVlvConfig
Configuration FileOnline Configuration
sssvlv-maxolcSssVlvMax
sssvlv-maxkeysolcSssVlvMaxKeys
sssvlv-maxperconnolcSssVlvMaxPerConn

syncprov overlay

Class NameolcSyncProvConfig
Configuration FileOnline Configuration
syncprov-checkpointolcSpCheckpoint
syncprov-sessionlogolcSpSessionlog
syncprov-nopresentolcSpNoPresent
syncprov-reloadhintolcSpReloadHint

translucent overlay

Class NameolcTranslucentConfig
Configuration FileOnline Configuration
olcTranslucentDatabase
translucent_strictolcTranslucentStrict
translucent_no_glueolcTranslucentNoGlue
translucent_localolcTranslucentLocal
translucent_remoteolcTranslucentRemote
translucent_bind_localolcTranslucentBindLocal
translucent_pwmod_localolcTranslucentPwModLocal

unique overlay

Class NameolcUniqueConfig
Configuration FileOnline Configuration
unique_baseolcUniqueBase
unique_ignoreolcUniqueIgnore
unique_attributesolcUniqueAttribute
unique_strictolcUniqueStrict
unique_uriolcUniqueURI

valsort overlay

Class NameolcValSortConfig
Configuration FileOnline Configuration
valsort-attrolcValSortAttr

Backends

bdb backend

Class NameolcBdbConfig
Configuration FileOnline Configuration
directoryolcDbDirectory
cachefreeolcDbCacheFree
cachesizeolcDbCacheSize
checkpointolcDbCheckpoint
checksumolcDbChecksum
cryptfileolcDbCryptFile
cryptkeyolcDbCryptKey
dbconfigolcDbConfig
dbnosyncolcDbNoSync
dbpagesizeolcDbPageSize
dirtyreadolcDbDirtyRead
dncachesizeolcDbDNcacheSize
idlcachesizeolcDbIDLcacheSize
indexolcDbIndex
linearindexolcDbLinearIndex
lockdetectolcDbLockDetect
modeolcDbMode
searchstackolcDbSearchStack
shm_keyolcDbShmKey

hdb backend

Class NameolcHdbConfig
Configuration FileOnline Configuration
directoryolcDbDirectory
cachefreeolcDbCacheFree
cachesizeolcDbCacheSize
checkpointolcDbCheckpoint
checksumolcDbChecksum
cryptfileolcDbCryptFile
cryptkeyolcDbCryptKey
dbconfigolcDbConfig
dbnosyncolcDbNoSync
dbpagesizeolcDbPageSize
dirtyreadolcDbDirtyRead
dncachesizeolcDbDNcacheSize
idlcachesizeolcDbIDLcacheSize
indexolcDbIndex
linearindexolcDbLinearIndex
lockdetectolcDbLockDetect
modeolcDbMode
searchstackolcDbSearchStack
shm_keyolcDbShmKey

ldap backend

Class NameolcLDAPConfig
Configuration FileOnline Configuration
uriolcDbURI
tlsolcDbStartTLS
acl-authcDNolcDbACLAuthcDn
binddnolcDbACLAuthcDn
acl-passwdolcDbACLPasswd
bindpwolcDbACLPasswd
acl-bindolcDbACLBind
idassert-authcDNolcDbIDAssertAuthcDn
idassert-passwdolcDbIDAssertPasswd
idassert-bindolcDbIDAssertBind
idassert-modeolcDbIDAssertMode
idassert-authzFromolcDbIDAssertAuthzFrom
rebind-as-userolcDbRebindAsUser
chase-referralsolcDbChaseReferrals
t-f-supportolcDbTFSupport
proxy-whoamiolcDbProxyWhoAmI
timeoutolcDbTimeout
idle-timeoutolcDbIdleTimeout
conn-ttlolcDbConnTtl
network-timeoutolcDbNetworkTimeout
protocol-versionolcDbProtocolVersion
single-connolcDbSingleConn
cancelolcDbCancel
quarantineolcDbQuarantine
use-temporary-connolcDbUseTemporaryConn
conn-pool-maxolcDbConnectionPoolMax
session-tracking-requestolcDbSessionTrackingRequest
norefsolcDbNoRefs
noundeffilterolcDbNoUndefFilter
onerrolcDbOnErr
idassert-passThruolcDbIDAssertPassThru
omit-unknown-schemaolcDbRemoveUnknownSchema
keepaliveolcDbKeepalive

ldif backend

Class NameolcLdifConfig
Configuration FileOnline Configuration
directoryolcDbDirectory

mdb backend

Class NameolcMdbConfig
Configuration FileOnline Configuration
directoryolcDbDirectory
checkpointolcDbCheckpoint
dbnosyncolcDbNoSync
envflagsolcDbEnvFlags
indexolcDbIndex
maxreadersolcDbMaxReaders
maxsizeolcDbMaxSize
modeolcDbMode
rtxnsizeolcDbRtxnSize
searchstackolcDbSearchStack

ndb backend

Class NameolcNdbConfig
Configuration FileOnline Configuration
dbhostolcDbHost
dbnameolcDbName
dbuserdbuser
dbpassolcDbPass
dbportolcDbPort
dbsocketolcDbSocket
dbflagolcDbFlag
dbconnectolcDbConnect
dbconnectionsolcDbConnections
attrlenolcNdbAttrLen
attrsetolcNdbAttrSet
indexolcDbIndex
attrblobolcNdbAttrBlob
directoryolcDbDirectory

null backend

Class NameolcNullConfig
Configuration FileOnline Configuration
bindolcDbBindAllowed
dosearcholcDbDoSearch

passwd backend

Class NameolcPasswdConfig
Configuration FileOnline Configuration
fileolcPasswdFile

perl backend

Class NameolcovPerlConfig
Configuration FileOnline Configuration
perlModuleolcPerlModule
perlModulePatholcPerlModulePath
filterSearchResultsolcPerlFilterSearchResults
perlModuleConfigolcPerlModuleConfig

relay backend

Class NameolcRelayConfig
Configuration FileOnline Configuration
relayolcRelay

shell backend

Class NameolcShellConfig
Configuration FileOnline Configuration
bindolcShellBind
unbindolcShellUnbind
searcholcShellSearch
compareolcShellCompare
modifyolcShellModify
modrdnolcShellModRDN
addolcShellAdd
deleteolcShellDelete

sql backend

Class NameolcSqlConfig
Configuration FileOnline Configuration
dbhostolcDbHost
dbnameolcDbName
dbuserolcDbUser
dbpasswddbpasswd
concat_patternolcSqlConcatPattern
subtree_condolcSqlSubtreeCond
children_condolcSqlChildrenCond
dn_match_condolcSqlDnMatchCond
oc_queryolcSqlOcQuery
at_queryolcSqlAtQuery
insentry_stmtolcSqlInsEntryStmt
create_needs_selectolcSqlCreateNeedsSelect
upper_funcolcSqlUpperFunc
upper_needs_castolcSqlUpperNeedsCast
strcast_funcolcSqlStrcastFunc
delentry_stmtolcSqlDelEntryStmt
renentry_stmtolcSqlRenEntryStmt
delobjclasses_stmtolcSqlDelObjclassesStmt
has_ldapinfo_dn_ruolcSqlHasLDAPinfoDnRu
fail_if_no_mappingolcSqlFailIfNoMapping
allow_orphansolcSqlAllowOrphans
baseobjectolcSqlBaseObject
sqllayerolcSqlLayer
use_subtree_shortcutolcSqlUseSubtreeShortcut
fetch_all_attrsolcSqlFetchAllAttrs
fetch_attrsolcSqlFetchAttrs
check_schemaolcSqlCheckSchema
aliasing_keywordolcSqlAliasingKeyword
aliasing_quoteolcSqlAliasingQuote
autocommitolcSqlAutocommit
id_queryolcSqlIdQuery

socket backend

Class NameolcDbSocketConfig
Configuration FileOnline Configuration
socketpatholcDbSocketPath
extensionsolcDbSocketExtensions
Class NameolcOvSOcketConfig
Configuration FileOnline Configuration
socketpatholcDbSocketPath
extensionsolcDbSocketExtensions
sockopsolcOvSocketOps
sockrespsolcOvSocketResps
sockdnpatolcOvSocketDNpat

monitor backend

Class NameolcMonitorConfig
tyler@desktop:~/olcref/backends/complicated$ cat meta.html

meta backend

Class NameolcMetaConfig
Configuration FileOnline Configuration
bind-timeoutolcDbBindTimeout
timeoutolcDbTimeout
cancelolcDbCancel
conn-ttlolcDbConnTtl
chase-referralsolcDbChaseReferrals
client-prolcDbClientPr
default-targetolcDbDefaultTarget
network-timeoutolcDbNetworkTimeout
norefsolcDbNoRefs
noundeffilterolcDbNoUndefFilter
nretriesolcDbNretries
protocol-versionolcDbProtocolVersion
quarantineolcDbQuarantine
rebind-as-userolcDbRebindAsUser
session-tracking-requestolcDbSessionTrackingRequest
tlsolcDbStartTLS
t-f-supportolcDbTFSupport
dncache-ttlolcDbDnCacheTtl
idle-timeoutolcDbIdleTimeout
onerrolcDbOnErr
pseudoroot-bind-deferolcDbPseudoRootBindDefer
single-connolcDbSingleConn
use-temporary-connolcDbUseTemporaryConn
conn-pool-maxolcDbCOnnectionPoolMax
Class NameolcMetaTargetConfig
Configuration FileOnline Configuration
binddnolcDbACLAuthcDn
acl-authcDNolcDbACLAuthcDn
acl-passwdolcDbACLPasswd
bindpwolcDbACLPasswd
bind-timeoutolcDbBindTimeout
timeoutolcDbTimeout
cancelolcDbCancel
chase-referralsolcDbChaseReferrals
client-prolcDbClientPr
filterolcDbFilter
idassert-bindolcDbIDAssertBind
idassert-authzFromolcDbIDAssertAuthzFrom
default-targetolcDbDefaultTarget
keepaliveolcDbKeepalive
network-timeoutolcDbNetworkTimeout
norefsolcDbNoRefs
noundeffilterolcDbNoUndefFilter
nretriesolcDbNretries
mapolcDbMap
protocol-versionolcDbProtocolVersion
quarantineolcDbQuarantine
rebind-as-userolcDbRebindAsUser
rewriteolcDbRewrite
session-tracking-requestolcDbSessionTrackingRequest
subtree-excludeolcDbSubtreeExclude
subtree-includeolcDbSubtreeInclude
tlsolcDbStartTLS
timeoutolcDbTimeout
t-f-supportolcDbTFSupport
uriolcDbURI
olcMetaSub

monitor backend

Class NameolcMonitorConfig

References