ldap3-orm.config module

Configuration Singleton

class ldap3_orm.config.config

Holds all configuration parameters

This is a configuration singleton populated on startup of ldap3-ipython with entries given as command line arguments and/or entries from the configuration file.

This class is helpful for creating reusable modules based on configuration parameters, e.g. base_dn which usually changes when administrating different domains, e.g. example.com vs. example.org which results in the following base_dn settings:

base_dn = "dc=example,dc=com"
base_dn = "dc=example,dc=org"

If this class is imported from the ldap3_orm.config module before any configuration has been applied this class will be populated from the default configuration file if this exists or left unpopulated otherwise.

base_dn = ''

Ldap base dn

connconfig = {}

Dictionary containing keyword arguments for ldap3_orm.Connection, e.g.:

connconfig = dict(
    user = "cn=Directory Manager",
    password = "changeme",
)

which uses simple bind with a plain-text password stored in the configuration file.

For safe password storage ldap3-orm supports keyring, e.g.:

connconfig = dict(
    user = "cn=Directory Manager",
    password = keyring,
)

modules = None

Python modules to include into current namespace in ldap3-ipython

password = None

The password of the user for simple bind or keyring to use the keyring module for safe password storage.

pythonpaths = None

Paths prepended in PYTHONPATH environment in ldap3-ipython

url = None

Ldap server url in the scheme://hostname:port

userconfig = {}

Dictionary containing user-defined configuration entries.

username = None

The account of the user to log in for simple bind