dsconfig get-account-status-notification-handler-prop — Shows Account Status Notification Handler properties
dsconfig get-account-status-notification-handler-prop
{options}
The dsconfig get-account-status-notification-handler-prop command takes the following options:
--handler-name {name}
The name of the Account Status Notification Handler.
Account Status Notification Handler properties depend on the Account Status Notification Handler type, which depends on the {name} you provide.
By default, OpenDJ directory server supports the following Account Status Notification Handler types:
Default {name}: Error Log Account Status Notification Handler
Enabled by default: true
See the section called “Error Log Account Status Notification Handler” for the properties of this Account Status Notification Handler type.
Default {name}: SMTP Account Status Notification Handler
Enabled by default: true
See the section called “SMTP Account Status Notification Handler” for the properties of this Account Status Notification Handler type.
--property {property}
The name of a property to be displayed.
Account Status Notification Handler properties depend on the Account Status Notification Handler type, which depends on the {property} you provide.
By default, OpenDJ directory server supports the following Account Status Notification Handler types:
Default {property}: Error Log Account Status Notification Handler
Enabled by default: true
See the section called “Error Log Account Status Notification Handler” for the properties of this Account Status Notification Handler type.
Default {property}: SMTP Account Status Notification Handler
Enabled by default: true
See the section called “SMTP Account Status Notification Handler” for the properties of this Account Status Notification Handler type.
-E | --record
Modifies the display output to show one property value per line.
Account Status Notification Handler properties depend on the Account Status Notification Handler type, which depends on the null you provide.
By default, OpenDJ directory server supports the following Account Status Notification Handler types:
Default null: Error Log Account Status Notification Handler
Enabled by default: true
See the section called “Error Log Account Status Notification Handler” for the properties of this Account Status Notification Handler type.
Default null: SMTP Account Status Notification Handler
Enabled by default: true
See the section called “SMTP Account Status Notification Handler” for the properties of this Account Status Notification Handler type.
-z | --unit-size {unit}
Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
Account Status Notification Handler properties depend on the Account Status Notification Handler type, which depends on the {unit} you provide.
By default, OpenDJ directory server supports the following Account Status Notification Handler types:
Default {unit}: Error Log Account Status Notification Handler
Enabled by default: true
See the section called “Error Log Account Status Notification Handler” for the properties of this Account Status Notification Handler type.
Default {unit}: SMTP Account Status Notification Handler
Enabled by default: true
See the section called “SMTP Account Status Notification Handler” for the properties of this Account Status Notification Handler type.
-m | --unit-time {unit}
Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Account Status Notification Handler properties depend on the Account Status Notification Handler type, which depends on the {unit} you provide.
By default, OpenDJ directory server supports the following Account Status Notification Handler types:
Default {unit}: Error Log Account Status Notification Handler
Enabled by default: true
See the section called “Error Log Account Status Notification Handler” for the properties of this Account Status Notification Handler type.
Default {unit}: SMTP Account Status Notification Handler
Enabled by default: true
See the section called “SMTP Account Status Notification Handler” for the properties of this Account Status Notification Handler type.
Account Status Notification Handlers of type error-log-account-status-notification-handler have the following properties:
Indicates which types of event can trigger an account status notification.
None
Generate a notification whenever a user account has been disabled by an administrator.
Generate a notification whenever a user account has been enabled by an administrator.
Generate a notification whenever a user authentication has failed because the account has expired.
Generate a notification whenever a user account has been locked because it was idle for too long.
Generate a notification whenever a user account has been permanently locked after too many failed attempts.
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.
Generate a notification whenever a user account has been temporarily locked after too many failed attempts.
Generate a notification whenever a user account has been unlocked by an administrator.
Generate a notification whenever a user changes his/her own password.
Generate a notification whenever a user authentication has failed because the password has expired.
Generate a notification whenever a password expiration warning is encountered for a user password for the first time.
Generate a notification whenever a user's password is reset by an administrator.
Yes
Yes
None
No
No
Indicates whether the Account Status Notification Handler is enabled. Only enabled handlers are invoked whenever a related event occurs in the server.
None
true
false
No
Yes
None
No
No
Specifies the fully-qualified name of the Java class that provides the Error Log Account Status Notification Handler implementation.
org.opends.server.extensions.ErrorLogAccountStatusNotificationHandler
A Java class that implements or extends the class(es): org.opends.server.api.AccountStatusNotificationHandler
No
Yes
The Account Status Notification Handler must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Account Status Notification Handlers of type smtp-account-status-notification-handler have the following properties:
Specifies which attribute in the user's entries may be used to obtain the email address when notifying the end user. You can specify more than one email address as separate values. In this case, the OpenDJ server sends a notification to all email addresses identified.
If no email address attribute types are specified, then no attempt is made to send email notification messages to end users. Only those users specified in the set of additional recipient addresses are sent the notification messages.
The name of an attribute type defined in the server schema.
Yes
No
None
No
No
Indicates whether the Account Status Notification Handler is enabled. Only enabled handlers are invoked whenever a related event occurs in the server.
None
true
false
No
Yes
None
No
No
Specifies the fully-qualified name of the Java class that provides the SMTP Account Status Notification Handler implementation.
org.opends.server.extensions.SMTPAccountStatusNotificationHandler
A Java class that implements or extends the class(es): org.opends.server.api.AccountStatusNotificationHandler
No
Yes
The Account Status Notification Handler must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Specifies the subject that should be used for email messages generated by this account status notification handler. The values for this property should begin with the name of an account status notification type followed by a colon and the subject that should be used for the associated notification message. If an email message is generated for an account status notification type for which no subject is defined, then that message is given a generic subject.
None
A String
Yes
Yes
None
No
No
Specifies the path to the file containing the message template to generate the email notification messages. The values for this property should begin with the name of an account status notification type followed by a colon and the path to the template file that should be used for that notification type. If an account status notification has a notification type that is not associated with a message template file, then no email message is generated for that notification.
None
A String
Yes
Yes
None
No
No
Specifies an email address to which notification messages are sent, either instead of or in addition to the end user for whom the notification has been generated. This may be used to ensure that server administrators also receive a copy of any notification messages that are generated.
If no additional recipient addresses are specified, then only the end users that are the subjects of the account status notifications receive the notification messages.
A String
Yes
No
None
No
No
Indicates whether an email notification message should be sent as HTML. If this value is true, email notification messages are marked as text/html. Otherwise outgoing email messages are assumed to be plaintext and marked as text/plain.
false
true
false
No
No
None
Yes (Use --advanced in interactive mode.)
No
Indicates whether an email notification message should be generated and sent to the set of notification recipients even if the user entry does not contain any values for any of the email address attributes (that is, in cases when it is not be possible to notify the end user). This is only applicable if both one or more email address attribute types and one or more additional recipient addresses are specified.
true
true
false
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
Specifies the email address from which the message is sent. Note that this does not necessarily have to be a legitimate email address.
None
A String
No
Yes
None
No
No