Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
The Error Log Account Status Notification Handler is a notification handler that writes information to the server error log whenever an appropriate account status event occurs.
↓Parent Component
↓Properties
↓dsconfig Usage
The Error Log Account Status Notification Handler component inherits from the Account Status Notification Handler
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled | |
| ↓ asynchronous | |
| ↓ account-creation-notification-request-criteria | |
| ↓ account-update-notification-request-criteria | |
| ↓ account-status-notification-type |
| Description | A description for this Account Status Notification 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 Account Status Notification Handler is enabled. Only enabled handlers are invoked whenever a related event occurs in the server. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the server should attempt to invoke this Account Status Notification Handler in a background thread so that any potentially-expensive processing (e.g., performing network communication to deliver a message) will not delay processing for the operation that triggered the notification. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-creation-notification-request-criteria
| Description | A request criteria object that identifies which add requests should result in account creation notifications for this handler. If this is not defined, then account creation notifications will not be processed by this account status notification handler. If it is defined, then account creation notifications will only be handled for add requests that match the provided criteria. |
| Default Value | Account creation notifications will not be processed by this account status notification handler. |
| Allowed Values | The DN of any Request Criteria. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-update-notification-request-criteria
| Description | A request criteria object that identifies which modify and modify DN requests should result in account update notifications for this handler. If this is not defined, then account update notifications will not be processed by this account status notification handler. If it is defined, then account update notifications will only be handled for modify and modify DN requests that match the provided criteria. |
| Default Value | Account update notifications will not be processed by this account status notification handler. |
| Allowed Values | The DN of any Request Criteria. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-status-notification-type
| Description | Indicates which types of event can trigger an account status notification. |
| Default Value | None |
| Allowed Values | account-temporarily-locked - Generate a notification whenever a user account has been temporarily locked after too many failed attempts. account-permanently-locked - Generate a notification whenever a user account has been permanently locked after too many failed attempts. account-unlocked - Generate a notification whenever a user account has been unlocked by an administrator. account-idle-locked - Generate a notification whenever a user account has been locked because it was idle for too long. account-reset-locked - Generate a notification whenever a user account has been locked, because the password had been reset by an administrator but not changed by the user within the required interval. account-disabled - Generate a notification whenever a user account has been disabled by an administrator. account-enabled - Generate a notification whenever a user account has been enabled by an administrator. account-expired - Generate a notification whenever a user authentication has failed because the account has expired. password-expired - Generate a notification whenever a user authentication has failed because the password has expired. password-expiring - Generate a notification whenever a password expiration warning is encountered for a user password for the first time. password-reset - Generate a notification whenever a user's password is reset by an administrator. password-changed - Generate a notification whenever a user changes his/her own password. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured Account Status Notification Handlers:
dsconfig list-account-status-notification-handlers
[--property {propertyName}] ...
To view the configuration for an existing Account Status Notification Handler:
dsconfig get-account-status-notification-handler-prop
--handler-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Account Status Notification Handler:
dsconfig set-account-status-notification-handler-prop
--handler-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Error Log Account Status Notification Handler:
dsconfig create-account-status-notification-handler
--handler-name {name}
--type error-log
--set enabled:{propertyValue}
--set account-status-notification-type:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Account Status Notification Handler:
dsconfig delete-account-status-notification-handler
--handler-name {name}