Name

dsconfig get-work-queue-prop — Shows Work Queue properties

Synopsis

dsconfig get-work-queue-prop {options}

Options

The dsconfig get-work-queue-prop command takes the following options:

--property {property}

The name of a property to be displayed.

-E | --record

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

Work Queue properties depend on the Work Queue type, which depends on the null you provide.

By default, OpenDJ directory server supports the following Work Queue types:

parallel-work-queue

Default null: Parallel Work Queue

Enabled by default: false

See the section called “Parallel Work Queue” for the properties of this Work Queue type.

traditional-work-queue

Default null: Traditional Work Queue

Enabled by default: false

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

Work Queue properties depend on the Work Queue type, which depends on the {unit} you provide.

By default, OpenDJ directory server supports the following Work Queue types:

parallel-work-queue

Default {unit}: Parallel Work Queue

Enabled by default: false

See the section called “Parallel Work Queue” for the properties of this Work Queue type.

traditional-work-queue

Default {unit}: Traditional Work Queue

Enabled by default: false

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

Work Queue properties depend on the Work Queue type, which depends on the {unit} you provide.

By default, OpenDJ directory server supports the following Work Queue types:

parallel-work-queue

Default {unit}: Parallel Work Queue

Enabled by default: false

See the section called “Parallel Work Queue” for the properties of this Work Queue type.

traditional-work-queue

Default {unit}: Traditional Work Queue

Enabled by default: false

See the section called “Traditional Work Queue” for the properties of this Work Queue type.

Traditional Work Queue

Work Queues of type traditional-work-queue have the following properties:

java-class
Description

Specifies the fully-qualified name of the Java class that provides the Traditional Work Queue implementation.

Default Value

org.opends.server.extensions.TraditionalWorkQueue

Allowed Values

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

Multi-valued

No

Required

Yes

Admin Action Required

Restart the server

Advanced Property

Yes (Use --advanced in interactive mode.)

Read-only

No

max-work-queue-capacity
Description

Specifies the maximum number of queued operations that can be in the work queue at any given time. If the work queue is already full and additional requests are received by the server, then the server front end, and possibly the client, will be blocked until the work queue has available capacity.

Default Value

1000

Allowed Values

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

Multi-valued

No

Required

No

Admin Action Required

None

Advanced Property

No

Read-only

No

num-worker-threads
Description

Specifies the number of worker threads to be used for processing operations placed in the queue. If the value is increased, the additional worker threads are created immediately. If the value is reduced, the appropriate number of threads are destroyed as operations complete processing.

Default Value

Let the server decide.

Allowed Values

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

Multi-valued

No

Required

No

Admin Action Required

None

Advanced Property

No

Read-only

No