Doc changes to Log Rotation and Retention Policy Configuration docs and some copyright changes. Thanks to Daniel for the review.
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="file-count-log-retention-policy" |
| | | plural-name="file-count-log-retention-policies" |
| | |
| | | </adm:property-override> |
| | | <adm:property name="number-of-files" mandatory="true"> |
| | | <adm:synopsis> |
| | | Number of log files to retain before the oldest ones will be |
| | | cleaned. |
| | | Specifies the number of archived log files to retain before the |
| | | oldest ones are cleaned. |
| | | </adm:synopsis> |
| | | <adm:syntax> |
| | | <adm:integer lower-limit="1" /> |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="fixed-time-log-rotation-policy" |
| | | plural-name="fixed-time-log-rotation-policies" |
| | |
| | | xmlns:adm="http://www.opends.org/admin" |
| | | xmlns:ldap="http://www.opends.org/admin-ldap"> |
| | | <adm:synopsis> |
| | | Rotation policy based on fixed time of day. |
| | | Rotation policy based on a fixed time of day. |
| | | </adm:synopsis> |
| | | <adm:profile name="ldap"> |
| | | <ldap:object-class> |
| | |
| | | <adm:property name="time-of-day" multi-valued="true" |
| | | mandatory="true"> |
| | | <adm:synopsis> |
| | | The time of day which log rotation should occur. |
| | | Specifies the time of day at which log rotation should occur. |
| | | </adm:synopsis> |
| | | <adm:syntax> |
| | | <adm:string> |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="free-disk-space-log-retention-policy" |
| | | plural-name="free-disk-space-log-retention-policies" |
| | |
| | | </adm:default-behavior> |
| | | </adm:property-override> |
| | | <adm:property name="free-disk-space" mandatory="true"> |
| | | <adm:synopsis>The size of free disk space needed.</adm:synopsis> |
| | | <adm:synopsis>Specifies the minimum amount of free disk space that |
| | | should be available on the file system on which the archived |
| | | log files are stored. |
| | | </adm:synopsis> |
| | | <adm:syntax> |
| | | <adm:size lower-limit="1" /> |
| | | </adm:syntax> |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="log-retention-policy" |
| | | plural-name="log-retention-policies" |
| | |
| | | </adm:profile> |
| | | <adm:property name="java-class" mandatory="true"> |
| | | <adm:synopsis> |
| | | The fully-qualified name of the Java class that provides the |
| | | Specifies the fully-qualified name of the Java class that provides the |
| | | <adm:user-friendly-name /> |
| | | implementation. |
| | | </adm:synopsis> |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="log-rotation-policy" |
| | | plural-name="log-rotation-policies" |
| | |
| | | </adm:profile> |
| | | <adm:property name="java-class" mandatory="true"> |
| | | <adm:synopsis> |
| | | The fully-qualified name of the Java class that provides the |
| | | Specifies the fully-qualified name of the Java class that provides the |
| | | <adm:user-friendly-name /> |
| | | implementation. |
| | | </adm:synopsis> |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="size-limit-log-retention-policy" |
| | | plural-name="size-limit-log-retention-policies" |
| | |
| | | xmlns:adm="http://www.opends.org/admin" |
| | | xmlns:ldap="http://www.opends.org/admin-ldap"> |
| | | <adm:synopsis> |
| | | Retention policy based on the amount of space taken by the log files |
| | | on disk. |
| | | Retention policy based on the amount of space taken by all the log |
| | | files on disk. |
| | | </adm:synopsis> |
| | | <adm:profile name="ldap"> |
| | | <ldap:object-class> |
| | |
| | | </adm:property-override> |
| | | <adm:property name="disk-space-used" mandatory="true"> |
| | | <adm:synopsis> |
| | | The maximum total disk space used by the log files. |
| | | Specifies the maximum total disk space used by the log files. |
| | | </adm:synopsis> |
| | | <adm:syntax> |
| | | <adm:size lower-limit="1" /> |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="size-limit-log-rotation-policy" |
| | | plural-name="size-limit-log-rotation-policies" |
| | |
| | | </adm:property-override> |
| | | <adm:property name="file-size-limit" mandatory="true"> |
| | | <adm:synopsis> |
| | | The size of the file when rotation takes place. |
| | | Specifies the maximum size that a log file can reach before |
| | | it is rotated. |
| | | </adm:synopsis> |
| | | <adm:syntax> |
| | | <adm:size lower-limit="1" /> |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="time-limit-log-rotation-policy" |
| | | plural-name="time-limit-log-rotation-policies" |
| | |
| | | </adm:default-behavior> |
| | | </adm:property-override> |
| | | <adm:property name="rotation-interval" mandatory="true"> |
| | | <adm:synopsis>The time interval between rotations.</adm:synopsis> |
| | | <adm:synopsis> |
| | | Specifies the time interval between rotations. |
| | | </adm:synopsis> |
| | | <adm:syntax> |
| | | <adm:duration base-unit="ms" lower-limit="1" /> |
| | | </adm:syntax> |