dsconfig get-plugin-prop — Shows Plugin properties
dsconfig get-plugin-prop
{options}
The dsconfig get-plugin-prop command takes the following options:
--plugin-name {name}
The name of the Plugin.
Plugin properties depend on the Plugin type, which depends on the {name} you provide.
By default, OpenDJ directory server supports the following Plugin types:
Default {name}: Attribute Cleanup Plugin
Enabled by default: true
See the section called “Attribute Cleanup Plugin” for the properties of this Plugin type.
Default {name}: Change Number Control Plugin
Enabled by default: true
See the section called “Change Number Control Plugin” for the properties of this Plugin type.
Default {name}: Entry UUID Plugin
Enabled by default: true
See the section called “Entry UUID Plugin” for the properties of this Plugin type.
Default {name}: Fractional LDIF Import Plugin
Enabled by default: true
See the section called “Fractional LDIF Import Plugin” for the properties of this Plugin type.
Default {name}: Last Mod Plugin
Enabled by default: true
See the section called “Last Mod Plugin” for the properties of this Plugin type.
Default {name}: LDAP Attribute Description List Plugin
Enabled by default: true
See the section called “LDAP Attribute Description List Plugin” for the properties of this Plugin type.
Default {name}: Password Policy Import Plugin
Enabled by default: true
See the section called “Password Policy Import Plugin” for the properties of this Plugin type.
Default {name}: Profiler Plugin
Enabled by default: true
See the section called “Profiler Plugin” for the properties of this Plugin type.
Default {name}: Referential Integrity Plugin
Enabled by default: true
See the section called “Referential Integrity Plugin” for the properties of this Plugin type.
Default {name}: Samba Password Plugin
Enabled by default: true
See the section called “Samba Password Plugin” for the properties of this Plugin type.
Default {name}: Seven Bit Clean Plugin
Enabled by default: true
See the section called “Seven Bit Clean Plugin” for the properties of this Plugin type.
Default {name}: Unique Attribute Plugin
Enabled by default: true
See the section called “Unique Attribute Plugin” for the properties of this Plugin type.
--property {property}
The name of a property to be displayed.
Plugin properties depend on the Plugin type, which depends on the {property} you provide.
By default, OpenDJ directory server supports the following Plugin types:
Default {property}: Attribute Cleanup Plugin
Enabled by default: true
See the section called “Attribute Cleanup Plugin” for the properties of this Plugin type.
Default {property}: Change Number Control Plugin
Enabled by default: true
See the section called “Change Number Control Plugin” for the properties of this Plugin type.
Default {property}: Entry UUID Plugin
Enabled by default: true
See the section called “Entry UUID Plugin” for the properties of this Plugin type.
Default {property}: Fractional LDIF Import Plugin
Enabled by default: true
See the section called “Fractional LDIF Import Plugin” for the properties of this Plugin type.
Default {property}: Last Mod Plugin
Enabled by default: true
See the section called “Last Mod Plugin” for the properties of this Plugin type.
Default {property}: LDAP Attribute Description List Plugin
Enabled by default: true
See the section called “LDAP Attribute Description List Plugin” for the properties of this Plugin type.
Default {property}: Password Policy Import Plugin
Enabled by default: true
See the section called “Password Policy Import Plugin” for the properties of this Plugin type.
Default {property}: Profiler Plugin
Enabled by default: true
See the section called “Profiler Plugin” for the properties of this Plugin type.
Default {property}: Referential Integrity Plugin
Enabled by default: true
See the section called “Referential Integrity Plugin” for the properties of this Plugin type.
Default {property}: Samba Password Plugin
Enabled by default: true
See the section called “Samba Password Plugin” for the properties of this Plugin type.
Default {property}: Seven Bit Clean Plugin
Enabled by default: true
See the section called “Seven Bit Clean Plugin” for the properties of this Plugin type.
Default {property}: Unique Attribute Plugin
Enabled by default: true
See the section called “Unique Attribute Plugin” for the properties of this Plugin type.
-E | --record
Modifies the display output to show one property value per line.
Plugin properties depend on the Plugin type, which depends on the null you provide.
By default, OpenDJ directory server supports the following Plugin types:
Default null: Attribute Cleanup Plugin
Enabled by default: true
See the section called “Attribute Cleanup Plugin” for the properties of this Plugin type.
Default null: Change Number Control Plugin
Enabled by default: true
See the section called “Change Number Control Plugin” for the properties of this Plugin type.
Default null: Entry UUID Plugin
Enabled by default: true
See the section called “Entry UUID Plugin” for the properties of this Plugin type.
Default null: Fractional LDIF Import Plugin
Enabled by default: true
See the section called “Fractional LDIF Import Plugin” for the properties of this Plugin type.
Default null: Last Mod Plugin
Enabled by default: true
See the section called “Last Mod Plugin” for the properties of this Plugin type.
Default null: LDAP Attribute Description List Plugin
Enabled by default: true
See the section called “LDAP Attribute Description List Plugin” for the properties of this Plugin type.
Default null: Password Policy Import Plugin
Enabled by default: true
See the section called “Password Policy Import Plugin” for the properties of this Plugin type.
Default null: Profiler Plugin
Enabled by default: true
See the section called “Profiler Plugin” for the properties of this Plugin type.
Default null: Referential Integrity Plugin
Enabled by default: true
See the section called “Referential Integrity Plugin” for the properties of this Plugin type.
Default null: Samba Password Plugin
Enabled by default: true
See the section called “Samba Password Plugin” for the properties of this Plugin type.
Default null: Seven Bit Clean Plugin
Enabled by default: true
See the section called “Seven Bit Clean Plugin” for the properties of this Plugin type.
Default null: Unique Attribute Plugin
Enabled by default: true
See the section called “Unique Attribute Plugin” for the properties of this Plugin type.
-z | --unit-size {unit}
Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
Plugin properties depend on the Plugin type, which depends on the {unit} you provide.
By default, OpenDJ directory server supports the following Plugin types:
Default {unit}: Attribute Cleanup Plugin
Enabled by default: true
See the section called “Attribute Cleanup Plugin” for the properties of this Plugin type.
Default {unit}: Change Number Control Plugin
Enabled by default: true
See the section called “Change Number Control Plugin” for the properties of this Plugin type.
Default {unit}: Entry UUID Plugin
Enabled by default: true
See the section called “Entry UUID Plugin” for the properties of this Plugin type.
Default {unit}: Fractional LDIF Import Plugin
Enabled by default: true
See the section called “Fractional LDIF Import Plugin” for the properties of this Plugin type.
Default {unit}: Last Mod Plugin
Enabled by default: true
See the section called “Last Mod Plugin” for the properties of this Plugin type.
Default {unit}: LDAP Attribute Description List Plugin
Enabled by default: true
See the section called “LDAP Attribute Description List Plugin” for the properties of this Plugin type.
Default {unit}: Password Policy Import Plugin
Enabled by default: true
See the section called “Password Policy Import Plugin” for the properties of this Plugin type.
Default {unit}: Profiler Plugin
Enabled by default: true
See the section called “Profiler Plugin” for the properties of this Plugin type.
Default {unit}: Referential Integrity Plugin
Enabled by default: true
See the section called “Referential Integrity Plugin” for the properties of this Plugin type.
Default {unit}: Samba Password Plugin
Enabled by default: true
See the section called “Samba Password Plugin” for the properties of this Plugin type.
Default {unit}: Seven Bit Clean Plugin
Enabled by default: true
See the section called “Seven Bit Clean Plugin” for the properties of this Plugin type.
Default {unit}: Unique Attribute Plugin
Enabled by default: true
See the section called “Unique Attribute Plugin” for the properties of this Plugin type.
-m | --unit-time {unit}
Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Plugin properties depend on the Plugin type, which depends on the {unit} you provide.
By default, OpenDJ directory server supports the following Plugin types:
Default {unit}: Attribute Cleanup Plugin
Enabled by default: true
See the section called “Attribute Cleanup Plugin” for the properties of this Plugin type.
Default {unit}: Change Number Control Plugin
Enabled by default: true
See the section called “Change Number Control Plugin” for the properties of this Plugin type.
Default {unit}: Entry UUID Plugin
Enabled by default: true
See the section called “Entry UUID Plugin” for the properties of this Plugin type.
Default {unit}: Fractional LDIF Import Plugin
Enabled by default: true
See the section called “Fractional LDIF Import Plugin” for the properties of this Plugin type.
Default {unit}: Last Mod Plugin
Enabled by default: true
See the section called “Last Mod Plugin” for the properties of this Plugin type.
Default {unit}: LDAP Attribute Description List Plugin
Enabled by default: true
See the section called “LDAP Attribute Description List Plugin” for the properties of this Plugin type.
Default {unit}: Password Policy Import Plugin
Enabled by default: true
See the section called “Password Policy Import Plugin” for the properties of this Plugin type.
Default {unit}: Profiler Plugin
Enabled by default: true
See the section called “Profiler Plugin” for the properties of this Plugin type.
Default {unit}: Referential Integrity Plugin
Enabled by default: true
See the section called “Referential Integrity Plugin” for the properties of this Plugin type.
Default {unit}: Samba Password Plugin
Enabled by default: true
See the section called “Samba Password Plugin” for the properties of this Plugin type.
Default {unit}: Seven Bit Clean Plugin
Enabled by default: true
See the section called “Seven Bit Clean Plugin” for the properties of this Plugin type.
Default {unit}: Unique Attribute Plugin
Enabled by default: true
See the section called “Unique Attribute Plugin” for the properties of this Plugin type.
Plugins of type attribute-cleanup-plugin have the following properties:
Indicates whether the plug-in is enabled for use.
None
true
false
No
Yes
None
No
No
Indicates whether the plug-in should be invoked for internal operations. Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
false
true
false
No
No
None
Yes (Use --advanced in interactive mode.)
No
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
org.opends.server.plugins.AttributeCleanupPlugin
A Java class that implements or extends the class(es): org.opends.server.api.plugin.DirectoryServerPlugin
No
Yes
None
No
No
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
preparseadd
preparsemodify
Invoked before sending an intermediate repsonse message to the client.
Invoked for each operation to be written during an LDIF export.
Invoked for each entry read during an LDIF import.
Invoked at the beginning of an LDIF import session.
Invoked at the end of an LDIF import session.
Invoked whenever a new connection is established to the server.
Invoked whenever an existing connection is terminated (by either the client or the server).
Invoked after completing the abandon processing.
Invoked after completing the core add processing but before sending the response to the client.
Invoked after completing the core bind processing but before sending the response to the client.
Invoked after completing the core compare processing but before sending the response to the client.
Invoked after completing the core delete processing but before sending the response to the client.
Invoked after completing the core extended processing but before sending the response to the client.
Invoked after completing the core modify processing but before sending the response to the client.
Invoked after completing the core modify DN processing but before sending the response to the client.
Invoked after completing the core search processing but before sending the response to the client.
Invoked after completing the unbind processing.
Invoked after sending the add response to the client.
Invoked after sending the bind response to the client.
Invoked after sending the compare response to the client.
Invoked after sending the delete response to the client.
Invoked after sending the extended response to the client.
Invoked after sending the modify response to the client.
Invoked after sending the modify DN response to the client.
Invoked after sending the search result done message to the client.
Invoked after completing post-synchronization processing for an add operation.
Invoked after completing post-synchronization processing for a delete operation.
Invoked after completing post-synchronization processing for a modify operation.
Invoked after completing post-synchronization processing for a modify DN operation.
Invoked prior to performing the core add processing.
Invoked prior to performing the core bind processing.
Invoked prior to performing the core compare processing.
Invoked prior to performing the core delete processing.
Invoked prior to performing the core extended processing.
Invoked prior to performing the core modify processing.
Invoked prior to performing the core modify DN processing.
Invoked prior to performing the core search processing.
Invoked prior to parsing an abandon request.
Invoked prior to parsing an add request.
Invoked prior to parsing a bind request.
Invoked prior to parsing a compare request.
Invoked prior to parsing a delete request.
Invoked prior to parsing an extended request.
Invoked prior to parsing a modify request.
Invoked prior to parsing a modify DN request.
Invoked prior to parsing a search request.
Invoked prior to parsing an unbind request.
Invoked before sending a search result entry to the client.
Invoked before sending a search result reference to the client.
Invoked during a graceful directory server shutdown.
Invoked during the directory server startup process.
Invoked in the course of deleting a subordinate entry of a delete operation.
Invoked in the course of moving or renaming an entry subordinate to the target of a modify DN operation.
Yes
Yes
The Plugin must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
A list of attributes which should be removed from incoming add or modify requests.
No attributes will be removed
A String
Yes
No
None
No
No
A list of attributes which should be renamed in incoming add or modify requests.
No attributes will be renamed
An attribute name mapping.
Yes
No
None
No
No
Plugins of type change-number-control-plugin have the following properties:
Indicates whether the plug-in is enabled for use.
None
true
false
No
Yes
None
No
No
Indicates whether the plug-in should be invoked for internal operations. Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
true
true
false
No
No
None
Yes (Use --advanced in interactive mode.)
No
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
org.opends.server.plugins.ChangeNumberControlPlugin
A Java class that implements or extends the class(es): org.opends.server.api.plugin.DirectoryServerPlugin
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
postOperationAdd
postOperationDelete
postOperationModify
postOperationModifyDN
Invoked before sending an intermediate repsonse message to the client.
Invoked for each operation to be written during an LDIF export.
Invoked for each entry read during an LDIF import.
Invoked at the beginning of an LDIF import session.
Invoked at the end of an LDIF import session.
Invoked whenever a new connection is established to the server.
Invoked whenever an existing connection is terminated (by either the client or the server).
Invoked after completing the abandon processing.
Invoked after completing the core add processing but before sending the response to the client.
Invoked after completing the core bind processing but before sending the response to the client.
Invoked after completing the core compare processing but before sending the response to the client.
Invoked after completing the core delete processing but before sending the response to the client.
Invoked after completing the core extended processing but before sending the response to the client.
Invoked after completing the core modify processing but before sending the response to the client.
Invoked after completing the core modify DN processing but before sending the response to the client.
Invoked after completing the core search processing but before sending the response to the client.
Invoked after completing the unbind processing.
Invoked after sending the add response to the client.
Invoked after sending the bind response to the client.
Invoked after sending the compare response to the client.
Invoked after sending the delete response to the client.
Invoked after sending the extended response to the client.
Invoked after sending the modify response to the client.
Invoked after sending the modify DN response to the client.
Invoked after sending the search result done message to the client.
Invoked after completing post-synchronization processing for an add operation.
Invoked after completing post-synchronization processing for a delete operation.
Invoked after completing post-synchronization processing for a modify operation.
Invoked after completing post-synchronization processing for a modify DN operation.
Invoked prior to performing the core add processing.
Invoked prior to performing the core bind processing.
Invoked prior to performing the core compare processing.
Invoked prior to performing the core delete processing.
Invoked prior to performing the core extended processing.
Invoked prior to performing the core modify processing.
Invoked prior to performing the core modify DN processing.
Invoked prior to performing the core search processing.
Invoked prior to parsing an abandon request.
Invoked prior to parsing an add request.
Invoked prior to parsing a bind request.
Invoked prior to parsing a compare request.
Invoked prior to parsing a delete request.
Invoked prior to parsing an extended request.
Invoked prior to parsing a modify request.
Invoked prior to parsing a modify DN request.
Invoked prior to parsing a search request.
Invoked prior to parsing an unbind request.
Invoked before sending a search result entry to the client.
Invoked before sending a search result reference to the client.
Invoked during a graceful directory server shutdown.
Invoked during the directory server startup process.
Invoked in the course of deleting a subordinate entry of a delete operation.
Invoked in the course of moving or renaming an entry subordinate to the target of a modify DN operation.
Yes
Yes
The Plugin must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Plugins of type entry-uuid-plugin have the following properties:
Indicates whether the plug-in is enabled for use.
None
true
false
No
Yes
None
No
No
Indicates whether the plug-in should be invoked for internal operations. Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
true
true
false
No
No
None
Yes (Use --advanced in interactive mode.)
No
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
org.opends.server.plugins.EntryUUIDPlugin
A Java class that implements or extends the class(es): org.opends.server.api.plugin.DirectoryServerPlugin
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
ldifimport
preoperationadd
Invoked before sending an intermediate repsonse message to the client.
Invoked for each operation to be written during an LDIF export.
Invoked for each entry read during an LDIF import.
Invoked at the beginning of an LDIF import session.
Invoked at the end of an LDIF import session.
Invoked whenever a new connection is established to the server.
Invoked whenever an existing connection is terminated (by either the client or the server).
Invoked after completing the abandon processing.
Invoked after completing the core add processing but before sending the response to the client.
Invoked after completing the core bind processing but before sending the response to the client.
Invoked after completing the core compare processing but before sending the response to the client.
Invoked after completing the core delete processing but before sending the response to the client.
Invoked after completing the core extended processing but before sending the response to the client.
Invoked after completing the core modify processing but before sending the response to the client.
Invoked after completing the core modify DN processing but before sending the response to the client.
Invoked after completing the core search processing but before sending the response to the client.
Invoked after completing the unbind processing.
Invoked after sending the add response to the client.
Invoked after sending the bind response to the client.
Invoked after sending the compare response to the client.
Invoked after sending the delete response to the client.
Invoked after sending the extended response to the client.
Invoked after sending the modify response to the client.
Invoked after sending the modify DN response to the client.
Invoked after sending the search result done message to the client.
Invoked after completing post-synchronization processing for an add operation.
Invoked after completing post-synchronization processing for a delete operation.
Invoked after completing post-synchronization processing for a modify operation.
Invoked after completing post-synchronization processing for a modify DN operation.
Invoked prior to performing the core add processing.
Invoked prior to performing the core bind processing.
Invoked prior to performing the core compare processing.
Invoked prior to performing the core delete processing.
Invoked prior to performing the core extended processing.
Invoked prior to performing the core modify processing.
Invoked prior to performing the core modify DN processing.
Invoked prior to performing the core search processing.
Invoked prior to parsing an abandon request.
Invoked prior to parsing an add request.
Invoked prior to parsing a bind request.
Invoked prior to parsing a compare request.
Invoked prior to parsing a delete request.
Invoked prior to parsing an extended request.
Invoked prior to parsing a modify request.
Invoked prior to parsing a modify DN request.
Invoked prior to parsing a search request.
Invoked prior to parsing an unbind request.
Invoked before sending a search result entry to the client.
Invoked before sending a search result reference to the client.
Invoked during a graceful directory server shutdown.
Invoked during the directory server startup process.
Invoked in the course of deleting a subordinate entry of a delete operation.
Invoked in the course of moving or renaming an entry subordinate to the target of a modify DN operation.
Yes
Yes
The Plugin must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Plugins of type fractional-ldif-import-plugin have the following properties:
Indicates whether the plug-in is enabled for use.
None
true
false
No
Yes
None
No
No
Indicates whether the plug-in should be invoked for internal operations. Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
true
true
false
No
No
None
Yes (Use --advanced in interactive mode.)
No
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
None
A Java class that implements or extends the class(es): org.opends.server.api.plugin.DirectoryServerPlugin
No
Yes
None
No
No
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
None
Invoked before sending an intermediate repsonse message to the client.
Invoked for each operation to be written during an LDIF export.
Invoked for each entry read during an LDIF import.
Invoked at the beginning of an LDIF import session.
Invoked at the end of an LDIF import session.
Invoked whenever a new connection is established to the server.
Invoked whenever an existing connection is terminated (by either the client or the server).
Invoked after completing the abandon processing.
Invoked after completing the core add processing but before sending the response to the client.
Invoked after completing the core bind processing but before sending the response to the client.
Invoked after completing the core compare processing but before sending the response to the client.
Invoked after completing the core delete processing but before sending the response to the client.
Invoked after completing the core extended processing but before sending the response to the client.
Invoked after completing the core modify processing but before sending the response to the client.
Invoked after completing the core modify DN processing but before sending the response to the client.
Invoked after completing the core search processing but before sending the response to the client.
Invoked after completing the unbind processing.
Invoked after sending the add response to the client.
Invoked after sending the bind response to the client.
Invoked after sending the compare response to the client.
Invoked after sending the delete response to the client.
Invoked after sending the extended response to the client.
Invoked after sending the modify response to the client.
Invoked after sending the modify DN response to the client.
Invoked after sending the search result done message to the client.
Invoked after completing post-synchronization processing for an add operation.
Invoked after completing post-synchronization processing for a delete operation.
Invoked after completing post-synchronization processing for a modify operation.
Invoked after completing post-synchronization processing for a modify DN operation.
Invoked prior to performing the core add processing.
Invoked prior to performing the core bind processing.
Invoked prior to performing the core compare processing.
Invoked prior to performing the core delete processing.
Invoked prior to performing the core extended processing.
Invoked prior to performing the core modify processing.
Invoked prior to performing the core modify DN processing.
Invoked prior to performing the core search processing.
Invoked prior to parsing an abandon request.
Invoked prior to parsing an add request.
Invoked prior to parsing a bind request.
Invoked prior to parsing a compare request.
Invoked prior to parsing a delete request.
Invoked prior to parsing an extended request.
Invoked prior to parsing a modify request.
Invoked prior to parsing a modify DN request.
Invoked prior to parsing a search request.
Invoked prior to parsing an unbind request.
Invoked before sending a search result entry to the client.
Invoked before sending a search result reference to the client.
Invoked during a graceful directory server shutdown.
Invoked during the directory server startup process.
Invoked in the course of deleting a subordinate entry of a delete operation.
Invoked in the course of moving or renaming an entry subordinate to the target of a modify DN operation.
Yes
Yes
The Plugin must be disabled and re-enabled for changes to this setting to take effect
No
No
Plugins of type last-mod-plugin have the following properties:
Indicates whether the plug-in is enabled for use.
None
true
false
No
Yes
None
No
No
Indicates whether the plug-in should be invoked for internal operations. Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
true
true
false
No
No
None
Yes (Use --advanced in interactive mode.)
No
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
org.opends.server.plugins.LastModPlugin
A Java class that implements or extends the class(es): org.opends.server.api.plugin.DirectoryServerPlugin
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
preoperationadd
preoperationmodify
preoperationmodifydn
Invoked before sending an intermediate repsonse message to the client.
Invoked for each operation to be written during an LDIF export.
Invoked for each entry read during an LDIF import.
Invoked at the beginning of an LDIF import session.
Invoked at the end of an LDIF import session.
Invoked whenever a new connection is established to the server.
Invoked whenever an existing connection is terminated (by either the client or the server).
Invoked after completing the abandon processing.
Invoked after completing the core add processing but before sending the response to the client.
Invoked after completing the core bind processing but before sending the response to the client.
Invoked after completing the core compare processing but before sending the response to the client.
Invoked after completing the core delete processing but before sending the response to the client.
Invoked after completing the core extended processing but before sending the response to the client.
Invoked after completing the core modify processing but before sending the response to the client.
Invoked after completing the core modify DN processing but before sending the response to the client.
Invoked after completing the core search processing but before sending the response to the client.
Invoked after completing the unbind processing.
Invoked after sending the add response to the client.
Invoked after sending the bind response to the client.
Invoked after sending the compare response to the client.
Invoked after sending the delete response to the client.
Invoked after sending the extended response to the client.
Invoked after sending the modify response to the client.
Invoked after sending the modify DN response to the client.
Invoked after sending the search result done message to the client.
Invoked after completing post-synchronization processing for an add operation.
Invoked after completing post-synchronization processing for a delete operation.
Invoked after completing post-synchronization processing for a modify operation.
Invoked after completing post-synchronization processing for a modify DN operation.
Invoked prior to performing the core add processing.
Invoked prior to performing the core bind processing.
Invoked prior to performing the core compare processing.
Invoked prior to performing the core delete processing.
Invoked prior to performing the core extended processing.
Invoked prior to performing the core modify processing.
Invoked prior to performing the core modify DN processing.
Invoked prior to performing the core search processing.
Invoked prior to parsing an abandon request.
Invoked prior to parsing an add request.
Invoked prior to parsing a bind request.
Invoked prior to parsing a compare request.
Invoked prior to parsing a delete request.
Invoked prior to parsing an extended request.
Invoked prior to parsing a modify request.
Invoked prior to parsing a modify DN request.
Invoked prior to parsing a search request.
Invoked prior to parsing an unbind request.
Invoked before sending a search result entry to the client.
Invoked before sending a search result reference to the client.
Invoked during a graceful directory server shutdown.
Invoked during the directory server startup process.
Invoked in the course of deleting a subordinate entry of a delete operation.
Invoked in the course of moving or renaming an entry subordinate to the target of a modify DN operation.
Yes
Yes
The Plugin must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Plugins of type ldap-attribute-description-list-plugin have the following properties:
Indicates whether the plug-in is enabled for use.
None
true
false
No
Yes
None
No
No
Indicates whether the plug-in should be invoked for internal operations. Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
true
true
false
No
No
None
Yes (Use --advanced in interactive mode.)
No
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
org.opends.server.plugins.LDAPADListPlugin
A Java class that implements or extends the class(es): org.opends.server.api.plugin.DirectoryServerPlugin
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
preparsesearch
Invoked before sending an intermediate repsonse message to the client.
Invoked for each operation to be written during an LDIF export.
Invoked for each entry read during an LDIF import.
Invoked at the beginning of an LDIF import session.
Invoked at the end of an LDIF import session.
Invoked whenever a new connection is established to the server.
Invoked whenever an existing connection is terminated (by either the client or the server).
Invoked after completing the abandon processing.
Invoked after completing the core add processing but before sending the response to the client.
Invoked after completing the core bind processing but before sending the response to the client.
Invoked after completing the core compare processing but before sending the response to the client.
Invoked after completing the core delete processing but before sending the response to the client.
Invoked after completing the core extended processing but before sending the response to the client.
Invoked after completing the core modify processing but before sending the response to the client.
Invoked after completing the core modify DN processing but before sending the response to the client.
Invoked after completing the core search processing but before sending the response to the client.
Invoked after completing the unbind processing.
Invoked after sending the add response to the client.
Invoked after sending the bind response to the client.
Invoked after sending the compare response to the client.
Invoked after sending the delete response to the client.
Invoked after sending the extended response to the client.
Invoked after sending the modify response to the client.
Invoked after sending the modify DN response to the client.
Invoked after sending the search result done message to the client.
Invoked after completing post-synchronization processing for an add operation.
Invoked after completing post-synchronization processing for a delete operation.
Invoked after completing post-synchronization processing for a modify operation.
Invoked after completing post-synchronization processing for a modify DN operation.
Invoked prior to performing the core add processing.
Invoked prior to performing the core bind processing.
Invoked prior to performing the core compare processing.
Invoked prior to performing the core delete processing.
Invoked prior to performing the core extended processing.
Invoked prior to performing the core modify processing.
Invoked prior to performing the core modify DN processing.
Invoked prior to performing the core search processing.
Invoked prior to parsing an abandon request.
Invoked prior to parsing an add request.
Invoked prior to parsing a bind request.
Invoked prior to parsing a compare request.
Invoked prior to parsing a delete request.
Invoked prior to parsing an extended request.
Invoked prior to parsing a modify request.
Invoked prior to parsing a modify DN request.
Invoked prior to parsing a search request.
Invoked prior to parsing an unbind request.
Invoked before sending a search result entry to the client.
Invoked before sending a search result reference to the client.
Invoked during a graceful directory server shutdown.
Invoked during the directory server startup process.
Invoked in the course of deleting a subordinate entry of a delete operation.
Invoked in the course of moving or renaming an entry subordinate to the target of a modify DN operation.
Yes
Yes
The Plugin must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Plugins of type password-policy-import-plugin have the following properties:
Specifies the names of password storage schemes that to be used for encoding passwords contained in attributes with the auth password syntax for entries that do not include the ds-pwp-password-policy-dn attribute specifying which password policy should be used to govern them.
If the default password policy uses an attribute with the auth password syntax, then the server uses the default password storage schemes for that password policy. Otherwise, it encodes auth password values using the "SHA1" scheme.
The DN of any Password Storage Scheme. The referenced password storage schemes must be enabled when the Password Policy Import plug-in is enabled.
Yes
No
None
No
No
Specifies the names of the password storage schemes to be used for encoding passwords contained in attributes with the user password syntax for entries that do not include the ds-pwp-password-policy-dn attribute specifying which password policy is to be used to govern them.
If the default password policy uses the attribute with the user password syntax, then the server uses the default password storage schemes for that password policy. Otherwise, it encodes user password values using the "SSHA" scheme.
The DN of any Password Storage Scheme. The referenced password storage schemes must be enabled when the Password Policy Import Plugin is enabled.
Yes
No
None
No
No
Indicates whether the plug-in is enabled for use.
None
true
false
No
Yes
None
No
No
Indicates whether the plug-in should be invoked for internal operations. Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
false
true
false
No
No
None
Yes (Use --advanced in interactive mode.)
No
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
org.opends.server.plugins.PasswordPolicyImportPlugin
A Java class that implements or extends the class(es): org.opends.server.api.plugin.DirectoryServerPlugin
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
ldifimport
Invoked before sending an intermediate repsonse message to the client.
Invoked for each operation to be written during an LDIF export.
Invoked for each entry read during an LDIF import.
Invoked at the beginning of an LDIF import session.
Invoked at the end of an LDIF import session.
Invoked whenever a new connection is established to the server.
Invoked whenever an existing connection is terminated (by either the client or the server).
Invoked after completing the abandon processing.
Invoked after completing the core add processing but before sending the response to the client.
Invoked after completing the core bind processing but before sending the response to the client.
Invoked after completing the core compare processing but before sending the response to the client.
Invoked after completing the core delete processing but before sending the response to the client.
Invoked after completing the core extended processing but before sending the response to the client.
Invoked after completing the core modify processing but before sending the response to the client.
Invoked after completing the core modify DN processing but before sending the response to the client.
Invoked after completing the core search processing but before sending the response to the client.
Invoked after completing the unbind processing.
Invoked after sending the add response to the client.
Invoked after sending the bind response to the client.
Invoked after sending the compare response to the client.
Invoked after sending the delete response to the client.
Invoked after sending the extended response to the client.
Invoked after sending the modify response to the client.
Invoked after sending the modify DN response to the client.
Invoked after sending the search result done message to the client.
Invoked after completing post-synchronization processing for an add operation.
Invoked after completing post-synchronization processing for a delete operation.
Invoked after completing post-synchronization processing for a modify operation.
Invoked after completing post-synchronization processing for a modify DN operation.
Invoked prior to performing the core add processing.
Invoked prior to performing the core bind processing.
Invoked prior to performing the core compare processing.
Invoked prior to performing the core delete processing.
Invoked prior to performing the core extended processing.
Invoked prior to performing the core modify processing.
Invoked prior to performing the core modify DN processing.
Invoked prior to performing the core search processing.
Invoked prior to parsing an abandon request.
Invoked prior to parsing an add request.
Invoked prior to parsing a bind request.
Invoked prior to parsing a compare request.
Invoked prior to parsing a delete request.
Invoked prior to parsing an extended request.
Invoked prior to parsing a modify request.
Invoked prior to parsing a modify DN request.
Invoked prior to parsing a search request.
Invoked prior to parsing an unbind request.
Invoked before sending a search result entry to the client.
Invoked before sending a search result reference to the client.
Invoked during a graceful directory server shutdown.
Invoked during the directory server startup process.
Invoked in the course of deleting a subordinate entry of a delete operation.
Invoked in the course of moving or renaming an entry subordinate to the target of a modify DN operation.
Yes
Yes
The Plugin must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Plugins of type profiler-plugin have the following properties:
Indicates whether the profiler plug-in is to start collecting data automatically when the directory server is started. This property is read only when the server is started, and any changes take effect on the next restart. This property is typically set to "false" unless startup profiling is required, because otherwise the volume of data that can be collected can cause the server to run out of memory if it is not turned off in a timely manner.
None
true
false
No
Yes
None
No
No
Indicates whether the plug-in is enabled for use.
None
true
false
No
Yes
None
No
No
Indicates whether the plug-in should be invoked for internal operations. Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
false
true
false
No
No
None
Yes (Use --advanced in interactive mode.)
No
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
org.opends.server.plugins.profiler.ProfilerPlugin
A Java class that implements or extends the class(es): org.opends.server.api.plugin.DirectoryServerPlugin
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
startup
Invoked before sending an intermediate repsonse message to the client.
Invoked for each operation to be written during an LDIF export.
Invoked for each entry read during an LDIF import.
Invoked at the beginning of an LDIF import session.
Invoked at the end of an LDIF import session.
Invoked whenever a new connection is established to the server.
Invoked whenever an existing connection is terminated (by either the client or the server).
Invoked after completing the abandon processing.
Invoked after completing the core add processing but before sending the response to the client.
Invoked after completing the core bind processing but before sending the response to the client.
Invoked after completing the core compare processing but before sending the response to the client.
Invoked after completing the core delete processing but before sending the response to the client.
Invoked after completing the core extended processing but before sending the response to the client.
Invoked after completing the core modify processing but before sending the response to the client.
Invoked after completing the core modify DN processing but before sending the response to the client.
Invoked after completing the core search processing but before sending the response to the client.
Invoked after completing the unbind processing.
Invoked after sending the add response to the client.
Invoked after sending the bind response to the client.
Invoked after sending the compare response to the client.
Invoked after sending the delete response to the client.
Invoked after sending the extended response to the client.
Invoked after sending the modify response to the client.
Invoked after sending the modify DN response to the client.
Invoked after sending the search result done message to the client.
Invoked after completing post-synchronization processing for an add operation.
Invoked after completing post-synchronization processing for a delete operation.
Invoked after completing post-synchronization processing for a modify operation.
Invoked after completing post-synchronization processing for a modify DN operation.
Invoked prior to performing the core add processing.
Invoked prior to performing the core bind processing.
Invoked prior to performing the core compare processing.
Invoked prior to performing the core delete processing.
Invoked prior to performing the core extended processing.
Invoked prior to performing the core modify processing.
Invoked prior to performing the core modify DN processing.
Invoked prior to performing the core search processing.
Invoked prior to parsing an abandon request.
Invoked prior to parsing an add request.
Invoked prior to parsing a bind request.
Invoked prior to parsing a compare request.
Invoked prior to parsing a delete request.
Invoked prior to parsing an extended request.
Invoked prior to parsing a modify request.
Invoked prior to parsing a modify DN request.
Invoked prior to parsing a search request.
Invoked prior to parsing an unbind request.
Invoked before sending a search result entry to the client.
Invoked before sending a search result reference to the client.
Invoked during a graceful directory server shutdown.
Invoked during the directory server startup process.
Invoked in the course of deleting a subordinate entry of a delete operation.
Invoked in the course of moving or renaming an entry subordinate to the target of a modify DN operation.
Yes
Yes
The Plugin must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Specifies the action that should be taken by the profiler. A value of "start" causes the profiler thread to start collecting data if it is not already active. A value of "stop" causes the profiler thread to stop collecting data and write it to disk, and a value of "cancel" causes the profiler thread to stop collecting data and discard anything that has been captured. These operations occur immediately.
none
Stop collecting profile data and discard what has been captured.
Do not take any action.
Start collecting profile data.
Stop collecting profile data and write what has been captured to a file in the profile directory.
No
No
None
No
No
Specifies the path to the directory where profile information is to be written. This path may be either an absolute path or a path that is relative to the root of the OpenDJ directory server instance. The directory must exist and the directory server must have permission to create new files in it.
None
The path to any directory that exists on the filesystem and that can be read and written by the server user.
No
Yes
None
No
No
Specifies the sample interval in milliseconds to be used when capturing profiling information in the server. When capturing data, the profiler thread sleeps for this length of time between calls to obtain traces for all threads running in the JVM.
None
Some property values take a time duration.
Durations are expressed as numbers followed by units.
For example 1 s
means one second,
and 2 w
means two weeks.
Some durations have minimum granularity or maximum units,
so you cannot necessary specify every duration
in milliseconds or weeks for example.
Some durations allow you to use a special value to mean unlimited.
Units are specified as follows.
ms
: milliseconds
s
: seconds
m
: minutes
h
: hours
d
: days
w
: weeks
Lower limit is 1 milliseconds.Upper limit is 2147483647 milliseconds.
No
Yes
None
Changes to this configuration attribute take effect the next time the profiler is started.
No
No
Plugins of type referential-integrity-plugin have the following properties:
Specifies the attribute types for which referential integrity is to be maintained. At least one attribute type must be specified, and the syntax of any attributes must be either a distinguished name (1.3.6.1.4.1.1466.115.121.1.12) or name and optional UID (1.3.6.1.4.1.1466.115.121.1.34).
None
The name of an attribute type defined in the server schema.
Yes
Yes
None
No
No
Specifies the base DN that limits the scope within which referential integrity is maintained.
Referential integrity is maintained in all public naming contexts.
A valid DN.
Yes
No
None
No
No
Specifies whether reference attributes must refer to existing entries. When this property is set to true, this plugin will ensure that any new references added as part of an add or modify operation point to existing entries, and that the referenced entries match the filter criteria for the referencing attribute, if specified.
false
true
false
No
No
None
No
No
Specifies additional filter criteria which will be enforced when checking references. If a reference attribute has filter criteria defined then this plugin will ensure that any new references added as part of an add or modify operation refer to an existing entry which matches the specified filter.
None
An attribute-filter mapping.
Yes
No
None
No
No
Specifies whether referenced entries must reside within the same naming context as the entry containing the reference. The reference scope will only be enforced when reference checking is enabled.
global
References may refer to existing entries located anywhere in the Directory.
References must refer to existing entries located within the same naming context.
No
No
None
No
No
Indicates whether the plug-in is enabled for use.
None
true
false
No
Yes
None
No
No
Indicates whether the plug-in should be invoked for internal operations. Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
true
true
false
No
No
None
Yes (Use --advanced in interactive mode.)
No
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
org.opends.server.plugins.ReferentialIntegrityPlugin
A Java class that implements or extends the class(es): org.opends.server.api.plugin.DirectoryServerPlugin
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
Specifies the log file location where the update records are written when the plug-in is in background-mode processing. The default location is the logs directory of the server instance, using the file name "referint".
logs/referint
A path to an existing file that is readable by the server.
No
No
None
No
No
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
postoperationdelete
postoperationmodifydn
subordinatemodifydn
subordinatedelete
preoperationadd
preoperationmodify
Invoked before sending an intermediate repsonse message to the client.
Invoked for each operation to be written during an LDIF export.
Invoked for each entry read during an LDIF import.
Invoked at the beginning of an LDIF import session.
Invoked at the end of an LDIF import session.
Invoked whenever a new connection is established to the server.
Invoked whenever an existing connection is terminated (by either the client or the server).
Invoked after completing the abandon processing.
Invoked after completing the core add processing but before sending the response to the client.
Invoked after completing the core bind processing but before sending the response to the client.
Invoked after completing the core compare processing but before sending the response to the client.
Invoked after completing the core delete processing but before sending the response to the client.
Invoked after completing the core extended processing but before sending the response to the client.
Invoked after completing the core modify processing but before sending the response to the client.
Invoked after completing the core modify DN processing but before sending the response to the client.
Invoked after completing the core search processing but before sending the response to the client.
Invoked after completing the unbind processing.
Invoked after sending the add response to the client.
Invoked after sending the bind response to the client.
Invoked after sending the compare response to the client.
Invoked after sending the delete response to the client.
Invoked after sending the extended response to the client.
Invoked after sending the modify response to the client.
Invoked after sending the modify DN response to the client.
Invoked after sending the search result done message to the client.
Invoked after completing post-synchronization processing for an add operation.
Invoked after completing post-synchronization processing for a delete operation.
Invoked after completing post-synchronization processing for a modify operation.
Invoked after completing post-synchronization processing for a modify DN operation.
Invoked prior to performing the core add processing.
Invoked prior to performing the core bind processing.
Invoked prior to performing the core compare processing.
Invoked prior to performing the core delete processing.
Invoked prior to performing the core extended processing.
Invoked prior to performing the core modify processing.
Invoked prior to performing the core modify DN processing.
Invoked prior to performing the core search processing.
Invoked prior to parsing an abandon request.
Invoked prior to parsing an add request.
Invoked prior to parsing a bind request.
Invoked prior to parsing a compare request.
Invoked prior to parsing a delete request.
Invoked prior to parsing an extended request.
Invoked prior to parsing a modify request.
Invoked prior to parsing a modify DN request.
Invoked prior to parsing a search request.
Invoked prior to parsing an unbind request.
Invoked before sending a search result entry to the client.
Invoked before sending a search result reference to the client.
Invoked during a graceful directory server shutdown.
Invoked during the directory server startup process.
Invoked in the course of deleting a subordinate entry of a delete operation.
Invoked in the course of moving or renaming an entry subordinate to the target of a modify DN operation.
Yes
Yes
The Plugin must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Specifies the interval in seconds when referential integrity updates are made. If this value is 0, then the updates are made synchronously in the foreground.
0 seconds
Some property values take a time duration.
Durations are expressed as numbers followed by units.
For example 1 s
means one second,
and 2 w
means two weeks.
Some durations have minimum granularity or maximum units,
so you cannot necessary specify every duration
in milliseconds or weeks for example.
Some durations allow you to use a special value to mean unlimited.
Units are specified as follows.
ms
: milliseconds
s
: seconds
m
: minutes
h
: hours
d
: days
w
: weeks
Lower limit is 0 seconds.
No
No
None
No
No
Plugins of type samba-password-plugin have the following properties:
Indicates whether the plug-in is enabled for use.
None
true
false
No
Yes
None
No
No
Indicates whether the plug-in should be invoked for internal operations. Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
true
true
false
No
No
None
Yes (Use --advanced in interactive mode.)
No
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
org.opends.server.plugins.SambaPasswordPlugin
A Java class that implements or extends the class(es): org.opends.server.api.plugin.DirectoryServerPlugin
No
Yes
None
No
No
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
preoperationmodify
postoperationextended
Invoked before sending an intermediate repsonse message to the client.
Invoked for each operation to be written during an LDIF export.
Invoked for each entry read during an LDIF import.
Invoked at the beginning of an LDIF import session.
Invoked at the end of an LDIF import session.
Invoked whenever a new connection is established to the server.
Invoked whenever an existing connection is terminated (by either the client or the server).
Invoked after completing the abandon processing.
Invoked after completing the core add processing but before sending the response to the client.
Invoked after completing the core bind processing but before sending the response to the client.
Invoked after completing the core compare processing but before sending the response to the client.
Invoked after completing the core delete processing but before sending the response to the client.
Invoked after completing the core extended processing but before sending the response to the client.
Invoked after completing the core modify processing but before sending the response to the client.
Invoked after completing the core modify DN processing but before sending the response to the client.
Invoked after completing the core search processing but before sending the response to the client.
Invoked after completing the unbind processing.
Invoked after sending the add response to the client.
Invoked after sending the bind response to the client.
Invoked after sending the compare response to the client.
Invoked after sending the delete response to the client.
Invoked after sending the extended response to the client.
Invoked after sending the modify response to the client.
Invoked after sending the modify DN response to the client.
Invoked after sending the search result done message to the client.
Invoked after completing post-synchronization processing for an add operation.
Invoked after completing post-synchronization processing for a delete operation.
Invoked after completing post-synchronization processing for a modify operation.
Invoked after completing post-synchronization processing for a modify DN operation.
Invoked prior to performing the core add processing.
Invoked prior to performing the core bind processing.
Invoked prior to performing the core compare processing.
Invoked prior to performing the core delete processing.
Invoked prior to performing the core extended processing.
Invoked prior to performing the core modify processing.
Invoked prior to performing the core modify DN processing.
Invoked prior to performing the core search processing.
Invoked prior to parsing an abandon request.
Invoked prior to parsing an add request.
Invoked prior to parsing a bind request.
Invoked prior to parsing a compare request.
Invoked prior to parsing a delete request.
Invoked prior to parsing an extended request.
Invoked prior to parsing a modify request.
Invoked prior to parsing a modify DN request.
Invoked prior to parsing a search request.
Invoked prior to parsing an unbind request.
Invoked before sending a search result entry to the client.
Invoked before sending a search result reference to the client.
Invoked during a graceful directory server shutdown.
Invoked during the directory server startup process.
Invoked in the course of deleting a subordinate entry of a delete operation.
Invoked in the course of moving or renaming an entry subordinate to the target of a modify DN operation.
Yes
Yes
The Plugin must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Specifies which Samba passwords should be kept synchronized.
sync-nt-password
Synchronize the LanMan password attribute "sambaLMPassword"
Synchronize the NT password attribute "sambaNTPassword"
Yes
Yes
None
No
No
Specifies the distinguished name of the user which Samba uses to perform Password Modify extended operations against this directory server in order to synchronize the userPassword attribute after the LanMan or NT passwords have been updated. The user must have the 'password-reset' privilege and should not be a root user. This user name can be used in order to identify Samba connections and avoid double re-synchronization of the same password. If this property is left undefined, then no password updates will be skipped.
Synchronize all updates to user passwords
A valid DN.
No
No
None
No
No
Plugins of type seven-bit-clean-plugin have the following properties:
Specifies the name or OID of an attribute type for which values should be checked to ensure that they are 7-bit clean.
uid
userPassword
The name of an attribute type defined in the server schema.
Yes
Yes
None
No
No
Specifies the base DN below which the checking is performed. Any attempt to update a value for one of the configured attributes below this base DN must be 7-bit clean for the operation to be allowed.
All entries below all public naming contexts will be checked.
A valid DN.
Yes
No
None
No
No
Indicates whether the plug-in is enabled for use.
None
true
false
No
Yes
None
No
No
Indicates whether the plug-in should be invoked for internal operations. Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
true
true
false
No
No
None
Yes (Use --advanced in interactive mode.)
No
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
org.opends.server.plugins.SevenBitCleanPlugin
A Java class that implements or extends the class(es): org.opends.server.api.plugin.DirectoryServerPlugin
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
ldifimport
preparseadd
preparsemodify
preparsemodifydn
Invoked before sending an intermediate repsonse message to the client.
Invoked for each operation to be written during an LDIF export.
Invoked for each entry read during an LDIF import.
Invoked at the beginning of an LDIF import session.
Invoked at the end of an LDIF import session.
Invoked whenever a new connection is established to the server.
Invoked whenever an existing connection is terminated (by either the client or the server).
Invoked after completing the abandon processing.
Invoked after completing the core add processing but before sending the response to the client.
Invoked after completing the core bind processing but before sending the response to the client.
Invoked after completing the core compare processing but before sending the response to the client.
Invoked after completing the core delete processing but before sending the response to the client.
Invoked after completing the core extended processing but before sending the response to the client.
Invoked after completing the core modify processing but before sending the response to the client.
Invoked after completing the core modify DN processing but before sending the response to the client.
Invoked after completing the core search processing but before sending the response to the client.
Invoked after completing the unbind processing.
Invoked after sending the add response to the client.
Invoked after sending the bind response to the client.
Invoked after sending the compare response to the client.
Invoked after sending the delete response to the client.
Invoked after sending the extended response to the client.
Invoked after sending the modify response to the client.
Invoked after sending the modify DN response to the client.
Invoked after sending the search result done message to the client.
Invoked after completing post-synchronization processing for an add operation.
Invoked after completing post-synchronization processing for a delete operation.
Invoked after completing post-synchronization processing for a modify operation.
Invoked after completing post-synchronization processing for a modify DN operation.
Invoked prior to performing the core add processing.
Invoked prior to performing the core bind processing.
Invoked prior to performing the core compare processing.
Invoked prior to performing the core delete processing.
Invoked prior to performing the core extended processing.
Invoked prior to performing the core modify processing.
Invoked prior to performing the core modify DN processing.
Invoked prior to performing the core search processing.
Invoked prior to parsing an abandon request.
Invoked prior to parsing an add request.
Invoked prior to parsing a bind request.
Invoked prior to parsing a compare request.
Invoked prior to parsing a delete request.
Invoked prior to parsing an extended request.
Invoked prior to parsing a modify request.
Invoked prior to parsing a modify DN request.
Invoked prior to parsing a search request.
Invoked prior to parsing an unbind request.
Invoked before sending a search result entry to the client.
Invoked before sending a search result reference to the client.
Invoked during a graceful directory server shutdown.
Invoked during the directory server startup process.
Invoked in the course of deleting a subordinate entry of a delete operation.
Invoked in the course of moving or renaming an entry subordinate to the target of a modify DN operation.
Yes
Yes
The Plugin must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Plugins of type unique-attribute-plugin have the following properties:
Specifies a base DN within which the attribute must be unique.
The plug-in uses the server's public naming contexts in the searches.
A valid DN.
Yes
No
None
No
No
Indicates whether the plug-in is enabled for use.
None
true
false
No
Yes
None
No
No
Indicates whether the plug-in should be invoked for internal operations. Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
true
true
false
No
No
None
Yes (Use --advanced in interactive mode.)
No
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
org.opends.server.plugins.UniqueAttributePlugin
A Java class that implements or extends the class(es): org.opends.server.api.plugin.DirectoryServerPlugin
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
preoperationadd
preoperationmodify
preoperationmodifydn
postoperationadd
postoperationmodify
postoperationmodifydn
postsynchronizationadd
postsynchronizationmodify
postsynchronizationmodifydn
Invoked before sending an intermediate repsonse message to the client.
Invoked for each operation to be written during an LDIF export.
Invoked for each entry read during an LDIF import.
Invoked at the beginning of an LDIF import session.
Invoked at the end of an LDIF import session.
Invoked whenever a new connection is established to the server.
Invoked whenever an existing connection is terminated (by either the client or the server).
Invoked after completing the abandon processing.
Invoked after completing the core add processing but before sending the response to the client.
Invoked after completing the core bind processing but before sending the response to the client.
Invoked after completing the core compare processing but before sending the response to the client.
Invoked after completing the core delete processing but before sending the response to the client.
Invoked after completing the core extended processing but before sending the response to the client.
Invoked after completing the core modify processing but before sending the response to the client.
Invoked after completing the core modify DN processing but before sending the response to the client.
Invoked after completing the core search processing but before sending the response to the client.
Invoked after completing the unbind processing.
Invoked after sending the add response to the client.
Invoked after sending the bind response to the client.
Invoked after sending the compare response to the client.
Invoked after sending the delete response to the client.
Invoked after sending the extended response to the client.
Invoked after sending the modify response to the client.
Invoked after sending the modify DN response to the client.
Invoked after sending the search result done message to the client.
Invoked after completing post-synchronization processing for an add operation.
Invoked after completing post-synchronization processing for a delete operation.
Invoked after completing post-synchronization processing for a modify operation.
Invoked after completing post-synchronization processing for a modify DN operation.
Invoked prior to performing the core add processing.
Invoked prior to performing the core bind processing.
Invoked prior to performing the core compare processing.
Invoked prior to performing the core delete processing.
Invoked prior to performing the core extended processing.
Invoked prior to performing the core modify processing.
Invoked prior to performing the core modify DN processing.
Invoked prior to performing the core search processing.
Invoked prior to parsing an abandon request.
Invoked prior to parsing an add request.
Invoked prior to parsing a bind request.
Invoked prior to parsing a compare request.
Invoked prior to parsing a delete request.
Invoked prior to parsing an extended request.
Invoked prior to parsing a modify request.
Invoked prior to parsing a modify DN request.
Invoked prior to parsing a search request.
Invoked prior to parsing an unbind request.
Invoked before sending a search result entry to the client.
Invoked before sending a search result reference to the client.
Invoked during a graceful directory server shutdown.
Invoked during the directory server startup process.
Invoked in the course of deleting a subordinate entry of a delete operation.
Invoked in the course of moving or renaming an entry subordinate to the target of a modify DN operation.
Yes
Yes
The Plugin must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Specifies the type of attributes to check for value uniqueness.
None
The name of an attribute type defined in the server schema.
Yes
Yes
None
No
No