dsconfig create-log-retention-policy — Creates Log Retention Policies
dsconfig create-log-retention-policy
{options}
The dsconfig create-log-retention-policy command takes the following options:
--policy-name {name}
The name of the new Log Retention Policy.
Log Retention Policy properties depend on the Log Retention Policy type, which depends on the {name} you provide.
By default, OpenDJ directory server supports the following Log Retention Policy types:
Default {name}: File Count Log Retention Policy
Enabled by default: false
See the section called “File Count Log Retention Policy” for the properties of this Log Retention Policy type.
Default {name}: Free Disk Space Log Retention Policy
Enabled by default: false
See the section called “Free Disk Space Log Retention Policy” for the properties of this Log Retention Policy type.
Default {name}: Size Limit Log Retention Policy
Enabled by default: false
See the section called “Size Limit Log Retention Policy” for the properties of this Log Retention Policy type.
--set {PROP:VALUE}
Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it.
Log Retention Policy properties depend on the Log Retention Policy type, which depends on the --policy-name {name}
option.
-t | --type {type}
The type of Log Retention Policy which should be created. The value for TYPE can be one of: custom | file-count | free-disk-space | size-limit.
Log Retention Policy properties depend on the Log Retention Policy type, which depends on the {type} you provide.
By default, OpenDJ directory server supports the following Log Retention Policy types:
Default {type}: File Count Log Retention Policy
Enabled by default: false
See the section called “File Count Log Retention Policy” for the properties of this Log Retention Policy type.
Default {type}: Free Disk Space Log Retention Policy
Enabled by default: false
See the section called “Free Disk Space Log Retention Policy” for the properties of this Log Retention Policy type.
Default {type}: Size Limit Log Retention Policy
Enabled by default: false
See the section called “Size Limit Log Retention Policy” for the properties of this Log Retention Policy type.
Log Retention Policies of type file-count-log-retention-policy have the following properties:
Specifies the fully-qualified name of the Java class that provides the File Count Log Retention Policy implementation.
org.opends.server.loggers.FileNumberRetentionPolicy
A Java class that implements or extends the class(es): org.opends.server.loggers.RetentionPolicy
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
Specifies the number of archived log files to retain before the oldest ones are cleaned.
None
An integer value. Lower value is 1.
No
Yes
None
No
No
Log Retention Policies of type free-disk-space-log-retention-policy have the following properties:
Specifies the minimum amount of free disk space that should be available on the file system on which the archived log files are stored.
None
Lower value is 1.
No
Yes
None
No
No
Specifies the fully-qualified name of the Java class that provides the Free Disk Space Log Retention Policy implementation.
org.opends.server.loggers.FreeDiskSpaceRetentionPolicy
A Java class that implements or extends the class(es): org.opends.server.loggers.RetentionPolicy
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
Log Retention Policies of type size-limit-log-retention-policy have the following properties:
Specifies the maximum total disk space used by the log files.
None
Lower value is 1.
No
Yes
None
No
No
Specifies the fully-qualified name of the Java class that provides the Size Limit Log Retention Policy implementation.
org.opends.server.loggers.SizeBasedRetentionPolicy
A Java class that implements or extends the class(es): org.opends.server.loggers.RetentionPolicy
No
Yes
None
Yes (Use --advanced in interactive mode.)
No