dsconfig get-alert-handler-prop — Shows Alert Handler properties
dsconfig get-alert-handler-prop {options}
The dsconfig get-alert-handler-prop command takes the following options:
--handler-name {name}The name of the Alert Handler.
Alert Handler properties depend on the Alert Handler type, which depends on the {name} you provide.
By default, OpenDJ directory server supports the following Alert Handler types:
Default {name}: JMX Alert Handler
Enabled by default: true
See the section called “JMX Alert Handler” for the properties of this Alert Handler type.
Default {name}: SMTP Alert Handler
Enabled by default: true
See the section called “SMTP Alert Handler” for the properties of this Alert Handler type.
--property {property}The name of a property to be displayed.
Alert Handler properties depend on the Alert Handler type, which depends on the {property} you provide.
By default, OpenDJ directory server supports the following Alert Handler types:
Default {property}: JMX Alert Handler
Enabled by default: true
See the section called “JMX Alert Handler” for the properties of this Alert Handler type.
Default {property}: SMTP Alert Handler
Enabled by default: true
See the section called “SMTP Alert Handler” for the properties of this Alert Handler type.
-E | --recordModifies the display output to show one property value per line.
Alert Handler properties depend on the Alert Handler type, which depends on the null you provide.
By default, OpenDJ directory server supports the following Alert Handler types:
Default null: JMX Alert Handler
Enabled by default: true
See the section called “JMX Alert Handler” for the properties of this Alert Handler type.
Default null: SMTP Alert Handler
Enabled by default: true
See the section called “SMTP Alert Handler” for the properties of this Alert 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).
Alert Handler properties depend on the Alert Handler type, which depends on the {unit} you provide.
By default, OpenDJ directory server supports the following Alert Handler types:
Default {unit}: JMX Alert Handler
Enabled by default: true
See the section called “JMX Alert Handler” for the properties of this Alert Handler type.
Default {unit}: SMTP Alert Handler
Enabled by default: true
See the section called “SMTP Alert Handler” for the properties of this Alert 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).
Alert Handler properties depend on the Alert Handler type, which depends on the {unit} you provide.
By default, OpenDJ directory server supports the following Alert Handler types:
Default {unit}: JMX Alert Handler
Enabled by default: true
See the section called “JMX Alert Handler” for the properties of this Alert Handler type.
Default {unit}: SMTP Alert Handler
Enabled by default: true
See the section called “SMTP Alert Handler” for the properties of this Alert Handler type.
Alert Handlers of type jmx-alert-handler have the following properties:
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.
If there is a set of enabled alert types, then only alerts with one of those types are allowed. Otherwise, all alerts are allowed.
A String
Yes
No
None
No
No
Indicates whether the Alert Handler is enabled.
None
true
false
No
Yes
None
No
No
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.
All alerts with types not included in the set of disabled alert types are allowed.
A String
Yes
No
None
No
No
Specifies the fully-qualified name of the Java class that provides the JMX Alert Handler implementation.
org.opends.server.extensions.JMXAlertHandler
A Java class that implements or extends the class(es): org.opends.server.api.AlertHandler
No
Yes
The Alert Handler must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Alert Handlers of type smtp-alert-handler have the following properties:
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.
If there is a set of enabled alert types, then only alerts with one of those types are allowed. Otherwise, all alerts are allowed.
A String
Yes
No
None
No
No
Indicates whether the Alert Handler is enabled.
None
true
false
No
Yes
None
No
No
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.
All alerts with types not included in the set of disabled alert types are allowed.
A String
Yes
No
None
No
No
Specifies the fully-qualified name of the Java class that provides the SMTP Alert Handler implementation.
org.opends.server.extensions.SMTPAlertHandler
A Java class that implements or extends the class(es): org.opends.server.api.AlertHandler
No
Yes
The Alert Handler must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Specifies the body that should be used for email messages generated by this alert handler. The token "%%%%alert-type%%%%" is dynamically replaced with the alert type string. The token "%%%%alert-id%%%%" is dynamically replaced with the alert ID value. The token "%%%%alert-message%%%%" is dynamically replaced with the alert message. The token "\n" is replaced with an end-of-line marker.
None
A String
No
Yes
None
No
No
Specifies the subject that should be used for email messages generated by this alert handler. The token "%%%%alert-type%%%%" is dynamically replaced with the alert type string. The token "%%%%alert-id%%%%" is dynamically replaced with the alert ID value. The token "%%%%alert-message%%%%" is dynamically replaced with the alert message. The token "\n" is replaced with an end-of-line marker.
None
A String
No
Yes
None
No
No
Specifies an email address to which the messages should be sent. Multiple values may be provided if there should be more than one recipient.
None
A String
Yes
Yes
None
No
No
Specifies the email address to use as the sender for messages generated by this alert handler.
None
A String
No
Yes
None
No
No