External Access Log Publisher

External Access Log Publishers publish access messages to an external handler.

Parent

The External Access Log Publisher object inherits from Access Log Publisher.

Properties

Use the --advanced option to access advanced properties.

Basic Properties

config-file

SynopsisThe JSON configuration file that defines the External Access Log Publisher. The content of the JSON configuration file depends on the type of external audit event handler. The path to the file is relative to the server root.
Default ValueNone
Allowed ValuesA path to an existing file that is readable by the server.
Multi-valuedNo
RequiredYes
Admin Action RequiredThe object must be disabled and re-enabled for changes to take effect.
AdvancedNo
Read-OnlyNo

enabled

SynopsisIndicates whether the Log Publisher is enabled for use.
Default ValueNone
Allowed Valuestrue
false
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

filtering-policy

SynopsisSpecifies how filtering criteria should be applied to log records.
Default Valueno-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-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

log-control-oids

SynopsisSpecifies whether control OIDs will be included in operation log records.
Default Valuefalse
Allowed Valuestrue
false
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

Advanced Properties

java-class

SynopsisThe fully-qualified name of the Java class that provides the External Access Log Publisher implementation.
Default Valueorg.opends.server.loggers.ExternalAccessLogPublisher
Allowed ValuesA Java class that extends or implements:
org.opends.server.loggers.LogPublisher
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedYes
Read-OnlyNo

suppress-internal-operations

SynopsisIndicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users.
Default Valuetrue
Allowed Valuestrue
false
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedYes
Read-OnlyNo

suppress-synchronization-operations

SynopsisIndicates whether access messages that are generated by synchronization operations should be suppressed.
Default Valuefalse
Allowed Valuestrue
false
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedYes
Read-OnlyNo