Directory Proxy Server Documentation Index
Configuration Reference Home

Global Configuration

The Global Configuration contains properties that affect the overall operation of the Directory Proxy Server.

↓Relations from This Component
↓Properties
↓dsconfig Usage

Relations from This Component

The following components have a direct aggregation relation from Global Configurations:

Properties

The properties supported by this managed object are as follows:


Instance Configuration Basic Properties: Advanced Properties:
↓ instance-name ↓ force-as-master-for-mirrored-data
↓ location
↓ configuration-server-group
Security Configuration Basic Properties: Advanced Properties:
↓ encrypt-backups-by-default ↓ disabled-privilege
↓ backup-encryption-settings-definition-id ↓ default-password-policy
↓ encrypt-ldif-exports-by-default ↓ verify-entry-digests
↓ ldif-export-encryption-settings-definition-id ↓ allowed-insecure-tls-protocol
↓ automatically-compress-encrypted-ldif-exports ↓ allow-insecure-local-jmx-connections
↓ reject-insecure-requests ↓ default-internal-operation-client-connection-policy
↓ allowed-insecure-request-criteria
↓ reject-unauthenticated-requests
↓ allowed-unauthenticated-request-criteria
↓ bind-with-dn-requires-password
↓ proxied-authorization-identity-mapper
Resource Limits Basic Properties: Advanced Properties:
↓ size-limit ↓ lookthrough-limit
↓ time-limit
↓ idle-time-limit
↓ ldap-join-size-limit
↓ maximum-concurrent-connections
↓ maximum-concurrent-connections-per-ip-address
↓ maximum-concurrent-connections-per-bind-dn
Schema Compliance Basic Properties: Advanced Properties:
 None ↓ allow-attribute-name-exceptions
↓ invalid-attribute-syntax-behavior
↓ permit-syntax-violations-for-attribute
↓ single-structural-objectclass-behavior
↓ external-server-schema-refresh-interval
Error Handling Basic Properties: Advanced Properties:
↓ return-bind-error-messages ↓ exit-on-jvm-error
↓ server-error-result-code
↓ result-code-map
↓ notify-abandoned-operations
↓ duplicate-error-log-limit
↓ duplicate-error-log-time-limit
↓ duplicate-alert-limit
↓ duplicate-alert-time-limit
Data Configuration Basic Properties: Advanced Properties:
 None ↓ forced-gc-prime-duration
Replication Configuration Basic Properties: Advanced Properties:
↓ replication-history-limit  None
SMTP Configuration Basic Properties: Advanced Properties:
↓ smtp-server ↓ max-smtp-connection-count
↓ max-smtp-connection-age
↓ smtp-connection-health-check-interval
Other Configuration Basic Properties: Advanced Properties:
↓ tracked-application ↓ allowed-task
↓ enable-sub-operation-timer
↓ maximum-shutdown-time
↓ network-address-cache-ttl
↓ network-address-outage-cache-enabled
↓ unique-to-single-subtree-view-search-attribute
↓ jmx-value-behavior
↓ jmx-use-legacy-mbean-names

Basic Properties

instance-name (Read-Only)

Property Group
Instance Configuration
Description
Specifies a name that may be used to uniquely identify this Directory Proxy Server instance among other instances in the environment. The instance name is used as a server's topology identifier. It must be unique across servers in a topology and cannot be changed once it is set. A good heuristic to use while choosing the instance name is to include as much information as possible about the server that is known not to change over the lifetime of the installation, such as its location and server type, and to include a monotonically increasing serial number if more than one server of a particular type needs to co-exist in a topology, e.g., Austin Server 1. Hostnames and ports may also be used to identify the server, but be aware that the instance name will not change if the machine name changes.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

location

Property Group
Instance Configuration
Description
Specifies the location for this Directory Proxy Server. Operations performed which involve communication with other servers may prefer servers in the same location to help ensure low-latency responses.
Default Value
None
Allowed Values
The DN of any Location.
Multi-Valued
No
Required
No
Admin Action Required
The Directory Proxy Server must be restarted for changes to this setting to take effect. In order for this modification to take effect the server must be restarted. This modification must also be made to the Server Instance representing this server in the topology registry. This will ensure that topology-related operations involving communication with other servers prefer servers in the same location as this server. For example, when replication data is initialized on this server using a topology file, then another server in the same location as this server will be used, if available.

configuration-server-group

Property Group
Instance Configuration
Description
When this property is set, changes made to this server using the console or dsconfig can be automatically applied to all servers in the specified server group. This property references the name of a server group in the topology registry. The dsconfig command line utility is used to create, modify, and delete server groups. The special built-in server group 'all-servers' can be used to refer to all registered servers. This Directory Proxy Server must be a member of the selected group. Furthermore, all servers in the specified group should have the same value for this property.
Default Value
Since no value is specified, configuration changes made at this server are not automatically applied to other servers.
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

encrypt-backups-by-default

Property Group
Security Configuration
Description
Indicates whether the server should encrypt backups by default. If this is true, and if a backup-encryption-settings-definition-id value is specified, then that encryption settings definition will be used to generate the encryption key for the backup.
If this is true, and if a backup-encryption-settings-definition-id value is not specified, then the server will first try to use the preferred encryption settings definition to generate the encryption key. If the server is not configured with any encryption settings definitions, then an internal key that is shared among instances in the topology will be used.
Regardless of whether this property is true or false, the default behavior can be overridden in the backup command-line tool. Providing the --encrypt argument will always cause the backup to be encrypted, even if this property has a value of false. Providing the --doNotEncrypt argument will always cause the backup to be unencrypted, even if this property has a value of true.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

backup-encryption-settings-definition-id

Property Group
Security Configuration
Description
The unique identifier for the encryption settings definition to use to generate the encryption key for encrypted backups by default. If this property is given a value, then a definition with that ID must exist in the server's encryption settings database. Use the 'encryption-settings list' command to obtain a list of the available encryption settings definitions, and 'encryption-settings create' to create a new one.
If this property is not given a value but the server is configured with at least one encryption settings definition, then the preferred definition will be used. If no encryption settings definitions are available, then the server will use an internal key shared among servers in the topology.
Regardless of whether a value is configured for this property, it can be overridden in the backup command-line tool. Providing one of the --promptForEncryptionPassphrase or --encryptionPassphraseFile arguments will cause the encryption key to be generated from the provided passphrase, while providing the --encryptionSettingsDefinitionID argument will cause the key to be generated from the specified encryption settings definition.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

encrypt-ldif-exports-by-default

Property Group
Security Configuration
Description
Indicates whether the server should encrypt LDIF exports by default. If this is true, and if an ldif-export-encryption-settings-definition-id value is specified, then that encryption settings definition will be used to generate the encryption key for the export.
If this is true, and if an ldif-export-encryption-settings-definition-id value is not specified, then the server will first try to use the preferred encryption settings definition to generate the encryption key. If the server is not configured with any encryption settings definitions, then an internal key that is shared among instances in the topology will be used.
Regardless of whether this property is true or false, the default behavior can be overridden in the export-ldif command-line tool. Providing the --encryptLDIF argument will always cause the export to be encrypted, even if this property has a value of false. Providing the --doNotEncryptLDIF argument will always cause the export to be unencrypted, even if this property has a value of true.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

ldif-export-encryption-settings-definition-id

Property Group
Security Configuration
Description
The unique identifier for the encryption settings definition to use to generate the encryption key for encrypted LDIF exports by default. If this property is given a value, then a definition with that ID must exist in the server's encryption settings database. Use the 'encryption-settings list' command to obtain a list of the available encryption settings definitions, and 'encryption-settings create' to create a new one.
If this property is not given a value but the server is configured with at least one encryption settings definition, then the preferred definition will be used. If no encryption settings definitions are available, then the server will use an internal key shared among servers in the topology.
Regardless of whether a value is configured for this property, it can be overridden in the export-ldif command-line tool. Providing one of the --promptForEncryptionPassphrase or --encryptionPassphraseFile arguments will cause the encryption key to be generated from the provided passphrase, while providing the --encryptionSettingsDefinitionID argument will cause the key to be generated from the specified encryption settings definition.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

automatically-compress-encrypted-ldif-exports

Property Group
Security Configuration
Description
Indicates whether to automatically compress LDIF exports that are also encrypted. If this is true, then any LDIF export that is encrypted (whether explicitly via the --encryptLDIF command-line argument or implicitly via the encrypt-ldif-exports-by-default configuration property) will also be gzip-compressed, without the need for the --compress command-line argument. If this is false, then encrypted LDIF exports will not automatically be compressed, but they may still be manually compressed using the --compress command-line argument.
This setting has no effect on LDIF exports that are not encrypted. It also does not have any effect on the command-line arguments needed when performing an LDIF import because the import process will automatically detect whether the LDIF file is encrypted and/or compressed.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

reject-insecure-requests

Property Group
Security Configuration
Description
Indicates whether the Directory Proxy Server should reject any LDAP request (other than StartTLS) received from a client that is not using an encrypted connection.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

allowed-insecure-request-criteria

Property Group
Security Configuration
Description
A set of criteria that may be used to match LDAP requests that may be permitted over an insecure connection even if reject-insecure-requests is true. Note that some types of requests will always be permitted, including StartTLS and start administrative session requests.
Default Value
None
Allowed Values
The DN of any Request Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

reject-unauthenticated-requests

Property Group
Security Configuration
Description
Indicates whether the Directory Proxy Server should reject any LDAP request (other than bind or StartTLS requests) received from a client that has not yet been authenticated, whose last authentication attempt was unsuccessful, or whose last authentication attempt used anonymous authentication.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

allowed-unauthenticated-request-criteria

Property Group
Security Configuration
Description
A set of criteria that may be used to match LDAP requests that may be permitted over an unauthenticated connection even if reject-unauthenticated-requests is true. Note that some types of requests will always be permitted, including bind, StartTLS, and start administrative session requests.
Default Value
None
Allowed Values
The DN of any Request Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

bind-with-dn-requires-password

Property Group
Security Configuration
Description
Indicates whether the Directory Proxy Server should reject any simple bind request that contains a DN but no password. Although such bind requests are technically allowed by the LDAPv3 specification (and should be treated as anonymous simple authentication), they may introduce security problems in applications that do not verify that the client actually provided a password.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

proxied-authorization-identity-mapper

Property Group
Security Configuration
Description
Specifies the name of the identity mapper to map authorization ID values (using the "u:" form) provided in the proxied authorization control to the corresponding user entry.
Default Value
Exact Match
Allowed Values
The DN of any Identity Mapper. The referenced identity mapper must be enabled.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

size-limit

Property Group
Resource Limits
Description
Specifies the maximum number of entries that the Directory Proxy Server should return to the client during a search operation. A value of 0 indicates that no size limit is enforced. Note that this is the default server-wide limit, but it may be overridden on a per-user basis using the ds-rlim-size-limit operational attribute.
If a search operation would return more entries than allowed by the size limit in effect for that operation, the server will return up to that maximum number of entries, and will then return a search result done message with a "size limit exceeded" (integer value 4) result code.
Default Value
1000
Allowed Values
An integer value. Lower limit is 0.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

time-limit

Property Group
Resource Limits
Description
Specifies the maximum length of time that the Proxy should be allowed to spend processing a search operation. This primarily applies to operations processed locally, but may be used in computing the time limit included in search requests forwarded to backend servers. Other operation timeouts (e.g., as defined in the load-balancing algorithm configuration) may still apply to interrupt forwarded search operations before this time limit is reached. A value of 0 seconds indicates that no time limit is enforced. Note that this is the default server-wide time limit, but it may be overridden on a per-user basis using the ds-rlim-time-limit operational attribute.
If a search operation cannot be completed within the time limit in effect for that operation, the server will return any matching entries identified within that time limit, and will then return a search result done message with a "time limit exceeded" (integer value 3) result code.
Default Value
60 seconds
Allowed Values
A duration. Lower limit is 0 seconds.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

idle-time-limit

Property Group
Resource Limits
Description
Specifies the maximum length of time that a client connection may remain established since its last completed operation. A value of "0 seconds" indicates that no idle time limit is enforced. Note that this is the default server-wide idle time limit, but it may be overridden on a per-user basis using the ds-rlim-idle-time-limit operational attribute.
Default Value
0 seconds
Allowed Values
A duration. Lower limit is 0 milliseconds.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

ldap-join-size-limit

Property Group
Resource Limits
Description
Specifies the maximum number of entries that may be directly joined with any individual search result entry. A value of 0 indicates that no LDAP join size limit is enforced. Note that this is the default server-wide limit, but it may be overridden on a per-user basis using the ds-rlim-ldap-join-size-limit operational attribute. The LDAP join size limit will also be restricted by the search operation size limit (i.e., the maximum number of search result entries that may be returned for the operation).
If a search result entry would be joined with more entries than allowed by the LDAP join size limit, then the join result control will have a "size limit exceeded" (integer value 4) result code, and may or may not include any matching entries identified before the size limit was reached.
Default Value
10000
Allowed Values
An integer value. Lower limit is 0.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

maximum-concurrent-connections

Property Group
Resource Limits
Description
Specifies the maximum number of LDAP client connections which may be established to this Directory Proxy Server at the same time. If the maximum number of concurrent LDAP connections for this Directory Proxy Server has been reached, then any subsequent connection attempts will be rejected until an existing client connection has been closed.
A value of zero indicates that no limit will be imposed on the number of concurrent connections that may be established to this Directory Proxy Server.
Default Value
0
Allowed Values
An integer value. Lower limit is 0.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

maximum-concurrent-connections-per-ip-address

Property Group
Resource Limits
Description
Specifies the maximum number of LDAP client connections originating from the same IP address which may be established to this Directory Proxy Server at the same time. If the maximum number of concurrent LDAP connections from the same client address has been reached, then any subsequent connection attempts from that client will be rejected until an existing connection from that same address has been closed.
A value of zero indicates that no limit will be imposed on the number of concurrent connections from the same client address.
Default Value
0
Allowed Values
An integer value. Lower limit is 0.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

maximum-concurrent-connections-per-bind-dn

Property Group
Resource Limits
Description
Specifies the maximum number of LDAP client connections which may be established to this Directory Proxy Server at the same time and authenticated as the same user. If the maximum number of concurrent LDAP connections authenticated as the same user has been reached, then any subsequent attempts to authenticate as that user will cause the associated client connection to be terminated. New connection attempts from that client will be rejected until an existing connection from that same address has been closed.
A value of zero indicates that no limit will be imposed on the number of concurrent connections from the same client address.
Default Value
0
Allowed Values
An integer value. Lower limit is 0.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

return-bind-error-messages

Property Group
Error Handling
Description
Indicates whether responses for failed bind operations should include a message string providing the reason for the authentication failure. Note that these messages may include information that could potentially be used by an attacker. If this option is disabled, then these messages only appear in the server's access log.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

replication-history-limit

Property Group
Replication Configuration
Description
Specifies the size limit for historical information. Historical information, which is used for replication conflict resolution, is stored in the operational attribute ds-sync-hist. This property can be used to limit the size of that attribute.
Default Value
None
Allowed Values
An integer value. Lower limit is 0.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

smtp-server

Property Group
SMTP Configuration
Description
Specifies the set of servers that will be used to send email messages. The order in which the servers are listed indicates the order in which the Directory Proxy Server will attempt to use them in the course of sending a message. The first attempt will always go to the server at the top of the list, and servers further down the list will only be used if none of the servers listed above it were able to successfully send the message.
Default Value
If no values are defined, then the server cannot send email via SMTP.
Allowed Values
The DN of any SMTP External Server.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

tracked-application

Property Group
Other Configuration
Description
Specifies criteria for identifying specific applications that access the server to enable tracking throughput and latency of LDAP operations issued by an application. This property allows individual applications to be identified in the server by connection criteria. The name of the connection criteria configuration object is used within the server as the name of the application. The list of criteria is ordered, so the first criteria that a connection matches will be used to identify the application. Unidentified Proxy Application will be used for connections that do not match any of the criteria.
Defining per-application connection criteria here is used primarily to track throughput and latency of LDAP operations on a per-application basis, but other configuration changes are necessary to take advantage of this. The separate-monitor-entry-per-tracked-application setting on the Processing Time Histogram Plugin configuration object must be set to expose per-application monitoring information under cn=monitor. The per-application-ldap-stats and included-ldap-application settings on the Periodic Stats Logger Plugin can also be set to log per-application statistics to a csv file on a periodic basis. Consult the product documentation for more details on configuring the Directory Proxy Server to track LDAP statistics on a per application basis.
Default Value
None
Allowed Values
The DN of any Connection Criteria.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


Advanced Properties

force-as-master-for-mirrored-data (Advanced Property)

Property Group
Instance Configuration
Description
Indicates whether this server should be forced to assume the master role if no other suitable server is found to act as master or if multiple masters are detected. A master is only needed when changes are made to mirrored data, i.e. data specific to the topology itself and cluster-wide configuration data. To ensure data consistency, changes to mirrored data are automatically routed to a single master server. This server is typically chosen dynamically, but this requires a majority of servers to be visible to the master. This avoids having multiple masters when there is a network partition, which could lead to data inconsistency. This flag exists to provide a fail-safe for the case when no suitable master is found for the mirrored data or if each server in the topology has a different view of which server is its current master. Having no master is bad because it indicates that there is no server in the topology that can reach a quorum majority of servers and is usually indicative of network problems which should be addressed immediately. Having multiple masters is bad because it can result in divergent changes requiring manual merging and possibly conflict resolution. This flag should be set to true on exactly one of the servers in the entire topology in exceptional situations such as prolonged network partitions. If it is set to true on more than one server and a situation arises that causes more than one server to be forced as master, then a critical alarm will be raised and all masters will once again be made non-masters.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
When set to true, this server will forcibly be assigned the role of master if no suitable master is found or multiple masters are detected in the topology. This flag must be set to true on exactly one server in the topology, but it is important to set it if updates to mirrored data need to be supported while no master could be selected because a majority of servers is not available. In other words, without a master the topology will become read-only and all updates rejected. The server on which this flag is set should be chosen with care. A server that is in a highly-available data center with redundant networks would make an ideal candidate to force as master if necessary.

disabled-privilege (Advanced Property)

Property Group
Security Configuration
Description
Specifies the name of a privilege that should not be evaluated by the server. If a privilege is disabled, then it is assumed that all clients (including unauthenticated clients) have that privilege.
Default Value
If no values are defined, then the server enforces all privileges.
Allowed Values
audit-data-security - Allows the associated user to execute data security auditing tasks.

bypass-acl - Allows the associated user to bypass all access control checks performed by the server for any type of operation.

bypass-read-acl - Allows the associated user to bypass access control checks performed by the server for bind, compare, and search operations. Access control evaluation may still be enforced for other types of operations.

modify-acl - Allows the associated user to modify the server's access control configuration.

config-read - Allows the associated user to read the server configuration.

config-write - Allows the associated user to update the server configuration. The config-read privilege is also required.

jmx-read - Allows the associated user to perform JMX read operations.

jmx-write - Allows the associated user to perform JMX write operations.

jmx-notify - Allows the associated user to subscribe to receive JMX notifications.

ldif-import - Allows the user to request that the server process LDIF import tasks.

ldif-export - Allows the user to request that the server process LDIF export tasks.

backend-backup - Allows the user to request that the server process backup tasks.

backend-restore - Allows the user to request that the server process restore tasks.

server-shutdown - Allows the user to request that the server shut down.

server-restart - Allows the user to request that the server perform an in-core restart.

proxied-auth - Allows the user to use the proxied authorization control, or to perform a bind that specifies an alternate authorization identity.

disconnect-client - Allows the user to terminate other client connections.

password-reset - Allows the user to reset user passwords.

update-schema - Allows the user to make changes to the server schema.

privilege-change - Allows the user to make changes to the set of defined root privileges, as well as to grant and revoke privileges for users.

unindexed-search - Allows the user to request that the server process a search that cannot be optimized using server indexes.

unindexed-search-with-control - Allows the user to request that the server process a search that cannot be optimized using server indexes but includes the permit unindexed search request control.

bypass-pw-policy - Allows the associated user to bypass password policy processing performed by the server.

lockdown-mode - Allows the associated user to request that the server enter or leave lockdown mode, or to perform operations while the server is in lockdown mode.

stream-values - Allows the associated user to perform a stream values extended operation to obtain all entry DNs and/or all values for one or more attributes for a specified portion of the DIT.

third-party-task - Allows the associated user to invoke tasks created by third-party developers.

use-admin-session - Allows the associated user to use an administrative session to request that operations be processed using a dedicated pool of worker threads.

soft-delete-read - Allows the associated user access to soft-deleted entries.

metrics-read - Allows the associated user access to data in the metrics backend.

manage-topology - Allows the associated user to manage the set of server instances that are part of a topology.

permit-get-password-policy-state-issues - Allows the associated user to issue a bind request that includes the get password policy state issues request control. The bind request must also include the retain identity request control.

permit-proxied-mschapv2-details - Allows the associated user to issue a bind request that includes the proxied MS-CHAPv2 details request control. The bind request must also include the retain identity request control.

permit-externally-processed-authentication - Allows the associated user to issue a SASL bind request using the UNBOUNDID-EXTERNALLY-PROCESSED-AUTHENTICATION mechanism.

permit-forwarding-client-connection-policy - Allows the associated user to request that an operation be processed using a specified client connection policy.

exec-task - Allows the associated user to schedule an exec task.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

default-password-policy (Advanced Property)

Property Group
Security Configuration
Description
Specifies the name of the password policy that is in effect for users whose entries do not specify an alternate password policy (either via a real or virtual attribute).
Default Value
Default Password Policy
Allowed Values
The DN of any Password Policy.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

verify-entry-digests (Advanced Property)

Property Group
Security Configuration
Description
Indicates whether the digest should always be verified whenever an entry containing a digest is decoded. If this is "true", then if a digest exists, it will always be verified. Otherwise, the digest will be written when encoding entries but ignored when decoding entries but may still be available for other verification processing.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

allowed-insecure-tls-protocol (Advanced Property)

Property Group
Security Configuration
Description
Specifies a set of TLS protocols that will be permitted for use in the server even though there may be known vulnerabilities that could cause their use to be unsafe in some conditions. Enabling support for insecure TLS protocols is discouraged, and is generally recommended only as a short-term measure to permit legacy clients to interact with the server until they can be updated to support more secure communication protocols.
Default Value
No known-insecure TLS protocols will be allowed by default.
Allowed Values
sslv3 - Allow TLS communication secured with SSLv3. There are known vulnerabilities that can allow a network attacker to compute the plaintext of an SSLv3-encrypted session, as described at http://googleonlinesecurity.blogspot.com/2014/10/this-poodle-bites-exploiting-ssl-30.html.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

allow-insecure-local-jmx-connections (Advanced Property)

Property Group
Security Configuration
Description
Indicates that processes attaching to this server's local JVM are allowed to access internal data through JMX without the authentication requirements that remote JMX connections are subject to. Please review and understand the data that this option will expose (such as cn=monitor) to client applications to ensure there are no security concerns.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
The Directory Proxy Server must be restarted for changes to this setting to take effect. In order for this modification to take effect the server must be restarted

default-internal-operation-client-connection-policy (Advanced Property)

Property Group
Security Configuration
Description
Specifies the client connection policy that will be used by default for internal operations. If no value is specified, a private internal client connection policy will be used which includes access to all local backends but will not have knowledge of subtree views not associated with local backends (e.g., those which may be used to access backend servers in the Directory Proxy Server).
Default Value
None
Allowed Values
The DN of any Client Connection Policy. The referenced client connection policy must be enabled.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

lookthrough-limit (Advanced Property)

Property Group
Resource Limits
Description
Specifies the maximum number of entries that the Directory Proxy Server should "look through" in the course of processing a search request. This includes any entry that the server must examine in the course of processing the request, regardless of whether it actually matches the search criteria. A value of 0 indicates that no lookthrough limit is enforced. Note that this is the default server-wide limit, but it may be overridden on a per-user basis using the ds-rlim-lookthrough-limit operational attribute.
If a search operation would require examining more entries than allowed by the lookthrough limit in effect for that operation, the server may or may not return any matching entries identified before the limit is reached, and will then return a search result done message with an "administrative limit exceeded" (integer value 11) result code.
Default Value
5000
Allowed Values
An integer value. Lower limit is 0.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

allow-attribute-name-exceptions (Advanced Property)

Property Group
Schema Compliance
Description
Indicates whether the Directory Proxy Server should allow underscores in attribute names and allow attribute names to begin with numeric digits (both of which are violations of the LDAP standards).
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

invalid-attribute-syntax-behavior (Advanced Property)

Property Group
Schema Compliance
Description
Specifies how the Directory Proxy Server should handle operations whenever an attribute value violates the associated attribute syntax.
Default Value
reject
Allowed Values
accept - The Directory Proxy Server silently accepts attribute values that are invalid according to their associated syntax. Matching operations targeting those values may not behave as expected.

reject - The Directory Proxy Server rejects attribute values that are invalid according to their associated syntax.

warn - The Directory Proxy Server accepts attribute values that are invalid according to their associated syntax, but also logs a warning message to the error log. Matching operations targeting those values may not behave as expected.
Multi-Valued
No
Required
No
Admin Action Required
DEPRECATION NOTE: The wholesale option to allow attribute values to violate their associated syntax has been deprecated. This is a very broad option and permits inadvertent corruption of the data over time. If you are trying to import legacy data with syntax violations, or if you have applications that may attempt to store values that violate the associated attribute syntax, then the recommended options to address this are as follows: * Update the legacy data so that all attribute values conform to the associated syntax, and update any applications that are known to try to store invalid values. * Modify the server schema to specify an alternate syntax for the attribute types for which there are known syntax violations. If there are indexes defined for any of the updated attribute types, then those indexes must be rebuilt. This option is only recommended for custom schema elements that are not shipped with the server. * Use the permit-syntax-violations-for-attribute property to specify the attribute types for which the server should allow non-compliant values. The permit-syntax-violations-for-attribute property should only be used if neither of the above options are possible, and you should be aware that the server may behave in unexpected ways when interacting with values that do not fit the constraints expected by the associated attribute syntax or matching rules.

permit-syntax-violations-for-attribute (Advanced Property)

Property Group
Schema Compliance
Description
Specifies a set of attribute types for which the server will permit values that do not conform to the associated attribute syntax. Note that while this option may allow the server to accept values that would normally be rejected because they violate syntax constraints, the server may behave in unexpected ways if it attempts to interact with values that do not conform to the constraints expected by the associated attribute syntax or matching rules.
If you have existing data that contains attribute syntax violations, or if you have applications that may try to store malformed data, then it is recommended that you update the data and any applications to be in compliance with the existing definitions, or that you update the schema definitions to specify an alternate syntax for the affected attribute types. The permit-syntax-violations-for-attribute property should only be used as a last resort when neither of the alternatives can be used.
Default Value
None
Allowed Values
The name or OID of an attribute type defined in the server schema.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

single-structural-objectclass-behavior (Advanced Property)

Property Group
Schema Compliance
Description
Specifies how the Directory Proxy Server should handle operations for an entry does not contain a structural object class, or for an entry that contains multiple structural classes.
Default Value
reject
Allowed Values
accept - The Directory Proxy Server silently accepts entries that do not contain exactly one structural object class. Certain schema features that depend on the entry's structural class may not behave as expected.

reject - The Directory Proxy Server rejects entries that do not contain exactly one structural object class.

warn - The Directory Proxy Server accepts entries that do not contain exactly one structural object class, but also logs a warning message to the error log. Certain schema features that depend on the entry's structural class may not behave as expected.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

external-server-schema-refresh-interval (Advanced Property)

Property Group
Schema Compliance
Description
The maximum length of time between attempts to refresh the schema from external servers.
Default Value
5 minutes
Allowed Values
A duration. Lower limit is 1 milliseconds.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

exit-on-jvm-error (Advanced Property)

Property Group
Error Handling
Description
Indicates whether the Directory Proxy Server should be shut down if a severe error is raised (e.g., an out of memory error) which may prevent the JVM from continuing to run properly.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

server-error-result-code (Advanced Property)

Property Group
Error Handling
Description
Specifies the numeric value of the result code when request processing fails due to an internal server error.
Default Value
80
Allowed Values
An integer value. Lower limit is 0.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

result-code-map (Advanced Property)

Property Group
Error Handling
Description
Specifies a result code map that should be used for clients that do not have a map associated with their client connection policy. If the associated client connection policy has a result code map, then that map will be used instead. If no map is associated either with the client connection policy or the global configuration, then an internal default will be used.
Default Value
None
Allowed Values
The DN of any Result Code Map.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

notify-abandoned-operations (Advanced Property)

Property Group
Error Handling
Description
Indicates whether the Directory Proxy Server should send a response to any operation that is interrupted via an abandon request. The LDAP specification states that abandoned operations should not receive any response, but this may cause problems with client applications that always expect to receive a response to each request.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

duplicate-error-log-limit (Advanced Property)

Property Group
Error Handling
Description
Specifies the maximum number of duplicate error log messages that should be logged in the time window specified by the duplicate-error-log-time-limit property. This property works in conjunction with duplicate-error-log-time-limit to prevent duplicate log messages from filling up the error log. For instance, a misbehaving client might cause the server to generate many duplicate error log messages because each operation it sends is malformed.
With the default value of 5 duplicates every 10 seconds, a specific log message will appear at most 6 times in any 10 second window -- once for the original message plus five more duplicates. After this limit is reached, the server will keep track of the number of additional duplicate messages logged during this interval.
If when the time limit expires, this count is greater than zero, it will log an additional message including the original message and the number of additional times it was suppressed.
A value of "unlimited" implies that the server should not suppress any duplicate messages.
The number of duplicate messages is reset each time the server restarts.
See also the duplicate-alert-limit property which serves the same purpose for administrative alerts.
Default Value
200
Allowed Values
An integer value. Lower limit is 0. A value of "-1" or "unlimited" for no limit.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

duplicate-error-log-time-limit (Advanced Property)

Property Group
Error Handling
Description
Specifies the length of time that must expire before duplicate log messages above the duplicate-error-log-limit threshold are logged again to the error log. This property works in conjunction with duplicate-error-log-limit to prevent duplicate log messages from filling up the error log. See the description of that property for more details. See also the duplicate-alert-time-limit property which serves the same purpose for administrative alerts.
Default Value
5 minutes
Allowed Values
A duration. Maximum unit is "hours". Lower limit is 1 seconds.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

duplicate-alert-limit (Advanced Property)

Property Group
Error Handling
Description
Specifies the maximum number of duplicate alert messages that should be sent via the administrative alert framework in the time window specified by the duplicate-alert-time-limit property. This property works in conjunction with duplicate-alert-time-limit to prevent duplicate alert messages from overloading an email server or filling up an administrator's inbox. For instance, a series of duplicate alerts might be sent by the logging framework if the file system fills up -- each audit log message will fail to be written and an alert will be generated. With this duplicate suppression enabled, only the first few alert messages will be sent.
With the default value of 20 duplicates every 1 hour, a specific alert message will be sent at most 21 times in any 1 hour period -- once for the original message plus twenty more duplicates. After this limit is reached, the server will keep track of the number of additional duplicate alert messages during this interval.
If when the time limit expires, this count is greater than zero, it will send an additional alert message including the original message and the number of additional times it was suppressed.
A value of "unlimited" implies that the server should not suppress any duplicate messages.
The number of duplicate messages is reset each time the server restarts.
See also the duplicate-error-log-limit property which serves the same purpose for messages written to the error log.
Default Value
10
Allowed Values
An integer value. Lower limit is 0. A value of "-1" or "unlimited" for no limit.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

duplicate-alert-time-limit (Advanced Property)

Property Group
Error Handling
Description
Specifies the length of time that must expire before duplicate messages are sent via the administrative alert framework. This property works in conjunction with duplicate-alert-limit to prevent duplicate alert messages from being sent too frequently. See the description of that property for more details. See also the duplicate-error-log-time-limit property which serves the same purpose for messages written to the error log.
Default Value
10 minutes
Allowed Values
A duration. Maximum unit is "hours". Lower limit is 1 seconds.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

forced-gc-prime-duration (Advanced Property)

Property Group
Data Configuration
Description
Specifies the minimum length of time required for backend or request processor initialization that will trigger the server to force an explicit garbage collection. A value of "0 seconds" indicates that the server should never invoke an explicit garbage collection regardless of the length of time required to initialize the server backends. Invoking an explicit garbage collection after backend or request processor priming has completed may allow the server to exhibit better and more consistent behavior after startup because information stored in the tenured generation will be organized in a more compact manner.
Default Value
10 seconds
Allowed Values
A duration. Lower limit is 0 milliseconds.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

max-smtp-connection-count (Advanced Property)

Property Group
SMTP Configuration
Description
The maximum number of SMTP connections that will be maintained for delivering email messages.
Default Value
5
Allowed Values
An integer value. Lower limit is 1.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

max-smtp-connection-age (Advanced Property)

Property Group
SMTP Configuration
Description
The maximum length of time that a connection to an SMTP server should be considered valid.
Default Value
Connections will not automatically be closed after a set period of time.
Allowed Values
A duration. Lower limit is 0 milliseconds.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

smtp-connection-health-check-interval (Advanced Property)

Property Group
SMTP Configuration
Description
The length of time between checks to ensure that available SMTP connections are still valid.
Default Value
60s
Allowed Values
A duration. Lower limit is 0 milliseconds.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

allowed-task (Advanced Property)

Property Group
Other Configuration
Description
Specifies the fully-qualified name of a Java class that may be invoked in the server. Any attempt to invoke a task not included in the list of allowed tasks is rejected.
Default Value
If no values are defined, then the server does not allow any tasks to be invoked.
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

enable-sub-operation-timer (Advanced Property)

Property Group
Other Configuration
Description
Indicates whether the Directory Proxy Server should attempt to record information about the length of time required to process various phases of an operation. Enabling this feature may impact performance, but could make it easier to identify potential bottlenecks in operation processing.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

maximum-shutdown-time (Advanced Property)

Property Group
Other Configuration
Description
Specifies the maximum amount of time the shutdown of Directory Proxy Server may take. Directory Proxy Server can usually shutdown in a short amount of time. If the shutdown was received while long running database operations are active, then instances that are busy or that have large database backends may require more time to stop. Stopping these operations prematurely may result in a significantly longer startup time.
To avoid a potentially long time required for a subsequent startup, increase the maximum time allowed for shutdown to complete.
Default Value
5 minutes
Allowed Values
A duration. Lower limit is 60 seconds.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

network-address-cache-ttl (Advanced Property)

Property Group
Other Configuration
Description
Specifies the length of time that the Directory Proxy Server should cache the IP addresses associated with the names of systems with which it interacts. It may be desirable to alter this value if you expect to change the IP address(es) associated with the names of systems referenced by the Directory Proxy Server and you want the server to be able to recognize those changes quickly. Restarting the Directory Proxy Server would also allow it to recognize address changes.
A value of "0 seconds" should be used to indicate that no caching should be performed.
Default Value
3600 seconds
Allowed Values
A duration. Lower limit is 0 seconds.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

network-address-outage-cache-enabled (Advanced Property)

Property Group
Other Configuration
Description
Specifies whether the Directory Proxy Server should cache the last valid IP addresses associated with the names of systems with which it interacts with when the domain name service returns an unknown host exception. Java may return an unknown host exception when there is unexpected interruption in domain name service so this setting protects the Directory Proxy Server from temporary DNS server outages if previous results have been cached. It may not be desirable to alter this value if you want to protect the Directory Proxy Server from unexpected interruptions in domain name services.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

unique-to-single-subtree-view-search-attribute (Advanced Property)

Property Group
Other Configuration
Description
Provides the ability for the Directory Proxy Server to optimize equality searches for attributes with unique values when a search operation spans multiple subtree views. This requires that each value for an attribute listed here must appear in only one subtree view. This can help to reduce proxying searches to servers that do not contain data that matches the search. The global index provides this capability when a search is based at the entry balancing point, but in environments that include multiple subtree views that are subordinate to a single search base, all subtree views will be searched. If an attribute has values that are known to be unique to all subtree views, then listing it here has two benefits: 1) if a global index on an entry balancing request processor contains values for this attribute, then that subtree view is searched first, and 2) once one or more entries are returned from any subtree view, no more subtree views are searched.
Default Value
None
Allowed Values
The name or OID of an attribute type defined in the server schema.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

jmx-value-behavior (Advanced Property)

Property Group
Other Configuration
Description
Specifies how a Java type is chosen for monitor attributes exposed as JMX attribute values. With the default setting, the Directory Proxy Server infers an appropriate Java type from the LDAP attribute type and value. The type is determined dynamically and in theory could change from one invocation to the next. For example, an attribute could be a Long in one call and then a Float in the next. Integer syntax values are returned as Long, Boolean syntax as Boolean, and GeneralizedTime syntax as Date. String syntax values that can be parsed as floating point numbers are returned as Float, and values that can be parsed as integers are returned as Long. In all other cases, values are returned as String.
Default Value
inferred
Allowed Values
inferred - The Directory Proxy Server infers an appropriate Java type (e.g. Boolean, Long, Float, Date, or String) from the LDAP attribute type and value.

string - The Directory Proxy Server returns all values as String.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

jmx-use-legacy-mbean-names (Advanced Property)

Property Group
Other Configuration
Description
When set to true, the server will use its original, non-standard JMX MBean names for the monitoring MBeans. These include RDN keys of "Rdn1" and "Rdn2" instead of the recommended "type" and "name" keys. This should option should only be enabled for installations that have monitoring infrastructure that depends on the old keys.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
The Directory Proxy Server must be restarted for changes to this setting to take effect. In order for this modification to take effect the server must be restarted


dsconfig Usage

To view the Global Configuration configuration:

dsconfig get-global-configuration-prop
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the Global Configuration configuration:

dsconfig set-global-configuration-prop
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...