Plugin

You can take plugin constant names here - https://github.com/389ds/389-ds-base/blob/master/src/lib389/lib389/_constants.py#L179

Usage example

# Plugin and Plugins additionaly have 'enable', 'disable' and 'status' methods
# Here I show you basic way to work with it. Additional methods of complex plugins will be described in subchapters

from lib389.plugin import Plugins, ACLPlugin
from lib389._constants import PLUGIN_ACL

# You can just enable/disable plugins from Plugins interface
plugins = Plugins(standalone)
plugins.enable(PLUGIN_ACL)

# Or you can first 'get' it and then work with it (make sense if your plugin is a complex one)
aclplugin = ACLPlugin(standalone)

aclplugin.enable()

aclplugin.disable()

# True if nsslapd-pluginEnabled is 'on', False otherwise - change the name?
assert(uniqplugin.status())

Module documentation

class lib389.plugins.ACLPlugin(instance, dn='cn=ACL Plugin,cn=plugins,cn=config')

An instance of addn plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.ACLPreoperationPlugin(instance, dn='cn=ACL preoperation,cn=plugins,cn=config')

An instance of ACL preoperation plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.AccountPolicyConfig(instance, dn=None)

A single instance of Account Policy Plugin config entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.AccountPolicyConfigs(instance, basedn='cn=Account Policy Plugin,cn=plugins,cn=config')

A DSLdapObjects entity which represents Account Policy Plugin config entry

Parameters

• instance (lib389.DirSrv) – An instance

• basedn (str) – Base DN for all account entries below

class lib389.plugins.AccountPolicyEntries(instance, basedn)

A DSLdapObjects entity which represents Account Policy Plugin entry which is used for CoS

Parameters

• instance (lib389.DirSrv) – An instance

• basedn (str) – Base DN for all account entries below

class lib389.plugins.AccountPolicyEntry(instance, dn=None)

A single instance of Account Policy Plugin entry which is used for CoS

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.AccountPolicyPlugin(instance, dn='cn=Account Policy Plugin,cn=plugins,cn=config')

A single instance of Account Policy plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.AccountUsabilityPlugin(instance, dn='cn=Account Usability Plugin,cn=plugins,cn=config')

An instance of Account Usability plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.AddnPlugin(instance, dn='cn=addn,cn=plugins,cn=config')

An instance of addn plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.AttributeUniquenessPlugin(instance, dn)

An instance of attribute uniqueness plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

add_unique_attribute(attr)

Add a uniqueness-attribute-name attribute

add_unique_subtree(basedn)

Add a uniqueness-subtree attribute

disable_all_subtrees()

Set uniqueness-across-all-subtrees to off

enable_all_subtrees()

Set uniqueness-across-all-subtrees to on

remove_unique_attribute(attr)

Remove a uniqueness-attribute-name attribute

remove_unique_subtree(basedn)

Remove a uniqueness-subtree attribute

class lib389.plugins.AttributeUniquenessPlugins(instance, basedn='cn=plugins,cn=config')

A DSLdapObjects entity which represents Attribute Uniqueness plugin instances

Parameters

• instance (lib389.DirSrv) – An instance

• basedn (str) – Base DN for all account entries below

list()

Get a list of all plugin instances where nsslapd-pluginInitfunc: NSUniqueAttr_Init

Returns

A list of children entries

class lib389.plugins.AutoMembershipDefinition(instance, dn)

A single instance of Auto Membership Plugin config entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

add_regex_rule(rule_name, target, include_regex=None, exclude_regex=None)

Add a regex rule :param rule_name - Name of the rule - used dfor the “cn” value inthe DN of the rule entry :param target - the target group DN :param include_regex - a List of regex rules used for group inclusion :param exclude_regex - a List of regex rules used for group exclusion

del_regex_rule(rule_name)

Delete a regex rule from this definition :param rule_name - The “cn” values of the regex rule entry :raises ValueError - If a regex rule entry can not be found using rule_name

get_defaultgroup(attr)

Get autoMemberDefaultGroup attributes

get_filter(attr)

Get autoMemberFilter attributes

get_groupattr()

Get autoMemberGroupingAttr attributes

get_scope(attr)

Get autoMemberScope attributes

list_regex_rules()

Return a list of regex rule entries for this definition

set_defaultgroup(attr)

Set autoMemberDefaultGroup attribute

set_filter(attr)

Set autoMemberFilter attributes

set_groupattr(attr)

Set autoMemberGroupingAttr attribute

set_scope(attr)

Set autoMemberScope attribute

class lib389.plugins.AutoMembershipDefinitions(instance, basedn='cn=Auto Membership Plugin,cn=plugins,cn=config')

A DSLdapObjects entity which represents Auto Membership Plugin config entry

Parameters

• instance (lib389.DirSrv) – An instance

• basedn (str) – Base DN for all account entries below

class lib389.plugins.AutoMembershipPlugin(instance, dn='cn=Auto Membership Plugin,cn=plugins,cn=config')

An instance of Auto Membership plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

fixup(basedn, _filter=None)

Create an automember rebuild membership task

Parameters

• basedn (str) – Basedn to fix up

• _filter (str) – a filter for entries to fix up

Returns

an instance of Task(DSLdapObject)

class lib389.plugins.AutoMembershipRegexRule(instance, dn=None)

A single instance of Auto Membership Plugin Regex Rule config entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.AutoMembershipRegexRules(instance, basedn)

A DSLdapObjects entity which represents Auto Membership Plugin Regex Rule config entry

Parameters

• instance (lib389.DirSrv) – An instance

• basedn (str) – Base DN for all account entries below

class lib389.plugins.BitwisePlugin(instance, dn='cn=Bitwise Plugin,cn=plugins,cn=config')

A single instance of Bitwise plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.ChainingBackendPlugin(instance, dn='cn=chaining database,cn=plugins,cn=config')

A single instance of chaining database plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.ClassOfServicePlugin(instance, dn='cn=Class of Service,cn=plugins,cn=config')

An instance of Class of Service plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.ContentSyncPlugin(instance, dn='cn=Content Synchronization,cn=plugins,cn=config')

A single instance of Content Sync (aka syncrepl) plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.ContentSynchronizationPlugin(instance, dn='cn=Content Synchronization,cn=plugins,cn=config')

A single instance of Content Synchronization plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.DNAPlugin(instance, dn='cn=Distributed Numeric Assignment Plugin,cn=plugins,cn=config')

A single instance of Distributed Numeric Assignment plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.DNAPluginConfig(instance, dn=None)

A single instance of DNA Plugin config entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.DNAPluginConfigs(instance, basedn='cn=Distributed Numeric Assignment Plugin,cn=plugins,cn=config')

A DSLdapObjects entity which represents DNA Plugin config entry

Parameters

• instance (lib389.DirSrv) – An instance

• basedn (str) – Base DN for all account entries below

class lib389.plugins.DNAPluginSharedConfig(instance, dn=None)

A single instance of DNA Plugin config entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

create(properties=None, basedn=None, ensure=False)

The shared config DNA plugin entry has two RDN values The function takes care about that special case

class lib389.plugins.DNAPluginSharedConfigs(instance, basedn=None)

A DSLdapObjects entity which represents DNA Plugin config entry

Parameters

• instance (lib389.DirSrv) – An instance

• basedn (str) – Base DN for all account entries below

create(properties=None)

Create an object under base DN of our entry

Parameters

properties (dict) – Attributes for the new entry

Returns

DSLdapObject of the created entry

class lib389.plugins.DereferencePlugin(instance, dn='cn=deref,cn=plugins,cn=config')

A single instance of deref plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.EntryUUIDPlugin(instance, dn='cn=entryuuid,cn=plugins,cn=config')

The EntryUUID plugin configuration

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

fixup(basedn, _filter=None)

Create an entryuuid fixup task

Parameters

• basedn (str) – Basedn to fix up

• _filter (str) – a filter for entries to fix up

Returns

an instance of Task(DSLdapObject)

class lib389.plugins.HTTPClientPlugin(instance, dn='cn=HTTP Client,cn=plugins,cn=config')

A single instance of HTTP Client plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.LDBMBackendPlugin(instance, dn='cn=ldbm database,cn=plugins,cn=config')

A single instance of ldbm database plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.LdapSSOTokenPlugin(instance, dn='cn=ldapssotoken,cn=plugins,cn=config')

An instance of ldapssotoken plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.LinkedAttributesConfig(instance, dn=None)

A single instance of Linked Attributes Plugin config entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.LinkedAttributesConfigs(instance, basedn='cn=Linked Attributes,cn=plugins,cn=config')

A DSLdapObjects entity which represents Linked Attributes Plugin config entry

Parameters

• instance (lib389.DirSrv) – An instance

• basedn (str) – Base DN for all account entries below

class lib389.plugins.LinkedAttributesPlugin(instance, dn='cn=Linked Attributes,cn=plugins,cn=config')

A single instance of Linked Attributes plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

fixup(linkdn)

Create a fixup linked attributes task

Parameters

linkdn (str) – Link DN to fix up

Returns

an instance of Task(DSLdapObject)

class lib389.plugins.MEPConfig(instance, dn)

A single instance of MEP config entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.MEPConfigs(instance, basedn=None)

A DSLdapObjects entity which represents MEP config entry

Parameters

• instance (lib389.DirSrv) – An instance

• basedn (str) – Base DN for all account entries below

list()

Get a list of children entries (DSLdapObject, Replica, etc.) using a base DN and objectClasses of our object (DSLdapObjects, Replicas, etc.)

Returns

A list of children entries

class lib389.plugins.MEPTemplate(instance, dn=None)

A single instance of MEP template entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.MEPTemplates(instance, basedn)

A DSLdapObjects entity which represents MEP template entry

Parameters

• instance (lib389.DirSrv) – An instance

• basedn (str) – Base DN for all account entries below

class lib389.plugins.ManagedEntriesPlugin(instance, dn='cn=Managed Entries,cn=plugins,cn=config')

An instance of managed entries plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.MemberOfPlugin(instance, dn='cn=MemberOf Plugin,cn=plugins,cn=config')

An instance of MemberOf plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

add_entryscope(attr)

Add memberofentryscope attribute

add_excludescope(attr)

Add memberofentryscopeexcludesubtree attribute

add_groupattr(attr)

Add memberofgroupattr attribute

disable_allbackends()

Set memberofallbackends to off

disable_skipnested()

Set memberofskipnested to off

enable_allbackends()

Set memberofallbackends to on

enable_skipnested()

Set memberofskipnested to on

fixup(basedn, _filter=None)

Create a memberOf task

Parameters

• basedn (str) – Basedn to fix up

• _filter (str) – a filter for entries to fix up

Returns

an instance of Task(DSLdapObject)

get_allbackends()

Get memberofallbackends attribute

get_allbackends_formatted()

Display memberofallbackends attribute

get_attr()

Get memberofattr attribute

get_attr_formatted()

Display memberofattr attribute

get_autoaddoc()

Get memberofautoaddoc attribute

get_autoaddoc_formatted()

Display memberofautoaddoc attribute

get_configarea()

Get nsslapd-pluginConfigArea attribute

get_entryscope(formatted=False)

Get memberofentryscope attributes

get_entryscope_formatted()

Display memberofentryscope attributes

get_excludescope()

Get memberofentryscopeexcludesubtree attributes

get_excludescope_formatted()

Display memberofentryscopeexcludesubtree attributes

get_groupattr()

Get memberofgroupattr attribute

get_groupattr_formatted()

Display memberofgroupattr attribute

get_skipnested()

Get memberofskipnested attribute

get_skipnested_formatted()

Display memberofskipnested attribute

remove_all_entryscope()

Remove all memberofentryscope attributes

remove_all_excludescope()

Remove all memberofentryscopeexcludesubtree attributes

remove_autoaddoc()

Remove all memberofautoaddoc attributes

remove_configarea()

Remove nsslapd-pluginConfigArea attribute

remove_entryscope(attr)

Remove memberofentryscope attribute

remove_excludescope(attr)

Remove memberofentryscopeexcludesubtree attribute

remove_groupattr(attr)

Remove memberofgroupattr attribute

replace_groupattr(attr)

Replace memberofgroupattr attribute

set_attr(attr)

Set memberofattr attribute

set_autoaddoc(object_class)

Set memberofautoaddoc attribute

set_configarea(attr)

Set nsslapd-pluginConfigArea attribute

class lib389.plugins.MemberOfSharedConfig(instance, dn)

An instance of MemberOf config entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.MemberOfSharedConfigs(instance, basedn=None)

A DSLdapObjects entity which represents MemberOf config entry

Parameters

• instance (lib389.DirSrv) – An instance

• basedn (str) – Base DN for all account entries below

class lib389.plugins.PAMPassThroughAuthConfig(instance, dn=None)

A single instance of PAM Pass Through Auth config entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.PAMPassThroughAuthConfigs(instance, basedn='cn=PAM Pass Through Auth,cn=plugins,cn=config')

A DSLdapObjects entity which represents PAM Pass Through Auth config entry

Parameters

• instance (lib389.DirSrv) – An instance

• basedn (str) – Base DN for all account entries below

class lib389.plugins.PAMPassThroughAuthPlugin(instance, dn='cn=PAM Pass Through Auth,cn=plugins,cn=config')

A single instance of PAM Pass Through Auth plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.POSIXWinsyncPlugin(instance, dn='cn=Posix Winsync API,cn=plugins,cn=config')

A single instance of Posix Winsync API plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

fixup(basedn, _filter=None)

Create a memberuid task

Parameters

• basedn (str) – Basedn to fix up

• _filter (str) – a filter for entries to fix up

Returns

an instance of Task(DSLdapObject)

class lib389.plugins.PassThroughAuthenticationPlugin(instance, dn='cn=Pass Through Authentication,cn=plugins,cn=config')

A single instance of Pass Through Authentication plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

get_urls()

Get all URLs from nsslapd-pluginargNUM attributes

Returns

a list

class lib389.plugins.Plugin(instance, dn=None)

A single instance of a plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

create(rdn=None, properties=None, basedn=None)

Create a plugin entry

When we create plugins, we don’t want people to have to consider all the little details. Plus, the server during creation needs to be able to create these from nothing. As a result, all the named plugins carry a default properties dictionary that can be used.

Parameters

• rdn (str) – RDN of the new entry

• properties (dict) – Attributes for the new entry

• basedn – Base DN of the new entry

Returns

Plugin class instance of the created entry

disable()

Set nsslapd-pluginEnabled to off

enable()

Set nsslapd-pluginEnabled to on

restart()

Disable and then enable the plugin

status()

Check if the plugin is enabled

class lib389.plugins.Plugins(instance, basedn=None)

A DSLdapObjects entity which represents plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• basedn (str) – Base DN for all account entries below

disable(name=None, plugin_dn=None)

Set nsslapd-pluginEnabled to off

enable(name=None, plugin_dn=None)

Set nsslapd-pluginEnabled to on

class lib389.plugins.ReferentialIntegrityConfig(instance, dn)

An instance of Referential Integrity config entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.ReferentialIntegrityPlugin(instance, dn='cn=referential integrity postoperation,cn=plugins,cn=config')

An instance of referential integrity postoperation plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

add_container_scope(attr)

Add nsslapd-plugincontainerscope attribute

add_entryscope(attr)

Add nsslapd-pluginentryscope attribute

add_excludescope(attr)

Add nsslapd-pluginexcludeentryscope attribute

add_membership_attr(attr)

Add referint-membership-attr attribute

create(rdn=None, properties=None, basedn=None)

Create an instance of the plugin

get_configarea()

Get nsslapd-pluginConfigArea attribute

get_container_scope()

Get nsslapd-plugincontainerscope attribute

get_container_scope_formatted()

Display nsslapd-plugincontainerscope attribute

get_entryscope(formatted=False)

Get nsslapd-pluginentryscope attribute

get_entryscope_formatted()

Display nsslapd-pluginentryscope attribute

get_excludescope()

Get nsslapd-pluginexcludeentryscope attribute

get_excludescope_formatted()

Display nsslapd-pluginexcludeentryscope attribute

get_membership_attr(formatted=False)

Get referint-membership-attr attribute

get_membership_attr_formatted()

Display referint-membership-attr attribute

get_update_delay()

Get referint-update-delay attribute

get_update_delay_formatted()

Display referint-update-delay attribute

remove_all_container_scope()

Remove all nsslapd-plugincontainerscope attributes

remove_all_entryscope()

Remove all nsslapd-pluginentryscope attributes

remove_all_excludescope()

Remove all nsslapd-pluginexcludeentryscope attributes

remove_configarea()

Remove all nsslapd-pluginConfigArea attributes

remove_container_scope(attr)

Remove nsslapd-plugincontainerscope attribute

remove_entryscope(attr)

Remove nsslapd-pluginentryscope attribute

remove_excludescope(attr)

Remove nsslapd-pluginexcludeentryscope attribute

remove_membership_attr(attr)

Remove referint-membership-attr attribute

set_configarea(attr)

Set nsslapd-pluginConfigArea attribute

set_update_delay(value)

Set referint-update-delay attribute

class lib389.plugins.RetroChangelogPlugin(instance, dn='cn=Retro Changelog Plugin,cn=plugins,cn=config')

An instance of Retro Changelog plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.RolesPlugin(instance, dn='cn=Roles Plugin,cn=plugins,cn=config')

An instance of Roles plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.RootDNAccessControlPlugin(instance, dn='cn=RootDN Access Control,cn=plugins,cn=config')

A single instance of RootDN Access Control plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

add_allow_day(day)

Add a value to rootdn-days-allowed attribute

add_allow_host(attr)

Add rootdn-allow-host attribute

add_allow_ip(attr)

Add rootdn-allow-ip attribute

static add_day_to_days(string_of_days, day)

Append a day in a string of comma separated days and return the string. If day already exists in the string, return processed string.

Keyword arguments: string_of_days – a string of comma seperated days

examples:

Mon Tue, Wed, Thu

day – a day, e.g. Mon, Tue, etc.

add_deny_host(attr)

Add rootdn-deny-host attribute

add_deny_ip(attr)

Add rootdn-deny-ip attribute

get_allow_host()

Get rootdn-allow-host attribute

get_allow_host_formatted()

Display rootdn-allow-host attribute

get_allow_ip()

Get rootdn-allow-ip attribute

get_allow_ip_formatted()

Display rootdn-allow-ip attribute

get_close_time()

Get rootdn-close-time attribute

get_close_time_formatted()

Display rootdn-close-time attribute

get_days_allowed()

Get rootdn-days-allowed attribute

get_days_allowed_formatted()

Display rootdn-days-allowed attribute

get_deny_host()

Get rootdn-deny-host attribute

get_deny_host_formatted()

Display rootdn-deny-host attribute

get_deny_ip()

Remove all rootdn-deny-ip attribute

get_deny_ip_formatted()

Display rootdn-deny-ip attribute

get_open_time()

Get rootdn-open-time attribute

get_open_time_formatted()

Display rootdn-open-time attribute

remove_all_allow_host()

Remove all rootdn-allow-host attributes

remove_all_allow_ip()

Remove all rootdn-allow-ip attribute

remove_all_deny_host()

Remove all rootdn-deny-host attribute

remove_all_deny_ip()

Remove all rootdn-deny-ip attribute

remove_allow_day(day)

Remove a value from rootdn-days-allowed attribute

remove_allow_host(attr)

Remove rootdn-allow-host attribute

remove_allow_ip(attr)

Remove rootdn-allow-ip attribute

remove_close_time()

Remove all rootdn-close-time attributes

static remove_day_from_days(string_of_days, day)

Remove a day from a string of comma separated days and return the string. If day does not exists in the string, return processed string.

Keyword arguments: string_of_days – a string of comma seperated days

examples:

Mon Tue, Wed, Thu

day – a day, e.g. Mon, Tue, etc.

remove_days_allowed()

Remove all rootdn-days-allowed attributes

remove_deny_host(attr)

Remove rootdn-deny-host attribute

remove_deny_ip(attr)

Remove rootdn-deny-ip attribute

remove_open_time()

Remove all rootdn-open-time attributes

set_close_time(attr)

Set rootdn-close-time attribute

set_days_allowed(attr)

Set rootdn-days-allowed attribute

set_open_time(attr)

Set rootdn-open-time attribute

class lib389.plugins.SchemaReloadPlugin(instance, dn='cn=Schema Reload,cn=plugins,cn=config')

An instance of Schema Reload plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.SevenBitCheckPlugin(instance, dn='cn=7-bit check,cn=plugins,cn=config')

An instance of addn plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.StateChangePlugin(instance, dn='cn=State Change Plugin,cn=plugins,cn=config')

An instance of State Change plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.SyntaxValidationPlugin(instance, dn='cn=Syntax Validation Task,cn=plugins,cn=config')

An instance of Syntax Validation Task plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.USNPlugin(instance, dn='cn=USN,cn=plugins,cn=config')

A single instance of USN (Update Sequence Number) plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

cleanup(suffix=None, backend=None, max_usn=None)

Create a USN tombstone cleanup task

Parameters

• basedn (str) – Basedn to fix up

• _filter (str) – a filter for entries to fix up

Returns

an instance of Task(DSLdapObject)

disable_global_mode()

Set nsslapd-entryusn-global to off

enable_global_mode()

Set nsslapd-entryusn-global to on

is_global_mode_set()

Return True if nsslapd-entryusn-global is set to on, else False

class lib389.plugins.ViewsPlugin(instance, dn='cn=Views,cn=plugins,cn=config')

An instance of Views plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN

class lib389.plugins.WhoamiPlugin(instance, dn='cn=whoami,cn=plugins,cn=config')

A single instance of whoami plugin entry

Parameters

• instance (lib389.DirSrv) – An instance

• dn (str) – Entry DN