dsconfig get-log-retention-policy-prop
Prev | dsconfig Subcommands Reference | Next

## Name

dsconfig get-log-retention-policy-prop — Shows Log Retention Policy properties

## Synopsis

`dsconfig get-log-retention-policy-prop` {options}

## Description

Shows Log Retention Policy properties.

## Options

The dsconfig get-log-retention-policy-prop command takes the following options:

`--policy-name {name}`

  The name of the 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:

  file-count-log-retention-policy

    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.

  free-disk-space-log-retention-policy

    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.

  size-limit-log-retention-policy

    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.

`--property {property}`

  The name of a property to be displayed.

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

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

  file-count-log-retention-policy

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

  free-disk-space-log-retention-policy

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

  size-limit-log-retention-policy

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

`-E | --record`

  Modifies the display output to show one property value per line.

  Log Retention Policy properties depend on the Log Retention Policy type, which depends on the null you provide.

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

  file-count-log-retention-policy

    Default null: 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.

  free-disk-space-log-retention-policy

    Default null: 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.

  size-limit-log-retention-policy

    Default null: 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.

`-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 Retention Policy properties depend on the Log Retention Policy type, which depends on the {unit} you provide.

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

  file-count-log-retention-policy

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

  free-disk-space-log-retention-policy

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

  size-limit-log-retention-policy

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

`-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 Retention Policy properties depend on the Log Retention Policy type, which depends on the {unit} you provide.

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

  file-count-log-retention-policy

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

  free-disk-space-log-retention-policy

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

  size-limit-log-retention-policy

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

## File Count Log Retention Policy

Log Retention Policies of type file-count-log-retention-policy have the following properties:

java-class
  Description

    Specifies the fully-qualified name of the Java class that provides the File Count Log Retention Policy implementation.

  Default Value

    org.opends.server.loggers.FileNumberRetentionPolicy

  Allowed Values

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

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

number-of-files
  Description

    Specifies the number of archived log files to retain before the oldest ones are cleaned.

  Default Value

    None

  Allowed Values

    An integer value. Lower value is 1.

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

## Free Disk Space Log Retention Policy

Log Retention Policies of type free-disk-space-log-retention-policy have the following properties:

free-disk-space
  Description

    Specifies the minimum amount of free disk space that should be available on the file system on which the archived log files are stored.

  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 Free Disk Space Log Retention Policy implementation.

  Default Value

    org.opends.server.loggers.FreeDiskSpaceRetentionPolicy

  Allowed Values

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

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

## Size Limit Log Retention Policy

Log Retention Policies of type size-limit-log-retention-policy have the following properties:

disk-space-used
  Description

    Specifies the maximum total disk space used by the log files.

  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 Retention Policy implementation.

  Default Value

    org.opends.server.loggers.SizeBasedRetentionPolicy

  Allowed Values

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

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

Prev | Up | Next
dsconfig get-log-publisher-prop | Home | dsconfig get-log-rotation-policy-prop