dsconfig create-log-rotation-policy — Creates Log Rotation Policies
dsconfig create-log-rotation-policy
{options}
The dsconfig create-log-rotation-policy command takes the following options:
--policy-name {name}
The name of the new Log Rotation Policy.
Log Rotation Policy properties depend on the Log Rotation Policy type, which depends on the {name} you provide.
By default, OpenDJ directory server supports the following Log Rotation Policy types:
Default {name}: Fixed Time Log Rotation Policy
Enabled by default: false
See the section called “Fixed Time Log Rotation Policy” for the properties of this Log Rotation Policy type.
Default {name}: Size Limit Log Rotation Policy
Enabled by default: false
See the section called “Size Limit Log Rotation Policy” for the properties of this Log Rotation Policy type.
Default {name}: Time Limit Log Rotation Policy
Enabled by default: false
See the section called “Time Limit Log Rotation Policy” for the properties of this Log Rotation 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 Rotation Policy properties depend on the Log Rotation Policy type, which depends on the --policy-name {name}
option.
-t | --type {type}
The type of Log Rotation Policy which should be created. The value for TYPE can be one of: custom | fixed-time | size-limit | time-limit.
Log Rotation Policy properties depend on the Log Rotation Policy type, which depends on the {type} you provide.
By default, OpenDJ directory server supports the following Log Rotation Policy types:
Default {type}: Fixed Time Log Rotation Policy
Enabled by default: false
See the section called “Fixed Time Log Rotation Policy” for the properties of this Log Rotation Policy type.
Default {type}: Size Limit Log Rotation Policy
Enabled by default: false
See the section called “Size Limit Log Rotation Policy” for the properties of this Log Rotation Policy type.
Default {type}: Time Limit Log Rotation Policy
Enabled by default: false
See the section called “Time Limit Log Rotation Policy” for the properties of this Log Rotation Policy type.
Log Rotation Policies of type fixed-time-log-rotation-policy have the following properties:
Specifies the fully-qualified name of the Java class that provides the Fixed Time Log Rotation Policy implementation.
org.opends.server.loggers.FixedTimeRotationPolicy
A Java class that implements or extends the class(es): org.opends.server.loggers.RotationPolicy
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
Specifies the time of day at which log rotation should occur.
None
24 hour time of day in HHmm format.
Yes
Yes
None
No
No
Log Rotation Policies of type size-limit-log-rotation-policy have the following properties:
Specifies the maximum size that a log file can reach before it is rotated.
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 Rotation Policy implementation.
org.opends.server.loggers.SizeBasedRotationPolicy
A Java class that implements or extends the class(es): org.opends.server.loggers.RotationPolicy
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
Log Rotation Policies of type time-limit-log-rotation-policy have the following properties:
Specifies the fully-qualified name of the Java class that provides the Time Limit Log Rotation Policy implementation.
org.opends.server.loggers.TimeLimitRotationPolicy
A Java class that implements or extends the class(es): org.opends.server.loggers.RotationPolicy
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
Specifies the time interval between rotations.
None
Some property values take a time duration.
Durations are expressed as numbers followed by units.
For example 1 s
means one second,
and 2 w
means two weeks.
Some durations have minimum granularity or maximum units,
so you cannot necessary specify every duration
in milliseconds or weeks for example.
Some durations allow you to use a special value to mean unlimited.
Units are specified as follows.
ms
: milliseconds
s
: seconds
m
: minutes
h
: hours
d
: days
w
: weeks
Lower limit is 1 milliseconds.
No
Yes
None
No
No