Third Party Log File Rotation Listener

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.

Third Party Log File Rotation Listener provide log file rotation listener implementations created in third-party code using the UnboundID server SDK.

Parent Component Properties dsconfig Usage

Parent Component

The Third Party Log File Rotation Listener component inherits from the Log File Rotation Listener

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
 description  None
 enabled
 extension-class
 extension-argument

Basic Properties

description

Description
A description for this Log File Rotation Listener
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

enabled

Description
Indicates whether the Log File Rotation Listener is enabled for use.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

extension-class (Read-Only)

Description
The fully-qualified name of the Java class providing the logic for the Third Party Log File Rotation Listener.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.common.api.LogFileRotationListener
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

extension-argument

Description
The set of arguments used to customize the behavior for the Third Party Log File Rotation Listener. Each configuration property should be given in the form 'name=value'.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Log File Rotation Listeners:

dsconfig list-log-file-rotation-listeners
     [--property {propertyName}] ...

To view the configuration for an existing Log File Rotation Listener:

dsconfig get-log-file-rotation-listener-prop
     --listener-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Log File Rotation Listener:

dsconfig set-log-file-rotation-listener-prop
     --listener-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Third Party Log File Rotation Listener:

dsconfig create-log-file-rotation-listener
     --listener-name {name}
     --type third-party
     --set enabled:{propertyValue}
     --set extension-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Log File Rotation Listener:

dsconfig delete-log-file-rotation-listener
     --listener-name {name}