dsconfig delete-entry-cache
Prev | dsconfig Subcommands Reference | Next

## Name

dsconfig delete-entry-cache — Deletes Entry Caches

## Synopsis

`dsconfig delete-entry-cache` {options}

## Description

Deletes Entry Caches.

## Options

The dsconfig delete-entry-cache command takes the following options:

`--cache-name {name}`

  The name of the Entry Cache.

  Entry Cache properties depend on the Entry Cache type, which depends on the {name} you provide.

  By default, OpenDJ directory server supports the following Entry Cache types:

  fifo-entry-cache

    Default {name}: FIFO Entry Cache

    Enabled by default: true

    See the section called “FIFO Entry Cache” for the properties of this Entry Cache type.

  soft-reference-entry-cache

    Default {name}: Soft Reference Entry Cache

    Enabled by default: true

    See the section called “Soft Reference Entry Cache” for the properties of this Entry Cache type.

`-f | --force`

  Ignore non-existent Entry Caches.

  Entry Cache properties depend on the Entry Cache type, which depends on the null you provide.

  By default, OpenDJ directory server supports the following Entry Cache types:

  fifo-entry-cache

    Default null: FIFO Entry Cache

    Enabled by default: true

    See the section called “FIFO Entry Cache” for the properties of this Entry Cache type.

  soft-reference-entry-cache

    Default null: Soft Reference Entry Cache

    Enabled by default: true

    See the section called “Soft Reference Entry Cache” for the properties of this Entry Cache type.

## FIFO Entry Cache

Entry Caches of type fifo-entry-cache have the following properties:

cache-level
  Description

    Specifies the cache level in the cache order if more than one instance of the cache is configured.

  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

enabled
  Description

    Indicates whether the Entry Cache is enabled.

  Default Value

    None

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

exclude-filter
  Description

    The set of filters that define the entries that should be excluded from the cache.

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    Yes

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

include-filter
  Description

    The set of filters that define the entries that should be included in the cache.

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    Yes

  Required

    No

  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 FIFO Entry Cache implementation.

  Default Value

    org.opends.server.extensions.FIFOEntryCache

  Allowed Values

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

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The Entry Cache must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

lock-timeout
  Description

    Specifies the length of time to wait while attempting to acquire a read or write lock.

  Default Value

    2000.0ms

  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

    A value of "-1" or "unlimited" for no limit. Lower limit is 0 milliseconds.

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

max-entries
  Description

    Specifies the maximum number of entries that we will allow in the cache.

  Default Value

    2147483647

  Allowed Values

    An integer value. Lower value is 0.

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

max-memory-percent
  Description

    Specifies the maximum percentage of JVM memory used by the server before the entry caches stops caching and begins purging itself. Very low settings such as 10 or 20 (percent) can prevent this entry cache from having enough space to hold any of the entries to cache, making it appear that the server is ignoring or skipping the entry cache entirely.

  Default Value

    90

  Allowed Values

    An integer value. Lower value is 1. Upper value is 100.

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

## Soft Reference Entry Cache

Entry Caches of type soft-reference-entry-cache have the following properties:

cache-level
  Description

    Specifies the cache level in the cache order if more than one instance of the cache is configured.

  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

enabled
  Description

    Indicates whether the Entry Cache is enabled.

  Default Value

    None

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

exclude-filter
  Description

    The set of filters that define the entries that should be excluded from the cache.

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    Yes

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

include-filter
  Description

    The set of filters that define the entries that should be included in the cache.

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    Yes

  Required

    No

  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 Soft Reference Entry Cache implementation.

  Default Value

    org.opends.server.extensions.SoftReferenceEntryCache

  Allowed Values

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

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The Entry Cache must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

lock-timeout
  Description

    Specifies the length of time in milliseconds to wait while attempting to acquire a read or write lock.

  Default Value

    3000ms

  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

    A value of "-1" or "unlimited" for no limit. Lower limit is 0 milliseconds.

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

Prev | Up | Next
dsconfig delete-debug-target | Home | dsconfig delete-extended-operation-handler