Resource Type: openldap_database

Defined in:

lib/puppet/type/openldap_database.rb

Providers:

olc

Overview

Manages OpenLDAP BDB and HDB databases.

Properties

• backend

  The name of the backend.

  Supported values:

  • bdb
  • hdb
  • mdb
  • monitor
  • config
  • relay
  • ldap
• dbmaxsize

  Specifies the maximum size of the DB in bytes.

• dboptions

  Hash to pass specific HDB/BDB options for the database

• directory

  The directory where the BDB files containing this database and associated indexes live.

• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent
• index

  The index of the database.

• limits

  Limits the number entries returned and/or the time spent by a request

• mirrormode

  This option puts a replica database into “mirror” mode, deprecated as of 2.5

  Supported values:

  • true
  • false
• multiprovider

  This option puts a replica database into “multiprovider” mode

  Supported values:

  • true
  • false
• readonly

  Puts the database into read-only mode.

• rootdn

  The distinguished name that is not subject to access control or administrative limit restrictions for operations on this database.

• rootpw

  Password (or hash of the password) for the rootdn.

• security

  The olcSecurity configuration.

• sizelimit

  Specifies the maximum number of entries to return from a search operation.

• syncrepl

  Specify the current database as a replica which is kept up-to-date with the master content by establishing the current slapd(8) as a replication consumer site running a syncrepl replication engine.

• syncusesubentry

  Store the syncrepl contextCSN in a subentry instead of the context entry of the database

• timelimit

  Specifies the maximum number of seconds (in real time) slapd will spend answering a search request.

• updateref

  This directive is only applicable in a slave slapd. It specifies the URL to return to clients which submit update requests upon the replica.

Parameters

• initdb

  When true it initiales the database with the top object. When false, it does not create any object in the database, so you have to create it by other mechanism. It defaults to false when the backend is one of config, ldap, monitor or relay, true otherwise.

  Supported values:

  • true
  • false
• organization

  Organization name used when initdb is true

• provider

  The specific backend to use for this ‘openldap_database` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

• relay

  The relay configuration.

• suffix

  The default namevar.

• synctype (defaults to: minimum)

  Whether specified dboptions should be considered the complete list (inclusive) or the minimum list (minimum) of dboptions the database should have. Defaults to minimum.

  Valid values are inclusive, minimum.

  Supported values:

  • inclusive
  • minimum
• target