PingDS

Common Audit Access Log Publisher

This is an abstract object type that cannot be instantiated.

Common Audit Access Log Publishers publish access events to commons audit.

Common Audit Access Log Publishers

The following Common Audit Access Log Publishers are available:

These Common Audit Access Log Publishers inherit the properties described below.

Parent

The Common Audit Access Log Publisher object inherits from Access Log Publisher.

Common Audit Access Log Publisher properties

You can use configuration expressions to set property values at startup time. For details, see Property value substitution.

Basic Properties Advanced Properties

enabled
filtering-policy
java-class
log-controls

exclude-values-of-attributes
include-values-of-attributes
log-modified-attribute-values
suppress-internal-operations
suppress-synchronization-operations

Basic properties

Use the --advanced option to access advanced properties.

enabled

Synopsis

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

No

Read-only

No

filtering-policy

Synopsis

Specifies how filtering criteria should be applied to log records.

Default value

no-filtering

Allowed values

  • exclusive: Records must not match any of the filtering criteria in order to be logged.

  • inclusive: Records must match at least one of the filtering criteria in order to be logged.

  • no-filtering: No filtering will be performed, and all records will be logged.

Multi-valued

No

Required

No

Admin action required

None

Advanced

No

Read-only

No

java-class

Synopsis

The fully-qualified name of the Java class that provides the Access Log Publisher implementation.

Default value

org.opends.server.loggers.AccessLogPublisher

Allowed values

A Java class that extends or implements:

  • org.opends.server.loggers.LogPublisher

Multi-valued

No

Required

Yes

Admin action required

None

Advanced

No

Read-only

No

log-controls

Synopsis

Specifies whether controls with criticality and values will be included in operation log records.

Default value

true

Allowed values

true

false

Multi-valued

No

Required

No

Admin action required

None

Advanced

No

Read-only

No

Advanced properties

Use the --advanced option to access advanced properties.

exclude-values-of-attributes

Synopsis

Attributes types targeted by a modify operation for which the modified values should be omitted from the access log.

Default value

None

Allowed values

The name of an attribute type defined in the LDAP schema.

Multi-valued

Yes

Required

No

Admin action required

None

Advanced

Yes

Read-only

No

include-values-of-attributes

Synopsis

Attributes types targeted by a modify operation for which the modified values should be included in the access log.

Default value

None

Allowed values

The name of an attribute type defined in the LDAP schema.

Multi-valued

Yes

Required

No

Admin action required

None

Advanced

Yes

Read-only

No

log-modified-attribute-values

Synopsis

The access log contains the values of attributes targeted by a modify operation.

Default value

false

Allowed values

true

false

Multi-valued

No

Required

No

Admin action required

None

Advanced

Yes

Read-only

No

suppress-internal-operations

Synopsis

Indicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users.

Default value

true

Allowed values

true

false

Multi-valued

No

Required

No

Admin action required

None

Advanced

Yes

Read-only

No

suppress-synchronization-operations

Synopsis

Indicates whether access messages that are generated by synchronization operations should be suppressed.

Default value

false

Allowed values

true

false

Multi-valued

No

Required

No

Admin action required

None

Advanced

Yes

Read-only

No