The
is used to interact with clients using LDAP.
It provides full support for LDAPv3 and limited
support for LDAPv2.
A Key Manager Provider must be specified when this
is enabled and it is configured to use SSL or StartTLS.
A Trust Manager Provider must be specified when this
is enabled and it is configured to use SSL or StartTLS.
A
cannot be configured to support SSL and StartTLS at the same time.
Either SSL or StartTLS must be disabled in order for this
to be used.
ds-cfg-ldap-connection-handler
ds-cfg-connection-handler
org.opends.server.protocols.ldap.LDAPConnectionHandler
Specifies the name of the key manager that should be used with
this
.
Changes to this property take effect immediately, but
only for subsequent attempts to access the key manager
provider for associated client connections.
The referenced key manager provider must be enabled when
the
is enabled and configured to use SSL or StartTLS.
ds-cfg-key-manager-provider
Specifies the name of the trust manager that should be used with
the
.
Changes to this property take effect immediately, but
only for subsequent attempts to access the trust manager
provider for associated client connections.
The referenced trust manager provider must be enabled when
the
is enabled and configured to use SSL or StartTLS.
ds-cfg-trust-manager-provider
Specifies the address or set of addresses on which this
should listen for connections from LDAP clients.
Multiple addresses may be provided as separate values for this
attribute. If no values are provided, then the
listens on all interfaces.
0.0.0.0
ds-cfg-listen-address
Indicates whether connections from LDAPv2 clients are allowed.
If LDAPv2 clients are allowed, then only a minimal degree of
special support are provided for them to ensure that
LDAPv3-specific protocol elements (for example, Configuration Guide 25
controls, extended response messages, intermediate response
messages, referrals) are not sent to an LDAPv2 client.
true
ds-cfg-allow-ldap-v2
Indicates whether the
should keep statistics.
If enabled, the
maintains statistics about the number and types of operations
requested over LDAP and the amount of data sent and received.
true
ds-cfg-keep-stats
Indicates whether the
should use TCP keep-alive.
If enabled, the SO_KEEPALIVE socket option is used to indicate that TCP
keepalive messages should periodically be sent to the client to
verify that the associated connection is still valid. This may
also help prevent cases in which intermediate network hardware
could silently drop an otherwise idle client connection, provided
that the keepalive interval configured in the underlying operating
system is smaller than the timeout enforced by the network
hardware.
true
ds-cfg-use-tcp-keep-alive
Indicates whether the
should use TCP no-delay.
If enabled, the TCP_NODELAY socket option is used to ensure
that response messages to the client are sent immediately rather
than potentially waiting to determine whether additional response
messages can be sent in the same packet. In most cases, using the
TCP_NODELAY socket option provides better performance and
lower response times, but disabling it may help for some cases in
which the server sends a large number of entries to a client
in response to a search request.
true
ds-cfg-use-tcp-no-delay
Indicates whether the
should reuse socket descriptors.
If enabled, the SO_REUSEADDR socket option is used on the
server listen socket to potentially allow the reuse of socket
descriptors for clients in a TIME_WAIT state. This may help the
server avoid temporarily running out of socket descriptors in
cases in which a very large number of short-lived connections have
been established from the same client system.
true
ds-cfg-allow-tcp-reuse-address
Indicates whether the
should send a notice of disconnection extended response message to
the client if a new connection is rejected for some reason.
The extended response message may provide an explanation
indicating the reason that the connection was rejected.
true
ds-cfg-send-rejection-notice
Specifies the size in bytes of the largest LDAP request message that will
be allowed by this LDAP Connection handler.
This property is analogous to the maxBERSize configuration
attribute of the Sun Java System Directory Server. This can help
prevent denial-of-service attacks by clients that indicate they
send extremely large requests to the server causing it to
attempt to allocate large amounts of memory.
5 megabytes
ds-cfg-max-request-size
Specifies the size in bytes of the LDAP response message write buffer.
This property specifies write buffer size allocated by the server for
each client connection and used to buffer LDAP response messages data
when writing.
4096 bytes
ds-cfg-buffer-size
Specifies the number of request handlers that are used to read
requests from clients.
The
uses one thread to accept new connections from clients, but uses
one or more additional threads to read requests from existing
client connections. This ensures that new requests are
read efficiently and that the connection handler itself does not
become a bottleneck when the server is under heavy load from many
clients at the same time.
Let the server decide.
ds-cfg-num-request-handlers
Indicates whether clients are allowed to use StartTLS.
If enabled, the
allows clients to use the StartTLS extended operation to
initiate secure communication over an otherwise insecure channel.
Note that this is only allowed if the
is not configured to use SSL, and if the server is configured with
a valid key manager provider and a valid trust manager provider.
false
ds-cfg-allow-start-tls
Specifies the policy that the
should use regarding client SSL certificates.
This is only applicable if clients are allowed to use SSL.
optional
Clients are not required to provide their own
certificates when performing SSL negotiation.
Clients are requested to provide their own certificates
when performing SSL negotiation, but still accept the
connection even if the client does not provide a
certificate.
Clients are required to provide their own certificates
when performing SSL negotiation and are refused access
if the do not provide a certificate.
ds-cfg-ssl-client-auth-policy
Specifies the maximum number of pending connection attempts that
are allowed to queue up in the accept backlog before the
server starts rejecting new connection attempts.
This is primarily an issue for cases in which a large number of
connections are established to the server in a very short period
of time (for example, a benchmark utility that creates a large number of
client threads that each have their own connection to the server)
and the connection handler is unable to keep up with the rate at
which the new connections are established.
128
connections
ds-cfg-accept-backlog
Specifies the names of the SSL protocols that are allowed for
use in SSL or StartTLS communication.
Changes to this property take effect immediately but only
impact new SSL/TLS-based sessions created after the
change.
Uses the default set of SSL protocols provided by the server's
JVM.
ds-cfg-ssl-protocol
Specifies the names of the SSL cipher suites that are allowed
for use in SSL or StartTLS communication.
Changes to this property take effect immediately but will
only impact new SSL/TLS-based sessions created after the
change.
Uses the default set of SSL cipher suites provided by the
server's JVM.
ds-cfg-ssl-cipher-suite
Specifies the maximum length of time that attempts to write data
to LDAP clients should be allowed to block.
If an attempt to write data to a client takes longer than this
length of time, then the client connection is terminated.
2 minutes
ds-cfg-max-blocked-write-time-limit