The Global Configuration contains properties that affect the overall operation of the Identity Data Store.
↓Relations from This Component
↓Properties
↓dsconfig Usage
The following components have a direct aggregation relation from Global Configurations:
The properties supported by this managed object are as follows:
| Description | Specifies a name that may be used to uniquely identify this Identity Data Store instance among other instances in the environment. If no value is provided, then the instance name will be generated as a combination of the server host name followed by a colon and some other value to help ensure that the instance name is unique. The other value added will be one of the following (in order of priority):
|
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the location for this Identity Data Store. 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 Identity Data Store must be restarted for changes to this setting to take effect. In order for this modification to take effect the server must be restarted |
| 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 | cn=Default Password Policy,cn=Password Policies,cn=config |
| Allowed Values | The DN of any Password Policy. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the maximum number of entries that the Identity Data Store 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. |
| 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 |
| Description | Specifies the maximum length of time that the Identity Data Store should be allowed to spend processing a search operation. 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. |
| 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 |
proxied-authorization-identity-mapper
| 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 | cn=Exact Match,cn=Identity Mappers,cn=config |
| 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 |
| Description | Specifies the kinds of write operations the Identity Data Store can process. |
| Default Value | enabled |
| Allowed Values | enabled - The Identity Data Store attempts to process all write operations that are requested of it, regardless of their origin. disabled - The Identity Data Store rejects all write operations that are requested of it, regardless of their origin. internal-only - The Identity Data Store attempts to process write operations requested as internal operations or through replication, but rejects any such operations requested from external clients. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the Identity Data Store 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
| 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
| Description | Indicates whether the Identity Data Store 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
| 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
| Description | Indicates whether the Identity Data Store 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 |
| Description | Specifies the maximum number of entries that the Identity Data Store 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. |
| 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 |
| Description | Specifies the set of servers that will be used to send email messages. |
| 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 |
| 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 appears only 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 |
| 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. |
| 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 |
| 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 |
| 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 stored in the administrative data of this Identity Data Store (cn=admin data). The dsframework command line utility is used to create, modify, and delete server groups (run 'dsframework --help-server-group' for more information). The special built-in server group 'all-servers' can be used to refer to all registered servers. This Identity Data Store 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 |
startup-min-replication-backlog-count
| Description | The number of outstanding changes any replica can have before the Identity Data Store will start accepting connections. The Identity Data Store may never accept connections if this setting is too low. If you are unsure which value to use, you can use the number of expected updates within a five second interval. In a replicated environment, continuous updates can be received from many servers, and the Identity Data Store may have some outstanding changes all the time. If an Identity Data Store has outstanding changes and starts accepting connections too soon, applications may receive stale data that cause them to make inappropriate choices or make updates that later create unnecessary conflicts. This setting allows you to control the decision as to when a server should be considered as caught up. The Identity Data Store gathers all the replica backlogs and checks them against this threshold. If any replica backlog is too large, the Identity Data Store will wait until all the backlogs are sufficiently small. Additionally, the local replication updates pending in the Identity Data Store must drop below this threshold as well. When all replica and local update backlogs are below the value in this setting, the Identity Data Store will start accepting connections. A value of 'unlimited' will cause the server to startup without delay and with an outstanding backlog of changes to be processed. |
| Default Value | 5000 |
| 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 |
replication-backlog-count-alert-threshold
| Description | An alert is sent when the number of outstanding replication changes for the Identity Data Store has exceeded this threshold for longer than the replication backlog duration alert threshold. |
| Default Value | 10000 |
| 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 |
replication-backlog-duration-alert-threshold
| Description | An alert is sent when the number of outstanding replication changes for the Identity Data Store has exceeded the replication backlog count alert threshold for longer than this duration. |
| Default Value | 1m |
| 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 |
| Description | The name of the replication set assigned to this Identity Data Store. Restricted domains are only replicated within instances using the same replication set name. This setting is typically used in entry-balanced deployments with the Identity Proxy, where the entries under the same base DN are distributed across multiple backend sets. Replication can provide high availability to each backend set, but replication must not propagate updates from one backend set to another. This setting should mirror the backend set configuration in the Identity Proxy. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
maximum-concurrent-connections
| Description | Specifies the maximum number of LDAP client connections which may be established to this Identity Data Store at the same time. If the maximum number of concurrent LDAP connections for this Identity Data Store 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 Identity Data Store. |
| 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
| Description | Specifies the maximum number of LDAP client connections originating from the same IP address which may be established to this Identity Data Store 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
| Description | Specifies the maximum number of LDAP client connections which may be established to this Identity Data Store 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. 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 |
| Description | Specifies the maximum amount of time the shutdown of Identity Data Store may take. Identity Data Store 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 |
maximum-concurrent-unindexed-searches
| Description | Specifies the maximum number of unindexed searches that may be in progress in this backend at any given time. Any unindexed searches requested while the maximum number of unindexed searches are already being processed will be rejected. A value of zero indicates that no limit will be enforced. |
| Default Value | 10 |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| 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 Directory 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 Identity Data Store 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 |
check-schema (Advanced Property)
| Description | Indicates whether schema enforcement is active, which is strongly advised. When schema enforcement is activated, the Identity Data Store ensures that all operations result in entries that are valid according to the defined server schema. It is strongly recommended that this option be left enabled to prevent the inadvertent addition of invalid data into the server and to avoid performance problems. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | Schema checking should only be disabled as a last resort since disabling schema checking harms performance and can lead to unexpected behavior in the server as well as the applications that access it. There are less severe options for addressing schema issues:
1. Update the data to conform to the server schema.
2. Modify the server schema to conform to the data. Contact support before modifying the server's default schema.
3. Change the single-structural-objectclass-behavior property to allow entries to have no structural object class or multiple structural object classes.
4. Change the invalid-attribute-syntax-behavior property to allow attribute values to violate their attribute syntax.
5. Change the allow-zero-length-values property of the Directory String Attribute Syntax configuration to allow attributes with this syntax to have a zero length value.
|
disable-password-policy-evaluation (Advanced Property)
| Description | Indicates whether the Identity Data Store should skip evaluation of non-essential password policy constraints |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
add-missing-rdn-attributes (Advanced Property)
| Description | Indicates whether the Identity Data Store should automatically add any attribute values contained in the entry's RDN into that entry when processing an add request. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
allow-attribute-name-exceptions (Advanced Property)
| Description | Indicates whether the Identity Data Store 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)
| Description | Specifies how the Identity Data Store should handle operations whenever an attribute value violates the associated attribute syntax. |
| Default Value | reject |
| Allowed Values | accept - The Identity Data Store silently accepts attribute values that are invalid according to their associated syntax. Matching operations targeting those values may not behave as expected. reject - The Identity Data Store rejects attribute values that are invalid according to their associated syntax. warn - The Identity Data Store 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 | None. Modification requires no further action |
server-error-result-code (Advanced Property)
| 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 |
single-structural-objectclass-behavior (Advanced Property)
| Description | Specifies how the Identity Data Store should handle operations an entry does not contain a structural object class or contains multiple structural classes. |
| Default Value | reject |
| Allowed Values | accept - The Identity Data Store 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 Identity Data Store rejects entries that do not contain exactly one structural object class. warn - The Identity Data Store 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 |
notify-abandoned-operations (Advanced Property)
| Description | Indicates whether the Identity Data Store 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 |
allowed-task (Advanced Property)
| 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 |
disabled-privilege (Advanced Property)
| 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. 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. remote-log-read - Allows the associated user access to log files on remote servers over HTTP using the LogAccessService endpoint. This endpoint allows REST clients to list the contents of specific log directories and read the contents of individual log files. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
save-config-on-successful-startup (Advanced Property)
| Description | Indicates whether the Identity Data Store should save a copy of its configuration whenever the startup process completes successfully. This ensures that the server provides a "last known good" configuration, which can be used as a reference (or copied into the active config) if the server fails to start with the current "active" configuration. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
duplicate-error-log-limit (Advanced Property)
| 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)
| 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)
| 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)
| 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 |
replication-assurance-source-timeout-suspend-duration (Advanced Property)
| Description | The amount of time a replication assurance source (i.e. a peer Identity Data Store) will be suspended from assurance requirements on this Identity Data Store if it experiences an assurance timeout. While suspended, the source will be excluded from assurance requirements for all operations originating on this Identity Data Store. This avoids the situation of repeated timeouts caused by degraded or offline servers. Once a source is suspended, it must 1) experience no timeouts for the configured duration, and 2) complete at least one assurance successfully (i.e. this Identity Data Store receives an update acknowledgement message from it within the timeout window) to be removed from suspension. Any subsequent timeouts will restart the suspension period for the source. Setting this to a lower value will ensure that assurance sources will be included sooner in the assurance requirements of this Identity Data Store after they have experienced a timeout, but increases the likelihood that they will cause subsequent timeouts. Conversely, a higher value will decrease the chance for additional timeouts, at the cost of having such sources excluded from replication assurance for a longer period of time. |
| Default Value | 10s |
| Allowed Values | A duration. Lower limit is 10 milliseconds. Upper limit is 3600000 milliseconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
replication-assurance-source-backlog-fast-start-threshold (Advanced Property)
| Description | The maximum number of replication backlog updates a replication assurance source (i.e. a peer Identity Data Store) can have and be immediately recognized as an available assurance source by this Identity Data Store. If a source connects to this server with more than the configured threshold backlog updates, it will be excluded from assurance requirements for all operations originating from this Identity Data Store until it completes at least one assurance successfully (i.e. this Identity Data Store receives an update acknowledgement message from it within the timeout window). Setting this to a lower value will decrease the chance that sources will experience an assurance timeout when connecting to this Identity Data Store as a consequence of backlog processing, but it will also make it less likely that such sources will be immediately included in assurance requirements (i.e. fast-started). A higher value makes it easier for sources to be immediately included, but increases the chance that they will experience an initial backlog related assurance timeout. |
| Default Value | 1000 |
| 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 |
forced-gc-prime-duration (Advanced Property)
| 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 |
network-address-cache-ttl (Advanced Property)
| Description | Specifies the length of time that the Identity Data Store 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 Identity Data Store and you want the server to be able to recognize those changes quickly. Restarting the Identity Data Store 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)
| Description | Specifies whether the Identity Data Store should cache the last valid IP addresses associated with the names of systems with which it interacts when the domain name service returns an unknown host exception. It may be desirable to alter this value if you want to protect the Identity Data Store 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 |
enable-sub-operation-timer (Advanced Property)
| Description | Indicates whether the Identity Data Store 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 | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
exit-on-jvm-error (Advanced Property)
| Description | Indicates whether the Identity Data Store 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 |
result-code-map (Advanced Property)
| 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 |
encrypt-data (Advanced Property)
| Description | Indicates whether the Identity Data Store should encrypt the data that it stores in all components that support it. This may include certain types of backends (including local DB and large attribute backends), the LDAP changelog, and the replication server database. If data encryption is to be enabled, then the server must have a preferred encryption settings definition. The set of available encryption settings definitions may be managed using the encryption-settings tool. For backends storing encrypted data, the entire contents of the entries will be encrypted, but indexes will not be encrypted. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | Note that enabling and/or disabling data encryption in a server that has existing data will not cause that data to be automatically encrypted or decrypted. That is, existing encrypted data will remain encrypted, and existing unencrypted data will remain unencrypted, until that data has been updated causing it to be rewritten. See the Identity Data Store documentation for information about how to safely apply the new encryption settings for all existing data. |
database-on-virtualized-or-network-storage (Advanced Property)
| Description | This option indicates whether the Identity Data Store is installed with a database on a network storage device. Enabling this feature will apply changes to all Local DB Backends, the LDAP Changelog Backend, and the replication changelog. Enabling this option will allow database files to operate properly when stored on virtualized or network storage systems such as VMware, NFS, SANs, or iSCSI. To prevent data corruption this option must be set for any backend saved to a network storage environment. If the database is on a local disk this option should not be used since it incurs a performance penalty. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | See the Identity Data Store documentation for information about how to safely apply this setting. |
encryption-settings-cipher-stream-provider (Advanced Property)
| Description | Specifies the cipher stream provider that should be used to protect the contents of the encryption settings database. |
| Default Value | If no cipher stream provider is configured, then a default provider will be used which has a hard-coded key. |
| Allowed Values | The DN of any Cipher Stream Provider. The referenced cipher stream provider must be enabled. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | If you are changing the active cipher stream provider to be a wait-for-passphrase provider, then administrative tools like dsconfig and the web administration console may appear to hang when applying the configuration change. This is because the server is actively waiting for the encryption settings database passphrase to be provided, which you should should do by running "encryption-settings supply-passphrase". You will also need to do this whenever the server is started. |
sensitive-attribute (Advanced Property)
| Description | Provides the ability to indicate that some attributes should be considered sensitive and additional protection should be in place when interacting with those attributes. Sensitive attributes may also be configured in client connection policies so that instead of applying globally, the sensitive attribute configuration will only be applied to clients associated with those client connection policies. Any sensitive attribute referenced in the global configuration will automatically apply across all client connection policies except those that specifically exclude it using the exclude-global-sensitive-attribute property. |
| Default Value | None |
| Allowed Values | The DN of any Sensitive Attribute. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
default-internal-operation-client-connection-policy (Advanced Property)
| 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 Identity Proxy). |
| 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 |
soft-delete-policy (Advanced Property)
| Description | Specifies the soft delete policy that will be used by default for delete operations. Soft delete operations introduce the ability to control the server behavior of the delete operation. Instead of performing a permanent delete of an entry, deleted entries can be retained as soft deleted entries by their entryuuid and are available for undelete at a later time. In addition to a soft delete policy enabling soft deletes, delete operations sent to the server must have the soft delete request control present with sufficient access privileges to access the soft delete request control. If no policy value is specified, the soft delete policy will effectively operate as disabled. |
| Default Value | None |
| Allowed Values | The DN of any Soft Delete Policy. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
subtree-accessibility-alert-time-limit (Advanced Property)
| Description | Specifies the length of time that a subtree may remain hidden or read-only before an administrative alert is sent. |
| Default Value | 1 hours |
| Allowed Values | A duration. Maximum unit is "hours". Lower limit is 1 minutes. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
jmx-value-behavior (Advanced Property)
| Description | Specifies how a Java type is chosen for monitor attributes exposed as JMX attribute values. With the default setting, the Identity Data Store 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 Identity Data Store infers an appropriate Java type (e.g. Boolean, Long, Float, Date, or String) from the LDAP attribute type and value. string - The Identity Data Store returns all values as String. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
allowed-insecure-tls-protocol (Advanced Property)
| 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 util 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 athttp://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)
| 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 Identity Data Store must be restarted for changes to this setting to take effect. In order for this modification to take effect the server must be restarted |
warn-for-backends-with-multiple-base-dns (Advanced Property)
| Description | Indicates whether the server should issue a warning when enabling a backend that contains multiple base DNs. While the server currently supports backends that are configured to host multiple base DNs, this may introduce complications when used in conjunction with features like replication (e.g., online initialization via binary copy is not permitted for backends with multiple base DNs). It is recommended that the server be configured with only a single base DN per backend. The ability to configure a backend with multiple base DNs may be removed at some point in the future. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
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}] ...