4.2. List of Attributes Common to All Plug-ins

This list provides a brief attribute description, the entry DN, valid range, default value, syntax, and an example for each attribute.

4.2.1. nsslapdPlugin (Object Class)

Each Directory Server plug-in belongs to the nsslapdPlugin object class.
This object class is defined in Directory Server.
Superior Class

top

OID

2.16.840.1.113730.3.2.41

Required Attributes

Attribute
Definition
objectClass
Gives the object classes assigned to the entry.
cn
Gives the common name of the entry.
nsslapd-pluginPath Identifies the plugin library name (without the library suffix).
nsslapd-pluginInitfunc Identifies an initialization function of the plugin.
nsslapd-pluginType Identifies the type of plugin.
nsslapd-pluginId Identifies the plugin ID.
nsslapd-pluginVersion Identifies the version of plugin.
nsslapd-pluginVendor Identifies the vendor of plugin.
nsslapd-pluginDescription Identifies the description of the plugin.
nsslapd-pluginEnabled Identifies whether or not the plugin is enabled.
nsslapd-pluginPrecedence Sets the priority for the plug-in in the execution order.

4.2.2. nsslapd-logAccess

This attribute enables you to log search operations run by the plug-in to the file set in the nsslapd-accesslog parameter in cn=config.
Plug-in Parameter Description
Entry DN cn=plug-in name,cn=plugins,cn=config
Valid Values on | off
Default Value off
Syntax DirectoryString
Example nsslapd-logAccess: Off

4.2.3. nsslapd-logAudit

This attribute enables you to log and audit modifications to the database originated from the plug-in.
Successful modification events are logged in the audit log, if the nsslapd-auditlog-logging-enabled parameter is enabled in cn=config. To log failed modification database operations by a plug-in, enable the nsslapd-auditfaillog-logging-enabled attribute in cn=config.
Plug-in Parameter Description
Entry DN cn=plug-in name,cn=plugins,cn=config
Valid Values on | off
Default Value off
Syntax DirectoryString
Example nsslapd-logAudit: Off

4.2.4. nsslapd-pluginDescription

This attribute provides a description of the plug-in.
Plug-in Parameter Description
Entry DN cn=plug-in name,cn=plugins,cn=config
Valid Values
Default Value None
Syntax DirectoryString
Example nsslapd-pluginDescription: acl access check plug-in

4.2.5. nsslapd-pluginEnabled

This attribute specifies whether the plug-in is enabled. This attribute can be changed over protocol but will only take effect when the server is next restarted.
Plug-in Parameter Description
Entry DN cn=plug-in name,cn=plugins,cn=config
Valid Values on | off
Default Value on
Syntax DirectoryString
Example nsslapd-pluginEnabled: on

4.2.6. nsslapd-pluginId

This attribute specifies the plug-in ID.
Plug-in Parameter Description
Entry DN cn=plug-in name,cn=plugins,cn=config
Valid Values Any valid plug-in ID
Default Value None
Syntax DirectoryString
Example nsslapd-pluginId: chaining database

4.2.7. nsslapd-pluginInitfunc

This attribute specifies the plug-in function to be initiated.
Plug-in Parameter Description
Entry DN cn=plug-in name,cn=plugins,cn=config
Valid Values Any valid plug-in function
Default Value None
Syntax DirectoryString
Example nsslapd-pluginInitfunc: NS7bitAttr_Init

4.2.8. nsslapd-pluginPath

This attribute specifies the full path to the plug-in.
Plug-in Parameter Description
Entry DN cn=plug-in name,cn=plugins,cn=config
Valid Values Any valid path
Default Value None
Syntax DirectoryString
Example nsslapd-pluginPath: uid-plugin

4.2.9. nsslapd-pluginPrecedence

This attribute sets the precedence or priority for the execution order of a plug-in. Precedence defines the execution order of plug-ins, which allows more complex environments or interactions since it can enable a plug-in to wait for a completed operation before being executed. This is more important for pre-operation and post-operation plug-ins.
Plug-ins with a value of 1 have the highest priority and are run first; plug-ins with a value of 99 have the lowest priority. The default is 50.
Plug-in Parameter Description
Entry DN cn=plug-in name,cn=plugins,cn=config
Valid Values 1 to 99
Default Value 50
Syntax Integer
Example nsslapd-pluginPrecedence: 3

4.2.10. nsslapd-pluginType

This attribute specifies the plug-in type. See Section 4.3.5, “nsslapd-plugin-depends-on-type” for further information.
Plug-in Parameter Description
Entry DN cn=plug-in name,cn=plugins,cn=config
Valid Values Any valid plug-in type
Default Value None
Syntax DirectoryString
Example nsslapd-pluginType: preoperation

4.2.11. nsslapd-pluginVendor

This attribute specifies the vendor of the plug-in.
Plug-in Parameter Description
Entry DN cn=plug-in name,cn=plugins,cn=config
Valid Values Any approved plug-in vendor
Default Value Red Hat, Inc.
Syntax DirectoryString
Example nsslapd-pluginVendor: Red Hat, Inc.

4.2.12. nsslapd-pluginVersion

This attribute specifies the plug-in version.
Plug-in Parameter Description
Entry DN cn=plug-in name,cn=plugins,cn=config
Valid Values Any valid plug-in version
Default Value Product version number
Syntax DirectoryString
Example nsslapd-pluginVersion: 10.4