Skip to content

Alarms#

An alarm is an unexpected condition in Nokia Event-Driven Automation (EDA) or the Nokia EDA-managed network that can be cleared by attaining some corrective state. The primary purpose of an alarm is to bring some abnormal condition to the attention of an operator, and thereby support debugging and resolution.

Note

An alarm is distinct from an event. An alarm represents a condition that should be corrected by reaching some associated corrective state. An event is a one-time occurrence and message (typically a log entry) about something that has occurred in the system. No future state is expected to clear an event, and it does not require an action to clear. Alarms are stateful; events are not.

Alarms in Nokia EDA can arise from a variety of sources, including the Nokia EDA system itself and the wide array of supported apps. For any alarm, the source/affected object is identified as part of the alarm in the resource, group, and kind fields.

Alarms are also associated with a namespace; this could be the base Nokia EDA namespace, or some other namespace. Users can only see and interact with alarms in namespaces for which they have access permissions.

Some alarms can be generated by intent-based apps within Nokia EDA. Nokia EDA treats such alarms as having been cleared if the app stops reporting that alarm.

Alarms associated with apps are described in documentation for individual apps.

Alarms on standby clusters#

Standby cluster alarms can be important in understanding the state of redundancy in a Nokia EDA cluster. It is therefore useful to be able to see alarms generated on a standby cluster member even when working with the active member.

Nokia EDA supports this using the cluster_member field, which is set to the name of the cluster member that raised the alarm. This allows an operator to view alarms for all clusters, but still distinguish alarms for the active cluster from those for a standby cluster. For alarms that are not cluster-specific, this field remains unset.

Alarm definitions#

Alarm definitions for all alarms generated by the core and installed apps are available in the System Administration > Alarm Management > Alarm Definitions page of the Nokia EDA UI.

The alarm definition specifications include the following fields:

Table: Alarm definition specifications

Specification Description
SourceGroup Specifies the group of the resource that raises the alarm, for example, interfaces.eda.nokia.com.
Identifies the application that raises the alarm. Nokia EDA core alarms have the source group core.eda.nokia.com.
Type Specifies the alarm type, for example, InterfaceDown.
Description Specifies the description of the alarm.
ClusterSpecific If this specification is true, the alarm is raised against a specific Nokia EDA cluster.
For example, a raised DeploymentDegraded alarm specifies which Nokia EDA cluster (active or standby) has a Kubernetes Deployment with one or more replicas that are not running.
Severity (optional) Specifies alarm severity.
If not set, the alarm severity is variable. For example, the CPUThresholdExceeded alarm increases severity based on the CPU utilization value.
Kind and Group (optional) Specifies the Kind and Group of the resource which the alarm is associated with.
For example, an InterfaceDown alarm is raised against an Interface resource. The Kind is Interface and the Group is interfaces.eda.nokia.com.

Note

An alarm definition is unique to the combination of SourceGroup and Type specifications. For example, both the Routing and Services apps can raise an alarm type BFDSessionDown. These are separate alarm definitions.

Alarm policies#

Alarm policies modify the default properties of alarms. For each policy, you can configure one of the following actions:

  • Override alarm severity. If an alarm matches multiple policies, the highest override severity applies.
  • Auto-suppress the alarm.
  • Auto-acknowledge the alarm.

Alarm policies specify one or more of the following match criteria to limit the scope of the policy:

  • Alarms in a specific namespace.
  • Alarms of a specific type.
  • Alarms raised against a resource kind or specific resource instance.
  • Alarms affecting specific targets.

Note

Alarms may have multiple affected targets. A policy action is applied only if that action is applicable to all affected targets of the alarm.

For example, if an alarm policy is created to suppress alarms affecting node "leaf-1", an alarm affecting both "leaf-1" and "leaf-2" will not be suppressed (assuming no other policies exist). If an alarm policy also exists to suppress "leaf-2", alarms affecting "leaf-1" and "leaf-2" will be suppressed.

Alarm policies are applied retroactively to active alarms. Similarly, when a policy is deleted the policy action is undone from the matching active alarms.

Alarms in the EDA UI#

The Nokia EDA GUI includes several summary views of alarms known to Nokia EDA:

  • An alarm summary is displayed on the Home page.
  • A more detailed summary of alarms is displayed on the main Alarms Summary page
  • The Alarms list displays a list of all active alarms

From the Alarm list, you can do the following for individual alarms, or as a bulk operation to a number of concurrently selected alarms:

  • Suppress an alarm: this sets the suppressed flag for the current instance of the alarm. By default, suppressed alarms are not displayed in the Nokia EDA GUI.

    Note

    You can still view suppressed alarms by choosing "Show all alarms" from the Alarm List Table Settings and Actions menu.

  • Delete an alarm: this removes all history of the alarm. Deletion is only allowed for cleared alarms. The option is disabled for active alarms.

  • Acknowledge an alarm: this sets the Acknowledged flag for the current instance of the alarm.

The Alarms Summary page#

The Alarms Summary page
The Alarms Summary page

Table: Elements of the Alarms Summary page

# Dashlet Description
1 Active Alarms count This dashlet displays the total count of active alarms affecting Nokia EDA applications and the Nokia EDA platform itself. This dashlet also displays the count of acknowledged and unacknowledged alarms.
2 Suppressed Alarms This dashlet displays the count of suppressed alarms.
3 Active Alarms By Severity This dashlet displays active alarms by severity.
4 Active Alarms By Type This dashlet displays active alarms by type.
5 Active Alarms By Alarmed Resource This dashlet displays the count of alarms by resource and displays the group, kind and cluster name for each resource.

The Alarms list page #

The Alarms list
The Alarms list

Table: Elements of the Alarms list

# Name Function
1 Alarms menu The Alarms menu includes:
  • common table controls
  • multi-row actions unique to alarms
  • special actions unique to the alarms list
2 Alarm count Displays the number of current alarms of various severities.
3 Alarm quick filters Allows you to hide alarms using the following filters:
  • Cleared – filters out cleared alarms
  • Suppressed – filters out suppressed alarms
  • Child alarms – filters out child alarms
These filters are all selected by default.

The list of alarms displays the following columns by default.

Table: Default alarm display columns

Column Description
Namespace Indicates the namespace to which the alarm belongs.Alarms that are not specific to a namespace, such as platform certificate alarms, do not have or display a namespace value.
Type The alarm type, as defined by the alarm itself. For example, InterfaceDown.
Severity The importance of the alarm, as defined by the alarm itself. Supported severities are:
  • Critical
  • Major
  • Minor
  • Warning

You can click this column to sort by severity level.
Resource Indicates the name of the resource that this alarm is present on.
  • For example, if an alarm was raised against a Fabric, the endpoint would be set to the name of the specific instance of a Fabric the alarm was raised against.
  • A resource may also be an instance of a resource in the Kubernetes cluster where EDA is deployed. For example, the resource may be the name of a Pod.
Kind Indicates the kind of resource the alarm is present on.
  • For example, this is set to Fabric if an alarm is raised against a Fabric resource.
  • The kind may also be a component with the Nokia EDA core - for example, ConfigEngine or StateEngine.
Group Indicates the group of the resource the alarm is present on. For example, this is set to fabrics.eda.nokia.com if an alarm is raised against a Fabric.
Acknowledged Indicates whether the alarm has been acknowledged (True or False)
Occurrences The number of occurrences for the alarm.
Last Changed Indicates the time the alarm last changed state. The timestamp is updated any time an alarm changes state between cleared and not cleared.
Parent Alarms Indicates whether the alarm is associated with one or more parent alarms. It is common for alarms to have one or more parents. For example, an InterfaceDegraded alarm may be caused by one or more of its component members being down; that condition is itself the subject of a separate alarm. This column is visible if the Root cause only filter is turned off.

The following alarms can be optionally displayed in the list of alarms by selecting Manage columns from the Alarms menu.

Table: Non-default alarm display columns

Column Description
Name Indicates the name of the alarm.
Description The description of the alarm from the alarm's encoded Description field.
Cleared Whether the alarm has been cleared by an operator. Possible values are:
  • True
  • False
This column is visible if the Cleared filter is not selected.
Cluster Name For Nokia EDA platform alarms, the Nokia EDA cluster member to which the alarm applies.
Probable Cause The probable cause of the alarm, from the alarm's encoded Probable Cause field.
Remedial Action The suggested remedial action to resolve the alarm, from the alarm's encoded Remedial Action field.
Acknowledged Until If the alarm has been temporarily acknowledged, this indicates the date and time at which the acknowledgement expires.
Last Acknowledged Time Indicates the date and time when the most recent acknowledgement occurred for this alarm.
Last Acknowledged By Indicates the user who last acknowledged the alarm.
Suppressed Until If the alarm has been temporarily suppressed, this indicates the date and time at which the suppression expires. This column is visible if the Suppressed filter is not selected.
Suppressed Indicates whether the alarm has been suppressed. This column is visible if the Suppressed filter is not selected.
Last Suppressed Time Indicates the date and time when the most recent suppression occurred for this alarm.
Last Suppressed By Indicates the user who last suppressed the alarm.
Source Resource The Nokia EDA-managed resource from which the alarm originates.
Source Kind The kind of resource from which the alarm originates.
Source Group The group of the resource from which the alarm originates.
JS Paths The EDB entry which triggered the raising or clearing of the alarm, in JSPath notation. For example, if the alarm pertains to an interface operational state, this may be the JSPath: .node{.name=="spine-1"}.srl.interface{.name=="ethernet-1/14"}
Targets Affected Indicates the number of child items which show the correlation between an alarm and the target it affects.
Additional Text Indicates other specific details of the alarm instance.

The Alarms list page contains an Information panel that you can open by clicking the Expand/Contract control at the middle right of the page. The following figure shows an example of an expanded Alarms Information panel for a selected alarm.

The expanded Alarms Information panel
The expanded Alarms Information panel

The Information panel displays information about any selected alarm in the Alarms list. This information includes the following grouped and collapsible fields:

  • Alarm Summary – includes Name, Namespace, Type, Severity, Cleared, Resource, Description, Kind, Group, Occurrences, Acknowledged, and Last Changed fields
  • Remediation – includes Parent Alarms, Probable Cause, and Remedial Action fields
  • Additional Properties – includes Acknowledged Until, Last Acknowledged, Suppressed, Suppressed Until, Last Suppressed, Source Resource, Source Kind, Source Group, and JS Path fields

Fields that are empty or not applicable are hidden.

The following table describes the navigation from the Information panel to Parent Alarms and Resource locations.

Table: Information panel navigation details

Location Description
Alarm Summary > Resource Displays the resource information for the selected alarm.
Click Go to resource to view the details of the alarm resource.
Remediation > Parent Alarms Displays the parent alarm of the selected alarm.
Click Go to parent alarm to display the Details page for the parent alarm of the selected alarm.
Additional Properties > JS Paths Displays the JS path for the selected alarm.
Click Go to Query Builder to display the Query Builder page for the selected alarm.

Related information

Acknowledging an alarm #

When you acknowledge an alarm, you can:

  • Acknowledge the alarm permanently.
  • Acknowledge the alarm temporarily, after which the alarm returns to its unacknowledged state.

When you acknowledge an alarm temporarily, you can choose from a list of predefined periods, or select a specific time and date for the acknowledgement to expire.

Temporarily acknowledging an alarm
Temporarily acknowledging an alarm

Procedure

  1. In the Main navigation panel, select Alarms to open the Alarms page.

  2. Find the alarm in the list using the sorting and filtering controls.

  3. At the right side of the row, click the Table row actions button.

  4. Click Acknowledge from the list.

  5. Optionally, you can choose to acknowledge the alarm only temporarily by doing either of the following:

    • Click the drop-down control and click one of the standard periods displayed.
    • Click the drop-down control, then click Custom, and in the resulting window select a date and time for the acknowledgement to expire.
  6. Click Acknowledge to complete the acknowledgement of the alarm.

Acknowledging multiple alarms #

When you acknowledge multiple alarms, you can:

  • Acknowledge the alarms permanently
  • Acknowledge the alarms temporarily, after which all of the selected alarms return to their unacknowledged state.

When you acknowledge alarms temporarily, you can choose from a list of predefined periods, or select a specific time and date for the acknowledgement to expire.

Procedure

  1. In the Main navigation panel, select Alarms to open the Alarms page.

  2. Use the sorting and filtering controls to display the necessary set of alarms in the list.

  3. Select all of the alarms you want to acknowledge by checking the box at the left edge of the list. Click the check box again to unselect any alarm.

    Note

    To select all alarms in the list, check the check box in the title row. Click the check box again to unselect all alarms in the list.

    Note

    The number of alarms you have selected, as well as the total number of alarms, is indicated at the lower right of the Alarms page.

  4. At the upper right of the Alarms page, click the Table settings & actions button.

  5. Select Acknowledge from the list.

  6. Optionally, you can choose to acknowledge the alarm only temporarily by doing either of the following:

    • Click the drop-down control and click one of the standard periods displayed.
    • Click the drop-down control, then click Custom, and in the resulting window select a date and time for the acknowledgement to expire.
    • Click Acknowledge to complete the acknowledgement of the selected alarms.

Deleting a single alarm #

An alarm cannot be deleted unless it has first been cleared.

Procedure

  1. In the Main navigation panel, select Alarms to open the Alarms page.

  2. Find the alarm in the list using the sorting and filtering controls.

  3. At the right side of the row, click the Table row actions button.

  4. Click Delete from the list.

    Note

    The Delete option is not displayed for an alarm that has not been cleared.

  5. Click Confirm to complete the acknowledgement.

Deleting multiple alarms #

An alarm cannot be deleted unless it has first been cleared.

Procedure

  1. In the Main navigation panel, select Alarms to open the Alarms page.

  2. Use the sorting and filtering controls to display the necessary set of alarms in the list.

  3. Select all of the alarms you want to delete by checking the box at the left edge of the list. Click the check box again to unselect any alarm.

    Note

    To select all alarms in the list, check the check box in the title row. Click the check box again to unselect all alarms in the list.

    Note

    The number of alarms you have selected, as well as the total number of alarms, is indicated at the lower right of the Alarms page.

  4. At the upper right of the Alarms page, click the Table settings & actions button.

  5. Click Delete in the list.

  6. Click Confirm to complete the acknowledgement for all alarms.

    Note

    If some of the alarms you selected were not eligible for deletion, only those that were eligible are deleted by this operation. Ineligible alarms are not deleted. No error message displays in this case.

Suppressing a single alarm #

When you suppress an alarm, you can:

  • Suppress the alarm permanently.
  • Suppress the alarm temporarily, after which the alarm returns to its unsuppressed state.

When you suppress an alarm temporarily, you can choose from a list of predefined periods, or select a specific time and date for the suppression to expire.

Temporarily suppressing an alarm
Temporarily suppressing an alarm

Procedure

  1. In the Main navigation panel, select Alarms to open the Alarms page.

  2. Find the alarm in the list using the sorting and filtering controls.

  3. At the right side of the row, click the Table row actions button.

  4. Click Suppress from the list.

  5. Optionally, you can choose to suppress the alarm only temporarily by doing either of the following:

    • Click the drop-down control and click one of the standard periods displayed.
    • Click the drop-down control, then click Custom, and in the resulting window select a date and time for the suppression to expire.
  6. Click Confirm to complete the alarm suppression.

Note

By default, suppressed alarms are not displayed in the alarms list. Unless you have selected to show all alarms, suppressing an alarm causes it to vanish from the alarms list.

Suppressing multiple alarms #

Just as with single alarms, when you suppress multiple alarms, you can:

  • Suppress the alarms permanently
  • Suppress the alarms temporarily, after which all of the selected alarms return to their unsuppressed state.

When you suppress alarms temporarily, you can choose from a list of predefined periods, or select a specific time and date for the acknowledgement to expire.

Procedure

  1. In the Main navigation panel, select Alarms to open the Alarms page.

  2. Use the sorting and filtering controls to display the necessary set of alarms in the list.

  3. Select all of the alarms you want to delete by checking the box at the left edge of the list. Click the check box again to unselect any alarm.

    Note

    To select all alarms in the list, check the check box in the title row. Click the check box again to unselect all alarms in the list.

    Note

    The number of alarms you have selected, as well as the total number of alarms, is indicated at the lower right of the Alarms page.

  4. At the upper right of the Alarms page, click the Table settings & actions button.

  5. Select Suppress from the list.

  6. Optionally, you can choose to suppress the alarm only temporarily by doing either of the following:

    • Click the drop-down control and click one of the standard periods displayed.
    • Click the drop-down control, then click Custom, and in the resulting window select a date and time for the suppression to expire.
  7. Click Confirm to complete the suppression for all alarms.

Note

By default, suppressed alarms are not displayed in the alarms list. Unless you have selected to show all alarms, suppressing alarms causes them to vanish from the alarms list.

Viewing alarm details #

You can switch between the Alarm Details page and the Alarm History pages by selecting Details or History from the drop-down list at the upper right of the page.

The bread crumb path allows you to navigate from the Alarms Summary page to the Alarms Details or History page.

Bread crumb path and drop-down menu
Bread crumb path and drop-down menu

Procedure

  1. In the Main navigation panel, select Alarms to open the Alarms page.

  2. Find the alarm in the list using the sorting and filtering controls.

  3. Double-click the alarm.

    The Alarm Details page displays, which shows the Alarm Summary information including the following grouped fields:

    • Alarm Summary – includes Name, Namespace, Type, Severity, Cleared, Resource, Description, Kind, Group, Occurrences, Acknowledged, and Last Changed fields
    • Remediation – includes Parent Alarms, Probable Cause, and Remedial Action fields
    • Additional Properties – includes Acknowledged Until, Last Acknowledged, Suppressed, Suppressed Until, Last Suppressed, Source Resource, Source Kind, Source Group, and JS Path fields Fields that are empty or not applicable are hidden.

Viewing alarm history #

You can switch between the Alarm History and the Alarm Details pages by selecting Details or History from the drop-down list at the upper right of the page.

The bread crumb path allows you to navigate from the Alarms Summary page to the Alarms Details or History page.

Bread crumb path and drop-down list
Bread crumb path and drop-down list

Procedure

  1. In the Main navigation panel, select Alarms to open the Alarms page.

  2. Find the alarm in the list using the sorting and filtering controls.

  3. At the right side of the row, click the Table row actions button.

  4. Click History from the list.

    The Alarm History window displays, showing all events pertaining to the selected alarm including the following details:

    • Cleared (true/false)
    • Last change date and time
    • Probable cause
    • Remedial action
    • Acknowledged (true/false)
    • History of users who acknowledged You can use the standard sorting and filtering controls to manage the list.

Configuring alarm policies#

Procedure

  1. In the System Administration navigation panel, select Alarm Policies.

  2. Click Create to open the Alarm Policies form.

  3. Enter the name of the alarm policy you want to create.

  4. You can set the following optional alarm policy match criteria by toggling the specification on or off and entering the required information:

    • Namespace
    • Alarm Type
    • Alarm Resource
    • Targets Affected
  5. Select the action to apply to the matched alarms from the drop-down list:

    • Suppress
    • Acknowledge
    • ChangeSeverity
  6. Click Commit to immediately apply the changes, or click Add To Basket store these changes to be processed later as part of a transaction. Alternatively, select Dry Run to test your changes, so you can reveal and resolve any issues before proceeding.

Managing alarms with edactl#

You can use the edactl command to filter and manipulate alarms in the Nokia EDA system.

  • To select all alarms from all namespaces, use the following command:

    edactl alarms -A
    
  • To filter alarms based on whether they have been acknowledged, use the following command with the valid values of yes, no, and any, with the default value of any:

    edactl alarms --acknowledged yes
    
  • To filter alarms based on whether they have been suppressed, use the following command with the valid values of yes, no, and any, with the default value of no:

    edactl alarms --suppressed yes
    
  • To filter alarms based on state, use the following command with the valid values of cleared, active, and any, with the default value of active:

    edactl alarms --state cleared
    
  • To view alarms with a specific timestamp in RFC3339 format, without fractional seconds, use the following command:

    edactl alarms from <timestamp>
    

    For example, alarms prior to the following timestamp are not returned:

    edactl alarms  --from 2026-01-14T03:55:05Z
    
  • To view the history of an alarm, use the following boolean command:

    edactl alarms --history
    
  • To filter alarms based on the targetsAffected field, specify a TopoNode using the following command:

    edactl alarms --node leaf-1 -n eda