dsconfig list-debug-targets
Prev | dsconfig Subcommands Reference | Next

## Name

dsconfig list-debug-targets — Lists existing Debug Targets

## Synopsis

`dsconfig list-debug-targets` {options}

## Description

Lists existing Debug Targets.

## Options

The dsconfig list-debug-targets command takes the following options:

`--publisher-name {name}`

  The name of the Debug Log Publisher.

  Debug Target properties depend on the Debug Target type, which depends on the {name} you provide.

  By default, OpenDJ directory server supports the following Debug Target types:

  debug-target

    Default {name}: Debug Target

    Enabled by default: true

    See the section called “Debug Target” for the properties of this Debug Target type.

`--property {property}`

  The name of a property to be displayed.

  Debug Target properties depend on the Debug Target type, which depends on the {property} you provide.

  By default, OpenDJ directory server supports the following Debug Target types:

  debug-target

    Default {property}: Debug Target

    Enabled by default: true

    See the section called “Debug Target” for the properties of this Debug Target 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).

  Debug Target properties depend on the Debug Target type, which depends on the {unit} you provide.

  By default, OpenDJ directory server supports the following Debug Target types:

  debug-target

    Default {unit}: Debug Target

    Enabled by default: true

    See the section called “Debug Target” for the properties of this Debug Target 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).

  Debug Target properties depend on the Debug Target type, which depends on the {unit} you provide.

  By default, OpenDJ directory server supports the following Debug Target types:

  debug-target

    Default {unit}: Debug Target

    Enabled by default: true

    See the section called “Debug Target” for the properties of this Debug Target type.

## Debug Target

Debug Targets of type debug-target have the following properties:

debug-exceptions-only
  Description

    Indicates whether only logs with exception should be logged.

  Default Value

    false

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

debug-scope
  Description

    Specifies the fully-qualified OpenDJ Java package, class, or method affected by the settings in this target definition. Use the number character (#) to separate the class name and the method name (that is, org.opends.server.core.DirectoryServer#startUp).

  Default Value

    None

  Allowed Values

    The fully-qualified OpenDJ Java package, class, or method name.

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    Yes

enabled
  Description

    Indicates whether the Debug Target is enabled.

  Default Value

    None

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

include-throwable-cause
  Description

    Specifies the property to indicate whether to include the cause of exceptions in exception thrown and caught messages.

  Default Value

    false

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

omit-method-entry-arguments
  Description

    Specifies the property to indicate whether to include method arguments in debug messages.

  Default Value

    false

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

omit-method-return-value
  Description

    Specifies the property to indicate whether to include the return value in debug messages.

  Default Value

    false

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

throwable-stack-frames
  Description

    Specifies the property to indicate the number of stack frames to include in the stack trace for method entry and exception thrown messages.

  Default Value

    0

  Allowed Values

    An integer value. Lower value is 0.

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

Prev | Up | Next
dsconfig list-connection-handlers | Home | dsconfig list-entry-caches