dsconfig list-log-rotation-policies
Prev | dsconfig Subcommands Reference | Next

## Name

dsconfig list-log-rotation-policies — Lists existing Log Rotation Policies

## Synopsis

`dsconfig list-log-rotation-policies` {options}

## Description

Lists existing Log Rotation Policies.

## Options

The dsconfig list-log-rotation-policies command takes the following options:

`--property {property}`

  The name of a property to be displayed.

  Log Rotation Policy properties depend on the Log Rotation Policy type, which depends on the {property} you provide.

  By default, OpenDJ directory server supports the following Log Rotation Policy types:

  fixed-time-log-rotation-policy

    Default {property}: 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.

  size-limit-log-rotation-policy

    Default {property}: 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.

  time-limit-log-rotation-policy

    Default {property}: 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.

`-z | --unit-size {unit}`

  Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).

  Log Rotation Policy properties depend on the Log Rotation Policy type, which depends on the {unit} you provide.

  By default, OpenDJ directory server supports the following Log Rotation Policy types:

  fixed-time-log-rotation-policy

    Default {unit}: 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.

  size-limit-log-rotation-policy

    Default {unit}: 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.

  time-limit-log-rotation-policy

    Default {unit}: 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.

`-m | --unit-time {unit}`

  Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).

  Log Rotation Policy properties depend on the Log Rotation Policy type, which depends on the {unit} you provide.

  By default, OpenDJ directory server supports the following Log Rotation Policy types:

  fixed-time-log-rotation-policy

    Default {unit}: 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.

  size-limit-log-rotation-policy

    Default {unit}: 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.

  time-limit-log-rotation-policy

    Default {unit}: 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.

## Fixed Time Log Rotation Policy

Log Rotation Policies of type fixed-time-log-rotation-policy have the following properties:

java-class
  Description

    Specifies the fully-qualified name of the Java class that provides the Fixed Time Log Rotation Policy implementation.

  Default Value

    org.opends.server.loggers.FixedTimeRotationPolicy

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.loggers.RotationPolicy

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

time-of-day
  Description

    Specifies the time of day at which log rotation should occur.

  Default Value

    None

  Allowed Values

    24 hour time of day in HHmm format.

  Multi-valued

    Yes

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

## Size Limit Log Rotation Policy

Log Rotation Policies of type size-limit-log-rotation-policy have the following properties:

file-size-limit
  Description

    Specifies the maximum size that a log file can reach before it is rotated.

  Default Value

    None

  Allowed Values

    Lower value is 1.

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

java-class
  Description

    Specifies the fully-qualified name of the Java class that provides the Size Limit Log Rotation Policy implementation.

  Default Value

    org.opends.server.loggers.SizeBasedRotationPolicy

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.loggers.RotationPolicy

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

## Time Limit Log Rotation Policy

Log Rotation Policies of type time-limit-log-rotation-policy have the following properties:

java-class
  Description

    Specifies the fully-qualified name of the Java class that provides the Time Limit Log Rotation Policy implementation.

  Default Value

    org.opends.server.loggers.TimeLimitRotationPolicy

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.loggers.RotationPolicy

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

rotation-interval
  Description

    Specifies the time interval between rotations.

  Default Value

    None

  Allowed Values

    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.

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

Prev | Up | Next
dsconfig list-log-retention-policies | Home | dsconfig list-monitor-providers