Name

dsconfig set-work-queue-prop — Modifies Work Queue properties

Synopsis

dsconfig set-work-queue-prop {options}

Description

Modifies Work Queue properties.

Options

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

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it.

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

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset.

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

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added.

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

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed.

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

Parallel Work Queue

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

java-class
Description

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

Default Value

org.opends.server.extensions.ParallelWorkQueue

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

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

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