Groovy Scripted Alert Handler provide alert handler implementations defined in a dynamically-loaded Groovy script which implements the ScriptedAlertHandler class defined in the UnboundID server SDK.
↓Parent Component
↓Properties
↓dsconfig Usage
The Groovy Scripted Alert Handler component inherits from the Scripted Alert Handler
The properties supported by this managed object are as follows:
Basic Properties: | Advanced Properties: |
---|---|
↓ description | None |
↓ enabled | |
↓ enabled-alert-severity | |
↓ enabled-alert-type | |
↓ disabled-alert-type | |
↓ script-argument | |
↓ script-class |
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 |
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 |
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 |
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-control-change - Indicates that a change has been made to the set of access control rules defined in the server. access-control-disabled - Indicates that access control evaluation has been disabled. access-control-enabled - Indicates that access control evaluation has been enabled. access-control-parse-failure - Indicates that an error occurred while trying to parse an access control rule. access-log-criteria-matched - Indicates that the server has processed an operation which matched the criteria for the admin alert access log publisher. backend-disabled - Indicates that a Synchronization Server backend is disabled. backend-initialization-failed - Indicates that an error occurred while attempting to initialize a Synchronization Server backend. backup-failed - Indicates that an error occurred while trying to perform a backup. cannot-acquire-shared-backend-lock - Indicates that an error occurred while trying to acquire a shared lock for a backend. cannot-copy-schema-files - Indicates that an error occurred while trying to copy schema files during a schema update. cannot-decode-entry - Indicates that an error occurred while trying to decode an entry stored in a Synchronization Server backend. 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-register-backend - Indicates that an error occurred while trying to register a backend. cannot-release-shared-backend-lock - Indicates that an error occurred while trying to release a shared lock for a backend. 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 Synchronization Server. deadlock-detected - Indicates that a deadlock has been detected in the JVM in which the server is running. 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. 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. 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. index-degraded - Indicates that a backend has an index in a degraded state which must be rebuilt before that index may be used. index-rebuild-completed - Indicates that a backend has completed the process of rebuilding an index. index-rebuild-in-progress - Indicates that a backend has started the process of rebuilding an index. invalid-privilege - Indicates that a user has been configured with an invalid privilege. je-background-sync-failed - Indicates that an error occurred while attempting to perform a synchronous write in a background thread to improve durability and smooth overall write performance. je-daemon-thread-exception - Indicates that an exception was encountered in the processing performed by a Berkeley DB Java Edition daemon thread. je-recovery-required - Indicates that a backend using the Berkeley DB Java Edition has encountered an error and must be restarted so that it can attempt to run recovery. large-attribute-update-failure - Indicates that a failure occurred while attempting to update information in the large attribute backend that may have resulted in large attribute information being out of sync with the rest of the entry contents. lba-no-available-servers - Indicates that none of the LDAP external servers associated with a load-balancing algorithm are available. 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. 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. 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. proxy-entry-balancing-operation-failure - Indicates that an entry balancing request processor attempted to execute an operation on all configured backend sets, but the operation failed on one or more sets. proxy-entry-balancing-error-multiple-operations-succeeded - Indicates that an entry balancing request processor successfully executed an operation on multiple backend sets. Only one backend set was expected to succeed with the operation. proxy-entry-rebalancing-admin-action-required - Indicates that administrative action is required to bring the entry-balanced servers back to a consistent state after an attempted rebalancing operation. replication-backlogged - Indicates that the server replication backlog has exceeded the replication alert backlog threshold for longer than the replication alert backlog duration. replication-missing-changes - Indicates that a Replication Server may have missed some replication changes. replication-monitor-data-unavailable - Indicates that replication monitor data is unavailable from cn=monitor. replication-plugin-message-serialization-failure - Indicates that the replication plugin failed to serialize or deserialize a replication message. replication-server-changelog-failure - Indicates that the replication server encountered an error while accessing the replication changelog database. replication-server-listen-failure - Indicates that the replication server encountered an error while trying to listen on the configured replication port. There may be another application listening on the same port or the replication server host name may not be resolvable replication-unresolved-conflict - Indicates that replication has detected a conflict that could not be automatically resolved. replication-unsent-changes - Indicates that one or more replicas were unable to send all pending update messages to the replication server before completing the shutdown process. These updates will be submitted when the server starts up. replication-replay-failed - Indicates that the server has failed to replay a replication operation. schema-checking-disabled - Indicates that schema checking is disabled in the server. restricted-subtree-accessibility - Indicates that a subtree has been read-only or hidden for longer than the configured time limit. 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 Synchronization Server. sync-resource-operation-error - Indicates that the Synchronization 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. 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. unique-attribute-sync-conflict - Indicates that the server has detected a unique attribute conflict as the result of a replicated change. unique-attribute-sync-error - Indicates that the server has encountered an error while trying to detect unique attribute conflicts introduced through replication. 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. |
Multi-Valued | Yes |
Required | No |
Admin Action Required | None. Modification requires no further action |
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-control-change - Indicates that a change has been made to the set of access control rules defined in the server. access-control-disabled - Indicates that access control evaluation has been disabled. access-control-enabled - Indicates that access control evaluation has been enabled. access-control-parse-failure - Indicates that an error occurred while trying to parse an access control rule. access-log-criteria-matched - Indicates that the server has processed an operation which matched the criteria for the admin alert access log publisher. backend-disabled - Indicates that a Synchronization Server backend is disabled. backend-initialization-failed - Indicates that an error occurred while attempting to initialize a Synchronization Server backend. backup-failed - Indicates that an error occurred while trying to perform a backup. cannot-acquire-shared-backend-lock - Indicates that an error occurred while trying to acquire a shared lock for a backend. cannot-copy-schema-files - Indicates that an error occurred while trying to copy schema files during a schema update. cannot-decode-entry - Indicates that an error occurred while trying to decode an entry stored in a Synchronization Server backend. 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-register-backend - Indicates that an error occurred while trying to register a backend. cannot-release-shared-backend-lock - Indicates that an error occurred while trying to release a shared lock for a backend. 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 Synchronization Server. deadlock-detected - Indicates that a deadlock has been detected in the JVM in which the server is running. 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. 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. 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. index-degraded - Indicates that a backend has an index in a degraded state which must be rebuilt before that index may be used. index-rebuild-completed - Indicates that a backend has completed the process of rebuilding an index. index-rebuild-in-progress - Indicates that a backend has started the process of rebuilding an index. invalid-privilege - Indicates that a user has been configured with an invalid privilege. je-background-sync-failed - Indicates that an error occurred while attempting to perform a synchronous write in a background thread to improve durability and smooth overall write performance. je-daemon-thread-exception - Indicates that an exception was encountered in the processing performed by a Berkeley DB Java Edition daemon thread. je-recovery-required - Indicates that a backend using the Berkeley DB Java Edition has encountered an error and must be restarted so that it can attempt to run recovery. large-attribute-update-failure - Indicates that a failure occurred while attempting to update information in the large attribute backend that may have resulted in large attribute information being out of sync with the rest of the entry contents. lba-no-available-servers - Indicates that none of the LDAP external servers associated with a load-balancing algorithm are available. 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. 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. 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. proxy-entry-balancing-operation-failure - Indicates that an entry balancing request processor attempted to execute an operation on all configured backend sets, but the operation failed on one or more sets. proxy-entry-balancing-error-multiple-operations-succeeded - Indicates that an entry balancing request processor successfully executed an operation on multiple backend sets. Only one backend set was expected to succeed with the operation. proxy-entry-rebalancing-admin-action-required - Indicates that administrative action is required to bring the entry-balanced servers back to a consistent state after an attempted rebalancing operation. replication-backlogged - Indicates that the server replication backlog has exceeded the replication alert backlog threshold for longer than the replication alert backlog duration. replication-missing-changes - Indicates that a Replication Server may have missed some replication changes. replication-monitor-data-unavailable - Indicates that replication monitor data is unavailable from cn=monitor. replication-plugin-message-serialization-failure - Indicates that the replication plugin failed to serialize or deserialize a replication message. replication-server-changelog-failure - Indicates that the replication server encountered an error while accessing the replication changelog database. replication-server-listen-failure - Indicates that the replication server encountered an error while trying to listen on the configured replication port. There may be another application listening on the same port or the replication server host name may not be resolvable replication-unresolved-conflict - Indicates that replication has detected a conflict that could not be automatically resolved. replication-unsent-changes - Indicates that one or more replicas were unable to send all pending update messages to the replication server before completing the shutdown process. These updates will be submitted when the server starts up. replication-replay-failed - Indicates that the server has failed to replay a replication operation. restricted-subtree-accessibility - Indicates that a subtree has been read-only or hidden for longer than the configured time limit. 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 Synchronization Server. sync-resource-operation-error - Indicates that the Synchronization 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. 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. unique-attribute-sync-conflict - Indicates that the server has detected a unique attribute conflict as the result of a replicated change. unique-attribute-sync-error - Indicates that the server has encountered an error while trying to detect unique attribute conflicts introduced through replication. 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. |
Multi-Valued | Yes |
Required | No |
Admin Action Required | None. Modification requires no further action |
Description | The set of arguments used to customize the behavior for the Scripted Alert Handler. Each configuration property should be given in the form 'name=value'. |
Default Value | None |
Allowed Values | An argument in the form 'name=value'. Argument names are allowed to contain only ASCII alphabetic characters, numeric digits, dashes, and underscores. |
Multi-Valued | Yes |
Required | No |
Admin Action Required | None. Modification requires no further action |
Description | The fully-qualified name of the Groovy class providing the logic for the Groovy Scripted Alert Handler. |
Default Value | None |
Allowed Values | A string |
Multi-Valued | No |
Required | Yes |
Admin Action Required | None. Modification requires no further action |
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 Groovy Scripted Alert Handler:
dsconfig create-alert-handler --handler-name {name} --type groovy --set enabled:{propertyValue} --set script-class:{propertyValue} [--set {propertyName}:{propertyValue}] ...
To delete an existing Alert Handler:
dsconfig delete-alert-handler --handler-name {name}