A java class that implements or extends the class(es) :
org.opends.server.api.Extension
Multi-valued
No
Required
Yes
Admin Action Required
The LDAP Server Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
Yes
Read-only
No
monitoring-check-interval
Description
Proactive monitoring check interval. This is an interval in milliseconds.
Default Value
30000
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
monitoring-connect-timeout
Description
Maximum time the proactive monitoring attemps to connect to the remote server before the connections fails. 0 means unlimited. This is an integer which represents the interval in milliseconds.
Default Value
5000
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
monitoring-inactivity-timeout
Description
Time after which a connection is checked to avoid connection closure by the remote server. The value of this parameter must be superior to monitoring-check-interval. This is an integer which represents the interval in milliseconds.
Default Value
120000
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
monitoring-ping-timeout
Description
Maximum time the proactive monitoring attemps to ping the remote server. This is an integer which represents the interval in milliseconds.
Default Value
5000
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
pool-increment
Description
Increment by which the size of a connection pool is increased or decreased. If remote-ldap-server-ssl-policy is set to 'user', two pools are created and the incremental change of size of each pool is set to pool-increment. This is an integer.
Default Value
5
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
pool-initial-size
Description
Initial size of a connection pool: this is the initial number of connections to be created when a pool is initialized. This is also the minimum size of a pool. If remote-ldap-server-ssl-policy is set to 'user', two pools are created and the initial size of each pool is set to pool-initial-size. This is an integer.
Default Value
10
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
pool-max-size
Description
Maximum size of a connection pool: this is the maximum number of connections a pool can allocate. If remote-ldap-server-ssl-policy is set to 'user', two pools are created and the maximum size of each pool is set to pool-max-size. This is an integer.
Default Value
1000
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
pool-max-write
Description
Maximum number of write connections a connection pool can allocate at the same time. This is an integer. This parameter is taken into account only if pool-use-max-write is set to 'true'.
Default Value
0
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
pool-release-connection-interval
Description
Time after which the connection pool size can be reduced if enough connections are not used: if pool-increment connections or more are not used during pool-release-connection-interval, then these connections are removed from the pool. This is an integer which represents the interval in milliseconds.
Default Value
300000
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
pool-use-max-write
Description
Indicates if the parameter pool-max-write is used. If true, the parameter pool-max-write is taken into account.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
proxied-auth-use-v1
Description
If true, proxy authorization control V1 is used, otherwise V2 is used. true or false.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
remote-ldap-server-connect-timeout
Description
Maximum time the proactive monitoring attemps to connect to the remote server before the connection fails. 0 means unlimited. This is an integer which represents the interval in milliseconds.
Default Value
10000
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
remote-ldap-server-read-only
Description
Indicates if the remote server is read-only. If set to true, all write operations are rejected by this LDAP Server Extension. True or false.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
remote-ldap-server-read-timeout
Description
Maximum time the LDAP Server Extension waits for a response from the remote server before the connection fails. 0 means unlimited. This is an integer which represents the interval in milliseconds.
Default Value
10000
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
remote-ldap-server-ssl-policy
Description
Specifies the security policy to apply to the LDAP server. Possible values are "always", "never" and "user".
Default Value
never
Allowed Values
always - SSL is always used to connect to the LDAP server. Only one pool of secure connections is created in this case.
never - SSL is never used to connect to the LDAP server. Only one pool of unsecure connections is created in this case.
user - SSL is used based on the client connection: if the client connection is secure, the connection between this LDAP Server Extension and the LDAP server will be secure, otherwise it will be unsecure. Two connection pools are created in this case: one pool for handling secure connections, and another pool for unsecure connections. The parameters pool-initial-size, pool-max-size and pool-increment apply separately to each pool. For instance, if pool-initial-size is set to 10, then 20 connections are created: 10 for the secure pool, and 10 for the unsecure pool. Similarly, if pool-max-size is set to 100, up to 200 connections may be created.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
Yes
Read-only
No
remote-ldap-server-ssl-port
Description
Specifies the secured port to connect to the LDAP server. This must be a valid port number.
Default Value
636
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
Yes
Read-only
No
saturation-precision
Description
The precision specifies the minimum value for the saturation index change to be taken into account. When the saturation index of the LDAP Server Extension changes, a notification is sent only if the change is significant enough. The value is expressed as a percentage. For instance, if the previous index was 15% and is now 18%, with a precision set to 5%, no notification is sent (because 18% - 15% = 3%, which is less than 5%).
Default Value
5
Allowed Values
An integer value. Lower value is 0. Upper value is 100 .
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
ssl-client-alias
Description
Specifies the alias to use for the client private key. A string which represents the alias to look up in the keystore.
Default Value
None
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
ssl-key-manager-provider
Description
Specifies key manager provider to use for the LDAP Server Extension. This key manager provider is not mandatory and may be used if the remote server is configured for client authentication. The referenced key manager provider must be enabled.
Specifies to trust all remote servers. True or false.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
ssl-trust-manager-provider
Description
Specifies trust manager provider to use for the LDAP Server Extension. This trust manager provider is mandatory unless the parameter ssl-trust-all is set to true. The referenced trust manager provider must be enabled.