dsconfig create-alert-handler
Prev | dsconfig Subcommands Reference | Next

## Name

dsconfig create-alert-handler — Creates Alert Handlers

## Synopsis

`dsconfig create-alert-handler` {options}

## Description

Creates Alert Handlers.

## Options

The dsconfig create-alert-handler command takes the following options:

`--handler-name {name}`

  The name of the new 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:

  jmx-alert-handler

    Default {name}: JMX Alert Handler

    Enabled by default: true

    See the section called “JMX Alert Handler” for the properties of this Alert Handler type.

  smtp-alert-handler

    Default {name}: SMTP Alert Handler

    Enabled by default: true

    See the section called “SMTP Alert Handler” for the properties of this Alert Handler type.

`--set {PROP:VALUE}`

  Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it.

  Alert Handler properties depend on the Alert Handler type, which depends on the `--handler-name {name}` option.

`-t | --type {type}`

  The type of Alert Handler which should be created. The value for TYPE can be one of: custom | jmx | smtp.

  Alert Handler properties depend on the Alert Handler type, which depends on the {type} you provide.

  By default, OpenDJ directory server supports the following Alert Handler types:

  jmx-alert-handler

    Default {type}: JMX Alert Handler

    Enabled by default: true

    See the section called “JMX Alert Handler” for the properties of this Alert Handler type.

  smtp-alert-handler

    Default {type}: SMTP Alert Handler

    Enabled by default: true

    See the section called “SMTP Alert Handler” for the properties of this Alert Handler type.

## JMX Alert Handler

Alert Handlers of type jmx-alert-handler have the following properties:

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

    A String

  Multi-valued

    Yes

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

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

  Advanced Property

    No

  Read-only

    No

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

    A String

  Multi-valued

    Yes

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

java-class
  Description

    Specifies the fully-qualified name of the Java class that provides the JMX Alert Handler implementation.

  Default Value

    org.opends.server.extensions.JMXAlertHandler

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.api.AlertHandler

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The Alert Handler must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

## SMTP Alert Handler

Alert Handlers of type smtp-alert-handler have the following properties:

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

    A String

  Multi-valued

    Yes

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

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

  Advanced Property

    No

  Read-only

    No

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

    A String

  Multi-valued

    Yes

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

java-class
  Description

    Specifies the fully-qualified name of the Java class that provides the SMTP Alert Handler implementation.

  Default Value

    org.opends.server.extensions.SMTPAlertHandler

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.api.AlertHandler

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The Alert Handler must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

message-body
  Description

    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.

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

message-subject
  Description

    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.

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

recipient-address
  Description

    Specifies an email address to which the messages should be sent. Multiple values may be provided if there should be more than one recipient.

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    Yes

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

sender-address
  Description

    Specifies the email address to use as the sender for messages generated by this alert handler.

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

Prev | Up | Next
dsconfig create-account-status-notification-handler | Home | dsconfig create-backend