Specifies whether to append to existing log files.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
enabled
Description
Indicates whether the Log Publisher is enabled for use.
Default Value
None
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No
log-connection-details
Description
Indicates whether the connection details should be logged for the operation.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
log-file
Description
The file name to use for the log files generated by the File Based Audit Log Publisher. The path to the file is relative to the server root.
Default Value
None
Allowed Values
A path to an existing file that is readable by the server.
Multi-valued
No
Required
Yes
Admin Action Required
The File Based Audit Log Publisher must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
log-file-permissions
Description
The UNIX permissions of the log files created by this File Based Audit Log Publisher.
Default Value
640
Allowed Values
A valid UNIX mode string. The mode string must contain three digits between zero and seven.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No
log-file-use-local-time
Description
Specifies whether to use local time or GMT for the name of the rotated files.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
mask-passwords
Description
Indicates whether the password attributes values should be masked in the audit log. Default value is true.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
masked-attribute
Description
Allows to define some attributes whose value will be masked in the log file. This is currently only relevant for the audit log. If masked-suffix is filled, only attributes of entries under those suffixes are masked. Defines one attribute whose value will not be visible in the log file. This is currently only relevant for the audit log. Instead of the value, five star characters are displayed. Example: sensibleAttribute: ***** instead of: sensibleAttribute: sensibleNotMaskedValue
Default Value
None
Allowed Values
The name of an attribute type defined in the server schema.
Multi-valued
Yes
Required
No
Admin Action Required
None. Changes to this setting take effect only for logs that occur after the change is made. It is not retroactively applied to existing logs.
Advanced Property
No
Read-only
No
masked-suffix
Description
Allows to define the suffixes in which attributes masking in the audit log should occur. This is currently only relevant for the audit log. The attribute masking in the audit log occurs only on attributes in entries that are under the suffixes defined here. If no suffix is specified, any available suffix in the server is subject to attribute masking in the audit log.
Default Value
None
Allowed Values
A valid DN.
Multi-valued
Yes
Required
No
Admin Action Required
None. Changes to this setting take effect only for logs that occur after the change is made. It is not retroactively applied to existing logs.
Advanced Property
No
Read-only
No
masking-uses-encryption-config
Description
Indicates whether attribute masking in the audit log should also take care of encryption configuration. If true, attribute-encryption-include and encrypted-suffix attributes in data encryption configuration are used to define which attributes under which suffixes should be masked in the audit log. If false, data encryption configuration is not taken into account. If value is true, attributes defined in encryption configuration will only be masked if attribute encryption is enabled. This attribute does not impact usage of masked-attribute and masked-suffix which are always evaluated.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
operations-to-log
Description
Indicates which operations has to be logged.
Default Value
administration
user
adminbrowsing
synchronization
Allowed Values
adminbrowsing - operations which are performed with the "Network group selection" control (no Network group dependency).
administration - operations performed on the admin network group, excluding operation with "Network group selection" control.
all - All of the above (if specified, any other value specified for the attribute is ignored).
internal - internal operations (for example, operations that are initiated by plugins).
synchronization - synchronization operations.
user - operations performed on any user network group should be logged, excluding operation with "Network group selection" control.
Multi-valued
Yes
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
retention-policy
Description
The retention policy to use for the File Based Audit Log Publisher . When multiple policies are used, log files are cleaned when any of the policy's conditions are met.
Default Value
No retention policy is used and log files are never cleaned.
The rotation policy to use for the File Based Audit Log Publisher . When multiple policies are used, rotation will occur if any policy's conditions are met.
Default Value
No rotation policy is used and log rotation will not occur.
Indicates whether the File Based Audit Log Publisher will publish records asynchronously.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
Yes
Read-only
No
auto-flush
Description
Specifies whether to flush the writer after every log record. If the asynchronous writes option is used, the writer is flushed after all the log records in the queue are written.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
buffer-size
Description
Specifies the log file buffer size.
Default Value
64kb
Allowed Values
A positive integer representing a size. Lower value is 1.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
java-class
Description
The fully-qualified name of the Java class that provides the File Based Audit Log Publisher implementation.
Default Value
org.opends.server.loggers.TextAuditLogPublisher
Allowed Values
A java class that implements or extends the class(es) :
org.opends.server.api.AccessLogPublisher
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
Yes
Read-only
No
log-control-details
Description
Indicates whether the request controls and response controls details should be logged along with the operations that are requested by the client applications.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
log-controls
Description
Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
log-qtime
Description
Logs the time spent in preprocessing queue for an operation.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
queue-size
Description
The maximum number of log records that can be stored in the asynchronous queue. Setting the queue size to zero activates parallel log writer implementation which has no queue size limit and as such the parallel log writer should only be used on a very well tuned server configuration to avoid potential out of memory errors.
Default Value
5000
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
The File Based Audit Log Publisher must be restarted if this property is changed and the asynchronous property is set to true.
Advanced Property
Yes
Read-only
No
time-interval
Description
Specifies the interval at which to check whether the log files need to be rotated.