Metrics Engine Documentation Index
Configuration Reference Home

Log Retention Policy

Note: this is an abstract component that cannot be instantiated.

Log Retention Policies are used to specify when log files should be cleaned.

Direct Subcomponents
Relations to This Component
Properties
dsconfig Usage

Direct Subcomponents

The following Log Retention Policies are available in the server :

These Log Retention Policies inherit from the properties described below.

Relations to This Component

The following components have a direct aggregation relation to Log Retention Policies:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ java-class

Basic Properties

description

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

java-class (Read-Only)

Description
Specifies the fully-qualified name of the Java class that provides the Log Retention Policy implementation.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.loggers.RetentionPolicy
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Log Retention Policies:

dsconfig list-log-retention-policies
     [--property {propertyName}] ...

To view the configuration for an existing Log Retention Policy:

dsconfig get-log-retention-policy-prop
     --policy-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Log Retention Policy:

dsconfig set-log-retention-policy-prop
     --policy-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To delete an existing Log Retention Policy:

dsconfig delete-log-retention-policy
     --policy-name {name}