Managing Alarm rules

The Alarm rules page is used to activate or deactivate alarm exporter rules and to define alarm targets and target groups. An alarm rule consists of the criteria by which alarms can be selected. You can define the targets or the target groups that the alarms are exported.

About this task

Allows the user to create and modify alarm targets and target groups. Threshold violation alarms can be exported to the following targets:
  1. IBM® Tivoli® Netcool®/OMNIbus
  2. Kafka
  3. SNMP Trap
Note: Create targets first, followed by target groups and Alarm rules.

Procedure

  • Click Administration > General > Alarm rules.

    You can see the Alarm rules page that has a grid with configured Alarm rules and their details.

Searching and refreshing the Alarm rules

  • Click the Refresh (refresh button) icon to display the latest set of Alarm rules.
  • Click the Search (search button) icon and provide a search string to filter specific Alarm rules from the table.

Creating new alarm rule

  • Click Create new and enter the following details in the Create new Alarm Rule page:
    Table 1. Entering values in Create New Alarm Rule page
    Field Details
    Rule name Specify a name for the rule.
    Alarm types
    • Target
      The following are the targets where the violations can be exported to.
      • OMNIbus
      • Kafka
      • SNMP Trap

        SNMP traps are basic alarm messages from SNMP-enabled devices.

    • Target groups
  • Click Save.

    You can see the new rule in the grid in Alarm rules page.

  • Click the More actions (more actions icon) icon to disable or enable a rule.
    By default, the Alarm rule is enabled.

Creating targets

  • Click the Targets tab in Alarm rules page.
  • Click Create new and enter the following details in the Create New Target page:
    Table 2. Entering values in Create new Target page
    Field Details
    Target name Specify a name for the Target.
    Target type Select from the options.
    • OMNIbus

      Generated threshold violation data is sent to IBM Tivoli Netcool/OMNIbus for alarm viewing.

      Note: You cannot create two targets with OMNIbus.
    • Kafka
      Provide the additional mandatory details.
      • Kafka Broker List
        List of Kafka broker hosts. For example,
        <kafka_broker_host>:<kafka_broker_
        port>

        You can use multiple Kafka brokers that are available in your cluster. Use a comma-separated list.

      • Kafka Topic

        Name of the topic to which the violated metrics and their values are written to.

    • SNMP Trap

      SNMP Traps are alert messages that are sent from a remote SNMP-enabled device to a central collector, called as SNMP manager such as IBM Tivoli Netcool/OMNIbus.

      Enter the following details:
      • SNMP Version
        • v2c
        • v3
      • SNMP Host
      • SNMP Port
      • Read Community
      • Level
        It is applicable for SNMP V3 version only. It has these options.
        • noAuthNoPriv
        • authNoPriv
        • authPriv
      • Security name

        It is applicable for SNMP V3 version only for all levels.

      • Auth type

        It is applicable for authNoPriv and authPriv levels

      • Auth password

        It is applicable for authNoPriv and authPriv levels

        Note: The minimum length of the password must be eight characters.
      • Priv type

        It is applicable for authPriv level only.

      • Priv password

        It is applicable for authPriv level only.

        Note: The minimum length of the password must be eight characters.
      • Context name

        It is applicable for SNMP V3 version only for all levels.

  • Click Save.

    You can see the new target in the grid in Targets page.

Creating new target group

  • Click the Targets groups tab in Alarm rules page.
  • Click Create new and enter the following details in the Create new Group page:
    Table 3. Entering values in Create new Target page
    Field Details
    Target group name Specify a name for the Target group.
    Target type Select from the available Targets that are created and available on Targets page. it helps in creating a group of targets that you can send the violations to raise alarms.

    Select a single or multiple targets from the Available Targets pane and click Add (>) icon to move it to the Selected Targets pane.

    You can also click Add all (Add all icon) to move all the Targets to a group.

  • Click Save.

    You can see the new target group in the grid in Target groups page.

Editing Alarm rules, Targets, and Target groups

  • Click the Edit (Edit icon) icon in Actions column to update an existing item in Alarm rules, Targets, or Target groups pages.
  • Make the changes as needed and click Update.
    The changes are written to the selected entry.
  • Click Save as to save the changes to new entry.

Deleting Alarm rules, Targets, and Target groups

  • Select a single entry from the table and click the (Delete icon) icon from the Action column to delete and click Confirm.
  • Click OK.
  • Select multiple entries from the table and click the Delete icon from the blue ribbon and click Confirm.
  • Click OK.
    Note: You cannot delete a Target if it is associated with a Target group. Delete the Target group first to delete the Target.

Importing and exporting the Alarm rules, Targets, and Target groups

  • Click the Import (refersh button) icon to import items in Alarm rules, Targets, and Targets groups pages from an external backup file.

    Make sure to be on the page for the item you want to import. This option is useful in migration scenario.

    It displays the number of items that are imported from the selected JSON file.
    Note: Import overwrites the existing entries, if any. When you import your JSON file for an existing alarm rule, it overwrites and updates the alarm rule data with the values in the JSON file.
  • Select the items from the grid that you want to export to a JSON file and click Export (export button) and save the JSON file.