Data Sync Server Documentation Index
Configuration Reference Home

Exec Alert Handler

The Exec Alert Handler may be used to execute a specified command on the local system if an administrative alert matching the criteria for this alert handler is generated by this Data Sync Server.

Information about the administrative alert will be made available to the executed application as arguments provided to the command. Those values will be provided in the following order:

Parent Component
Properties
dsconfig Usage

Parent Component

The Exec Alert Handler component inherits from the Alert Handler

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ asynchronous
↓ enabled-alert-severity
↓ enabled-alert-type
↓ disabled-alert-type
↓ command

Basic Properties

description

Description
A description for this Alert Handler
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

enabled

Description
Indicates whether the Alert Handler is enabled.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

asynchronous

Description
Indicates whether the server should attempt to invoke this Exec Alert Handler in a background thread so that any potentially-expensive processing (e.g., performing network communication to deliver the alert notification) will not delay whatever processing the server was performing when the alert was generated. If alert notifications are to be processed asynchronously, the server will still process them in the order they were generated, and will block if there are already too many outstanding unprocessed alerts.
Note that some alerts will always be processed synchronously, regardless of the value of this property. This includes alerts generated at server startup and shutdown, as well as alerts with a severity of "fatal".
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

enabled-alert-severity

Description
Specifies the alert severities for which this alert handler should be used. If no values are provided, then this alert handler will be enabled for alerts with any severity. This property will work in conjunction with the enabled-alert-type and disabled-alert-type properties. If an alert type would be allowed by the enabled-alert-type and disabled-alter-type properties but has a severity not allowed here, then it will not be processed by this alert handler. Similarly, if an alert has an allowed severity but is not allowed by the enabled-alert-type and disabled-alert-type configuration, then it will not be processed by this alert handler.
Default Value
This alert handler will be enabled for alerts with any severity.
Allowed Values
info - Indicates that this alert handler should be used to process alert notifications with a severity of "info".

warning - Indicates that this alert handler should be used to process alert notifications with a severity of "warning".

error - Indicates that this alert handler should be used to process alert notifications with a severity of "error".

fatal - Indicates that this alert handler should be used to process alert notifications with a severity of "fatal".
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

enabled-alert-type

Description
Specifies the names of the alert types that are enabled for this alert handler. If there are any values for this attribute, then only alerts with one of the specified types are allowed (unless they are also included in the disabled alert types). If there are no values for this attribute, then any alert with a type not included in the list of disabled alert types is allowed.
Default Value
All alerts with types not included in the set of disabled alert types are allowed.
Allowed Values
access-log-criteria-matched - Indicates that the server has processed an operation which matched the criteria for the admin alert access log publisher.

alarm-cleared - Indicates that a previously reported alarm severity has been cleared. This does not indicate necessarily that an alarm has returned to normal as previous alarms may also be cleared before they worsen in severity.

alarm-critical - Indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability must be restored.

alarm-major - Indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability must be restored.

alarm-minor - Indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object.

alarm-warning - Indicates the detection of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service affecting fault.

backup-failed - Indicates that an error occurred while trying to perform a backup.

cannot-copy-schema-files - Indicates that an error occurred while trying to copy schema files during a schema update.

cannot-find-recurring-task - Indicates that the server could not find the task definition for a recurring task in order to schedule the next iteration.

cannot-rename-current-task-file - Indicates that an error occurred while trying to rename the current task file.

cannot-rename-new-task-file - Indicates that an error occurred while trying to rename the new task file.

cannot-restore-backup - Indicates that an error occurred while trying to restore a backup.

cannot-schedule-recurring-task-iteration - Indicates that an error occurred while trying to schedule a recurring task iteration.

cannot-write-configuration - Indicates that an error occurred while trying to write an updated copy of the server configuration.

cannot-write-new-schema-files - Indicates that an error occurred while trying to write a new copy of schema files during a schema update.

cannot-write-server-state-file - Indicates that an error occurred while trying to write the server state file.

cannot-write-task-backing-file - Indicates that an error occurred while trying to write to the task backing file.

config-change - Indicates that a configuration change has been made in the Data Sync Server.

console-logger-without-no-detach - Indicates that a console-based access or error logger has been enabled when the server is not running no-detach mode.

crypto-manager-error - Indicates that the CryptoManager encountered an expected error while attempting to synchronize settings between the topology registry and the trust store backend.

continuous-garbage-collection-detected - Indicates that the JVM garbage collector is running continuously.

deadlock-detected - Indicates that a deadlock has been detected in the JVM in which the server is running.

debug-logging-enabled - Indicates that Debug Logging is enabled.

duplicate-alerts-suppressed - This alert type is no longer used. Use the per-severity values, such as duplicate-error-alerts-suppressed, instead.

duplicate-error-alerts-suppressed - Indicates that the server suppressed one or more duplicate error alert notifications.

duplicate-fatal-alerts-suppressed - Indicates that the server suppressed one or more duplicate fatal alert notifications.

duplicate-info-alerts-suppressed - Indicates that the server suppressed one or more duplicate info alert notifications.

duplicate-warning-alerts-suppressed - Indicates that the server suppressed one or more duplicate warning alert notifications.

entering-lockdown-mode - Indicates that the server is entering lockdown mode, in which case it will only accept requests from users holding the lockdown-mode privilege, and only on connections from the loopback interface.

entry-references-removed-attribute-type - Indicates that the server has encountered an entry whose encoded representation references an attribute type that was once defined in the server schema, but whose definition has since been removed.

exec-task-launching-command - Indicates that the server is launching a command via the exec task.

external-config-file-edit-handled - Indicates that the server has detected an external modification to the configuration file and copied that modification to a separate file.

external-config-file-edit-lost - Indicates that the server has detected an external modification to the configuration file but that change was lost.

external-server-initialization-failed - Indicates that an attempt to initialize an external server failed.

failed-to-apply-mirrored-configuration - Indicates that although mirrored configuration was synchronized successfully from the master server, there were errors when applying it to the local server. A server restart is recommended in this case.

file-retention-task-delete-failure - Indicates that a file retention task was unable to delete a file that matched the filename pattern and was outside the configured retention criteria.

force-gc-complete - Indicates that the server has completed a forced synchronous garbage collection.

force-gc-starting - Indicates that the server is about to invoke a forced synchronous garbage collection.

health-check-available-to-degraded - Indicates that the health of an LDAP external server has been reclassified from AVAILABLE to DEGRADED.

health-check-available-to-unavailable - Indicates that the health of an LDAP external server has been reclassified from AVAILABLE to UNAVAILABLE.

health-check-degraded-to-available - Indicates that the health of an LDAP external server has been reclassified from DEGRADED to AVAILABLE.

health-check-degraded-to-unavailable - Indicates that the health of an LDAP external server has been reclassified from DEGRADED to UNAVAILABLE.

health-check-unavailable-to-available - Indicates that the health of an LDAP external server has been reclassified from UNAVAILABLE to AVAILABLE.

health-check-unavailable-to-degraded - Indicates that the health of an LDAP external server has been reclassified from UNAVAILABLE to DEGRADED.

http-connection-handler-duplicate-context-path - Indicates that more than one HTTP servlet or web application extension is registered to handle the same context path. The extension that handles requests for this context path will be indeterminate until the conflict is resolved.

http-connection-handler-duplicate-servlet-extension - Indicates that two or more HTTP servlet extensions registered to an HTTP connection handler are based on the same type, but only one extension of that type may be assigned to the same HTTP connection handler.

insecure-access-token-validator-enabled - Indicates that a Mock Access Token Validator is enabled. Mock Access Token Validators allow unauthenticated access to HTTP APIs, and should only be enabled in test or demonstration deployments.

invalid-privilege - Indicates that a user has been configured with an invalid privilege.

jvm-misconfiguration - Indicates that the recommended JVM flags for this server are either missing or misconfigured.

ldap-connection-handler-cannot-listen - Indicates that an LDAP connection encountered an error when it attempted to begin listening for client connections and will therefore be disabled.

ldap-connection-handler-consecutive-failures - Indicates that an LDAP connection handler has encountered consecutive failures and will be disabled.

ldap-connection-handler-uncaught-error - Indicates that an LDAP connection handler has encountered an uncaught error and will be disabled.

ldif-backend-cannot-write - Indicates that a problem has occurred while trying to write to the backing file for an LDIF backend.

ldif-connection-handler-parse-error - Indicates that an error occurred while trying to parse an LDIF file provided to an LDIF connection handler.

ldif-connection-handler-io-error - Indicates that an LDIF connection handler has encountered an I/O error while trying to look for or process a set of changes.

leaving-lockdown-mode - Indicates that the server is leaving lockdown mode and resuming normal operation.

log-file-rotation-listener-invoke-error - Indicates that an error has occurred while attempting to invoke a log file rotation listener.

log-file-rotation-listener-processing-takes-too-long - Indicates that one or more of the configured log file rotation listeners is taking too long to complete (log files are being rotated more quickly than the listeners can be invoked to process them).

logging-error - Indicates that an error has occurred while attempting to log a message.

low-disk-space-error - Indicates that the amount of usable disk space has dropped below the low space error threshold.

low-disk-space-warning - Indicates that the amount of usable disk space has dropped below the low space warning threshold.

mirrored-subtree-manager-forced-as-master-error - Indicates that the mirrored subtree manager, which is used to keep configuration data up-to-date across servers, found that more than one server was forced to act as master either because no master could be found, or because more than one master was detected.

mirrored-subtree-manager-forced-as-master-warning - Indicates that the mirrored subtree manager, which is used to keep configuration data up-to-date across servers, found that a server was forced to act as master either because no master could be found, or because more than one master was detected.

mirrored-subtree-manager-no-master-found - Indicates that the mirrored subtree manager, which is used to keep configuration data up-to-date across servers, was unable to determine a suitable server to act as the master of the topology, which means that mirrored data cannot be updated.

mirrored-subtree-server-not-in-topology - Indicates that this server is no longer functional because it does not exist in the topology registry most likely because it was removed from the topology with the remove-defunct-server tool.

mirrored-subtree-manager-operation-error - Indicates that the mirrored subtree manager, which is used to keep configuration data up-to-date across servers, encountered an unexpected error while processing an update operation.

mirrored-subtree-manager-failed-outbound-connection - Indicates that the mirrored subtree manager, which is used to keep configuration data up-to-date across servers, encountered an error while establishing a connection to a peer server within the configured grace period.

mirrored-subtree-manager-connection-asymmetry - Indicates that the mirrored subtree manager, which is used to keep configuration data up-to-date across servers, has had an unequal number of outbound and inbound connections with its peer servers for more than the configured grace period.

missing-schema-elements-referenced-by-backend - Indicates that a backend detected references to one or more schema elements that have been removed from the schema.

monitoring-endpoint-unable-to-connect - Indicates that a monitoring endpoint was unable to connect or write to the configured host and port.

no-enabled-alert-handlers - Indicates that this server does not have any alert handlers enabled beyond the default that logs to logs/error.

offline-config-change-detected - Indicates that the server detected that an offline configuration change was made.

out-of-disk-space-error - Indicates that the amount of usable disk space has dropped below the out of space error threshold.

restart-required - Indicates that the server must be restarted for configuration changes to take effect.

schema-checking-disabled - Indicates that schema checking is disabled in the server.

server-shutting-down - Indicates that the server has begun the shutdown process.

server-starting - Indicates that the server has begun its startup process.

server-started - Indicates that the server has completed its startup process.

sync-resource-connection-error - Indicates that there was an error when establishing a connection to an external server by the Data Sync Server.

sync-resource-operation-error - Indicates that the Data Sync Server experienced an error while processing an operation at an external server.

sync-pipe-initialization-error - Indicates that a Sync Pipe experienced an error while initializing.

sync-pipe-backlog-above-threshold - Indicates that a Sync Pipe has a large amount of unretrieved changes.

sync-pipe-backlog-below-threshold - Indicates that a Sync Pipe was backlogged but now the number of unretrieved changes is back below the configured threshold.

system-nanotime-stopped - Indicates that Java's System.nanoTime() has stopped returning updated values.

system-current-time-shifted - Indicates that Java's System Current Time has shifted backwards.

task-started - Indicates that an administrative task has started running.

task-completed - Indicates that an administrative task completed successfully.

task-failed - Indicates that an administrative task failed to complete successfully.

third-party-extension-exception - Indicates that a third-party extension threw an unexpected exception.

thread-exit-holding-lock - Indicates that a thread has exited while still holding one or more locks.

uncaught-exception - Indicates that the server has detected an uncaught exception that may have caused a thread to terminate.

unindexed-internal-search - Indicates that an internal component has initiated an unindexed search.

unlicensed-product - Indicates that the server's license key is not set, is invalid, or has expired.

unrecognized-alert-type - Indicates that the server encountered an alert type that it did not recognize.

user-defined-error - Indicates that an externally-developed component has generated an error alert notification.

user-defined-fatal - Indicates that an externally-developed component has generated a fatal error alert notification.

user-defined-info - Indicates that an externally-developed component has generated an informational alert notification.

user-defined-warning - Indicates that an externally-developed component has generated a warning alert notification.

worker-thread-caught-error - Indicates that a worker thread encountered an unexpected error that has caused it to terminate.

work-queue-backlogged - Indicates that the work queue has accumulated a significant backlog.

work-queue-full - Indicates that the server work queue has reached its maximum capacity and has begun rejecting client requests.

work-queue-no-threads-remaining - Indicates that the server will shut down because all worker threads have exited due to errors.

server-jvm-paused - Indicates that the server's JVM paused possibly due to misconfiguration.

sensitive-trace-data-logged-warning - Indicates that the configuration of a Trace Log Publisher might result in sensitive information being logged.

account-temporarily-locked-account-status-notification - Indicates that an account status notification has been generated because a user's account has been temporarily locked as a result of too many failed authentication attempts.

account-permanently-locked-account-status-notification - Indicates that an account status notification has been generated because a user's account has been permanently locked as a result of too many failed authentication attempts.

account-unlocked-account-status-notification - Indicates that an account status notification has been generated because a user's account has been unlocked by an administrator.

account-idle-locked-account-status-notification - Indicates that an account status notification has been generated because an authentication attempt has failed because it has been too long since the user last successfully authenticated.

account-reset-locked-account-status-notification - Indicates that an account status notification has been generated because an authentication attempt has failed because the user did not choose a new password in a timely manner after an administrative password reset.

account-disabled-account-status-notification - Indicates that an account status notification has been generated because a user account has been administratively disabled.

account-enabled-account-status-notification - Indicates that an account status notification has been generated because a user account has been administratively enabled.

account-not-yet-active-account-status-notification - Indicates that an account status notification has been generated because an authentication attempt has failed because the user's account has an activation time that is in the future.

account-expired-account-status-notification - Indicates that an account status notification has been generated because an authentication attempt has failed because the user's account has an expiration time that is in the past.

password-expired-account-status-notification - Indicates that an account status notification has been generated because an authentication attempt has failed because the user's password is expired.

password-expiring-account-status-notification - Indicates that an account status notification has been generated because a user has received their first warning about an upcoming password expiration.

password-reset-account-status-notification - Indicates that an account status notification has been generated because a user's password has been reset by an administrator.

password-changed-account-status-notification - Indicates that an account status notification has been generated because a user has changed their own password.

account-created-account-status-notification - Indicates that an account status notification has been generated because a new entry has been created with an add operation that matches a defined set of criteria.

account-updated-account-status-notification - Indicates that an account status notification has been generated because an entry has been updated with a modify or modify DN operation that matches a defined set of criteria.

bind-password-failed-validation-account-status-notification - Indicates that an account status notification has been generated because an authentication attempt has failed because the provided password failed to satisfy all of the configured password validators.

must-change-password-account-status-notification - Indicates that an account status notification has been generated because a user has successfully authenticated but must choose a new password before they will be allowed to request other operations.

privilege-assigned - Indicates that one or more privileges have been assigned to a user or set of users.

insecure-request-rejected - Indicates that a request was rejected because it was received over an insecure connection and the server has been configured to reject insecure requests.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

disabled-alert-type

Description
Specifies the names of the alert types that are disabled for this alert handler. If there are any values for this attribute, then no alerts with any of the specified types are allowed. If there are no values for this attribute, then only alerts with a type included in the set of enabled alert types are allowed, or if there are no values for the enabled alert types option, then all alert types are allowed.
Default Value
If there is a set of enabled alert types, then only alerts with one of those types are allowed. Otherwise, all alerts are allowed.
Allowed Values
access-log-criteria-matched - Indicates that the server has processed an operation which matched the criteria for the admin alert access log publisher.

alarm-cleared - Indicates that a previously reported alarm severity has been cleared. This does not indicate necessarily that an alarm has returned to normal as previous alarms may also be cleared before they worsen in severity.

alarm-critical - Indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability must be restored.

alarm-major - Indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability must be restored.

alarm-minor - Indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object.

alarm-warning - Indicates the detection of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service affecting fault.

backup-failed - Indicates that an error occurred while trying to perform a backup.

cannot-copy-schema-files - Indicates that an error occurred while trying to copy schema files during a schema update.

cannot-find-recurring-task - Indicates that the server could not find the task definition for a recurring task in order to schedule the next iteration.

cannot-rename-current-task-file - Indicates that an error occurred while trying to rename the current task file.

cannot-rename-new-task-file - Indicates that an error occurred while trying to rename the new task file.

cannot-restore-backup - Indicates that an error occurred while trying to restore a backup.

cannot-schedule-recurring-task-iteration - Indicates that an error occurred while trying to schedule a recurring task iteration.

cannot-write-configuration - Indicates that an error occurred while trying to write an updated copy of the server configuration.

cannot-write-new-schema-files - Indicates that an error occurred while trying to write a new copy of schema files during a schema update.

cannot-write-server-state-file - Indicates that an error occurred while trying to write the server state file.

cannot-write-task-backing-file - Indicates that an error occurred while trying to write to the task backing file.

config-change - Indicates that a configuration change has been made in the Data Sync Server.

console-logger-without-no-detach - Indicates that a console-based access or error logger has been enabled when the server is not running no-detach mode.

crypto-manager-error - Indicates that the CryptoManager encountered an expected error while attempting to synchronize settings between the topology registry and the trust store backend.

continuous-garbage-collection-detected - Indicates that the JVM garbage collector is running continuously.

deadlock-detected - Indicates that a deadlock has been detected in the JVM in which the server is running.

debug-logging-enabled - Indicates that Debug Logging is enabled.

duplicate-alerts-suppressed - This alert type is no longer used. Use the per-severity values, such as duplicate-error-alerts-suppressed, instead.

duplicate-error-alerts-suppressed - Indicates that the server suppressed one or more duplicate error alert notifications.

duplicate-fatal-alerts-suppressed - Indicates that the server suppressed one or more duplicate fatal alert notifications.

duplicate-info-alerts-suppressed - Indicates that the server suppressed one or more duplicate info alert notifications.

duplicate-warning-alerts-suppressed - Indicates that the server suppressed one or more duplicate warning alert notifications.

entering-lockdown-mode - Indicates that the server is entering lockdown mode, in which case it will only accept requests from users holding the lockdown-mode privilege, and only on connections from the loopback interface.

entry-references-removed-attribute-type - Indicates that the server has encountered an entry whose encoded representation references an attribute type that was once defined in the server schema, but whose definition has since been removed.

exec-task-launching-command - Indicates that the server is launching a command via the exec task.

external-config-file-edit-handled - Indicates that the server has detected an external modification to the configuration file and copied that modification to a separate file.

external-config-file-edit-lost - Indicates that the server has detected an external modification to the configuration file but that change was lost.

external-server-initialization-failed - Indicates that an attempt to initialize an external server failed.

failed-to-apply-mirrored-configuration - Indicates that although mirrored configuration was synchronized successfully from the master server, there were errors when applying it to the local server. A server restart is recommended in this case.

file-retention-task-delete-failure - Indicates that a file retention task was unable to delete a file that matched the filename pattern and was outside the configured retention criteria.

force-gc-complete - Indicates that the server has completed a forced synchronous garbage collection.

force-gc-starting - Indicates that the server is about to invoke a forced synchronous garbage collection.

health-check-available-to-degraded - Indicates that the health of an LDAP external server has been reclassified from AVAILABLE to DEGRADED.

health-check-available-to-unavailable - Indicates that the health of an LDAP external server has been reclassified from AVAILABLE to UNAVAILABLE.

health-check-degraded-to-available - Indicates that the health of an LDAP external server has been reclassified from DEGRADED to AVAILABLE.

health-check-degraded-to-unavailable - Indicates that the health of an LDAP external server has been reclassified from DEGRADED to UNAVAILABLE.

health-check-unavailable-to-available - Indicates that the health of an LDAP external server has been reclassified from UNAVAILABLE to AVAILABLE.

health-check-unavailable-to-degraded - Indicates that the health of an LDAP external server has been reclassified from UNAVAILABLE to DEGRADED.

http-connection-handler-duplicate-context-path - Indicates that more than one HTTP servlet or web application extension is registered to handle the same context path. The extension that handles requests for this context path will be indeterminate until the conflict is resolved.

http-connection-handler-duplicate-servlet-extension - Indicates that two or more HTTP servlet extensions registered to an HTTP connection handler are based on the same type, but only one extension of that type may be assigned to the same HTTP connection handler.

insecure-access-token-validator-enabled - Indicates that a Mock Access Token Validator is enabled. Mock Access Token Validators allow unauthenticated access to HTTP APIs, and should only be enabled in test or demonstration deployments.

invalid-privilege - Indicates that a user has been configured with an invalid privilege.

jvm-misconfiguration - Indicates that the recommended JVM flags for this server are either missing or misconfigured.

ldap-connection-handler-cannot-listen - Indicates that an LDAP connection encountered an error when it attempted to begin listening for client connections and will therefore be disabled.

ldap-connection-handler-consecutive-failures - Indicates that an LDAP connection handler has encountered consecutive failures and will be disabled.

ldap-connection-handler-uncaught-error - Indicates that an LDAP connection handler has encountered an uncaught error and will be disabled.

ldif-backend-cannot-write - Indicates that a problem has occurred while trying to write to the backing file for an LDIF backend.

ldif-connection-handler-parse-error - Indicates that an error occurred while trying to parse an LDIF file provided to an LDIF connection handler.

ldif-connection-handler-io-error - Indicates that an LDIF connection handler has encountered an I/O error while trying to look for or process a set of changes.

leaving-lockdown-mode - Indicates that the server is leaving lockdown mode and resuming normal operation.

log-file-rotation-listener-invoke-error - Indicates that an error has occurred while attempting to invoke a log file rotation listener.

log-file-rotation-listener-processing-takes-too-long - Indicates that one or more of the configured log file rotation listeners is taking too long to complete (log files are being rotated more quickly than the listeners can be invoked to process them).

logging-error - Indicates that an error has occurred while attempting to log a message.

low-disk-space-error - Indicates that the amount of usable disk space has dropped below the low space error threshold.

low-disk-space-warning - Indicates that the amount of usable disk space has dropped below the low space warning threshold.

mirrored-subtree-manager-forced-as-master-error - Indicates that the mirrored subtree manager, which is used to keep configuration data up-to-date across servers, found that more than one server was forced to act as master either because no master could be found, or because more than one master was detected.

mirrored-subtree-manager-forced-as-master-warning - Indicates that the mirrored subtree manager, which is used to keep configuration data up-to-date across servers, found that a server was forced to act as master either because no master could be found, or because more than one master was detected.

mirrored-subtree-manager-no-master-found - Indicates that the mirrored subtree manager, which is used to keep configuration data up-to-date across servers, was unable to determine a suitable server to act as the master of the topology, which means that mirrored data cannot be updated.

mirrored-subtree-server-not-in-topology - Indicates that this server is no longer functional because it does not exist in the topology registry most likely because it was removed from the topology with the remove-defunct-server tool.

mirrored-subtree-manager-operation-error - Indicates that the mirrored subtree manager, which is used to keep configuration data up-to-date across servers, encountered an unexpected error while processing an update operation.

mirrored-subtree-manager-failed-outbound-connection - Indicates that the mirrored subtree manager, which is used to keep configuration data up-to-date across servers, encountered an error while establishing a connection to a peer server within the configured grace period.

mirrored-subtree-manager-connection-asymmetry - Indicates that the mirrored subtree manager, which is used to keep configuration data up-to-date across servers, has had an unequal number of outbound and inbound connections with its peer servers for more than the configured grace period.

missing-schema-elements-referenced-by-backend - Indicates that a backend detected references to one or more schema elements that have been removed from the schema.

monitoring-endpoint-unable-to-connect - Indicates that a monitoring endpoint was unable to connect or write to the configured host and port.

no-enabled-alert-handlers - Indicates that this server does not have any alert handlers enabled beyond the default that logs to logs/error.

offline-config-change-detected - Indicates that the server detected that an offline configuration change was made.

out-of-disk-space-error - Indicates that the amount of usable disk space has dropped below the out of space error threshold.

restart-required - Indicates that the server must be restarted for configuration changes to take effect.

schema-checking-disabled - Indicates that schema checking is disabled in the server.

server-shutting-down - Indicates that the server has begun the shutdown process.

server-starting - Indicates that the server has begun its startup process.

server-started - Indicates that the server has completed its startup process.

sync-resource-connection-error - Indicates that there was an error when establishing a connection to an external server by the Data Sync Server.

sync-resource-operation-error - Indicates that the Data Sync Server experienced an error while processing an operation at an external server.

sync-pipe-initialization-error - Indicates that a Sync Pipe experienced an error while initializing.

sync-pipe-backlog-above-threshold - Indicates that a Sync Pipe has a large amount of unretrieved changes.

sync-pipe-backlog-below-threshold - Indicates that a Sync Pipe was backlogged but now the number of unretrieved changes is back below the configured threshold.

system-nanotime-stopped - Indicates that Java's System.nanoTime() has stopped returning updated values.

system-current-time-shifted - Indicates that Java's System Current Time has shifted backwards.

task-started - Indicates that an administrative task has started running.

task-completed - Indicates that an administrative task completed successfully.

task-failed - Indicates that an administrative task failed to complete successfully.

third-party-extension-exception - Indicates that a third-party extension threw an unexpected exception.

thread-exit-holding-lock - Indicates that a thread has exited while still holding one or more locks.

uncaught-exception - Indicates that the server has detected an uncaught exception that may have caused a thread to terminate.

unindexed-internal-search - Indicates that an internal component has initiated an unindexed search.

unlicensed-product - Indicates that the server's license key is not set, is invalid, or has expired.

unrecognized-alert-type - Indicates that the server encountered an alert type that it did not recognize.

user-defined-error - Indicates that an externally-developed component has generated an error alert notification.

user-defined-fatal - Indicates that an externally-developed component has generated a fatal error alert notification.

user-defined-info - Indicates that an externally-developed component has generated an informational alert notification.

user-defined-warning - Indicates that an externally-developed component has generated a warning alert notification.

worker-thread-caught-error - Indicates that a worker thread encountered an unexpected error that has caused it to terminate.

work-queue-backlogged - Indicates that the work queue has accumulated a significant backlog.

work-queue-full - Indicates that the server work queue has reached its maximum capacity and has begun rejecting client requests.

work-queue-no-threads-remaining - Indicates that the server will shut down because all worker threads have exited due to errors.

server-jvm-paused - Indicates that the server's JVM paused possibly due to misconfiguration.

sensitive-trace-data-logged-warning - Indicates that the configuration of a Trace Log Publisher might result in sensitive information being logged.

account-temporarily-locked-account-status-notification - Indicates that an account status notification has been generated because a user's account has been temporarily locked as a result of too many failed authentication attempts.

account-permanently-locked-account-status-notification - Indicates that an account status notification has been generated because a user's account has been permanently locked as a result of too many failed authentication attempts.

account-unlocked-account-status-notification - Indicates that an account status notification has been generated because a user's account has been unlocked by an administrator.

account-idle-locked-account-status-notification - Indicates that an account status notification has been generated because an authentication attempt has failed because it has been too long since the user last successfully authenticated.

account-reset-locked-account-status-notification - Indicates that an account status notification has been generated because an authentication attempt has failed because the user did not choose a new password in a timely manner after an administrative password reset.

account-disabled-account-status-notification - Indicates that an account status notification has been generated because a user account has been administratively disabled.

account-enabled-account-status-notification - Indicates that an account status notification has been generated because a user account has been administratively enabled.

account-not-yet-active-account-status-notification - Indicates that an account status notification has been generated because an authentication attempt has failed because the user's account has an activation time that is in the future.

account-expired-account-status-notification - Indicates that an account status notification has been generated because an authentication attempt has failed because the user's account has an expiration time that is in the past.

password-expired-account-status-notification - Indicates that an account status notification has been generated because an authentication attempt has failed because the user's password is expired.

password-expiring-account-status-notification - Indicates that an account status notification has been generated because a user has received their first warning about an upcoming password expiration.

password-reset-account-status-notification - Indicates that an account status notification has been generated because a user's password has been reset by an administrator.

password-changed-account-status-notification - Indicates that an account status notification has been generated because a user has changed their own password.

account-created-account-status-notification - Indicates that an account status notification has been generated because a new entry has been created with an add operation that matches a defined set of criteria.

account-updated-account-status-notification - Indicates that an account status notification has been generated because an entry has been updated with a modify or modify DN operation that matches a defined set of criteria.

bind-password-failed-validation-account-status-notification - Indicates that an account status notification has been generated because an authentication attempt has failed because the provided password failed to satisfy all of the configured password validators.

must-change-password-account-status-notification - Indicates that an account status notification has been generated because a user has successfully authenticated but must choose a new password before they will be allowed to request other operations.

privilege-assigned - Indicates that one or more privileges have been assigned to a user or set of users.

insecure-request-rejected - Indicates that a request was rejected because it was received over an insecure connection and the server has been configured to reject insecure requests.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

command

Description
Specifies the path of the command to execute, without any arguments. It must be an absolute path for reasons of security and reliability.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Alert Handlers:

dsconfig list-alert-handlers
     [--property {propertyName}] ...

To view the configuration for an existing Alert Handler:

dsconfig get-alert-handler-prop
     --handler-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Alert Handler:

dsconfig set-alert-handler-prop
     --handler-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Exec Alert Handler:

dsconfig create-alert-handler
     --handler-name {name}
     --type exec
     --set enabled:{propertyValue}
     --set command:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Alert Handler:

dsconfig delete-alert-handler
     --handler-name {name}