Alarms¶

NETCONF alarms can be configured on Virtual Service Router. Those alarms are triggered when an event occurs on the system, for instance when a configured service or interface goes down.

When an alarm is triggered or cleared, a NETCONF notification is sent, and the alarm status change is stored. Then, when the problem is resolved, the alarm will clear itself.

The alarms are enabled by default.

System alarms¶

Here is a configuration that will ensure that only the last four status changes are stored, and that all state changes are notified.

vsr running config# / system alarm max-alarm-status-changes 4
vsr running config# / system alarm notify-status-changes all-state-changes

To show the list of available alarms, use show alarm inventory or show state system alarm alarm-inventory.

vsr> show alarm inventory
show-alarm-inventory
    alarm-type service-alarm ipv6-autoconf
        description "Monitor the ipv6-autoconf service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type link-alarm bridge
        description "Monitor the bridge link status. A link is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm certificate-expiration
        description "Monitor the certificate expiration."
        will-clear true
        severity-level major
        severity-level critical
        ..
    alarm-type service-alarm dhcp-relay
        description "Monitor the dhcp-relay service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm dhcp-server
        description "Monitor the dhcp-server service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm dns-server
        description "Monitor the dns-server service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm fast-path
        description "Monitor the fast-path service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type link-alarm gre
        description "Monitor the gre link status. A link is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type link-alarm gretap
        description "Monitor the gretap link status. A link is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type link-alarm ipip
        description "Monitor the ipip link status. A link is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type link-alarm lag
        description "Monitor the lag link status. A link is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm lldp
        description "Monitor the lldp service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm syslog
        description "Monitor the syslog service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type link-alarm loopback
        description "Monitor the loopback link status. A link is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm netconf-snmp
        description "Monitor the netconf-snmp service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm ntp
        description "Monitor the ntp service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type link-alarm physical
        description "Monitor the physical link status. A link is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm snmp
        description "Monitor the snmp service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm ssh-server
        description "Monitor the ssh-server service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type link-alarm veth
        description "Monitor the veth link status. A link is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type link-alarm vlan
        description "Monitor the vlan link status. A link is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type link-alarm vxlan
        description "Monitor the vxlan link status. A link is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm embedded
        description "Monitor the confirm pending leaf that tells when a reboot is scheduled."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm ha-neighbor
        description "Monitor the ha-neighbor service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm ha-conntrack
        description "Monitor the ha-conntrack service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm ipfix
        description "Monitor the ipfix service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm ipoe-server
        description "Monitor the ipoe-server service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm kpi
        description "Monitor the kpi service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm license
        description "Monitor the license service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm license-connected
        description "Monitor the license server connectivity."
        will-clear true
        severity-level warning
        severity-level minor
        severity-level major
        severity-level critical
        ..
    alarm-type service-alarm license-valid
        description "Monitor the license validity."
        will-clear true
        severity-level critical
        ..
    alarm-type link-alarm pppoe
        description "Monitor the pppoe link status. A link is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm bgp
        description "Monitor the bgp service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm isis
        description "Monitor the isis service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm ldp
        description "Monitor the ldp service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm nhrp
        description "Monitor the nhrp service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm ospf
        description "Monitor the ospf service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm ospf6
        description "Monitor the ospf6 service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm rip
        description "Monitor the rip service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm ripng
        description "Monitor the ripng service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm pim
        description "Monitor the pim service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm ike
        description "Monitor the ike service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type link-alarm svti
        description "Monitor the svti link status. A link is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm sflow
        description "Monitor the sflow service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm twamp-server
        description "Monitor the twamp-server service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm twamp-client
        description "Monitor the twamp-client service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type link-alarm gtp
        description "Monitor the gtp link status. A link is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm pfcp
        description "Monitor the pfcp service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type link-alarm vrrp
        description "Monitor the vrrp link status. A link is monitored only if configured."
        will-clear true
        severity-level major
        ..
    alarm-type service-alarm vrrp
        description "Monitor the vrrp service status. A service is monitored only if configured."
        will-clear true
        severity-level major
        ..
    ..

To show the list of alarms that have been triggered on the system, use show alarm list or show state system alarm alarm-list. Let’s trigger an alarm to be shown.

vsr running config# / vrf main interface loopback lo1 ipv4 address 1.1.1.1/24

vsr> show alarm list
show-alarm-list
    number-of-alarms 1
    last-changed 2024-09-18T13:31:24.270370+02:00
    alarm "/vrf[name=\"main\"]/interface/loopback[name=\"lo1\"]/enabled" link-alarm loopback
        time-created 2024-09-18T13:31:24.161737+02:00
        is-cleared true
        last-raised 2024-09-18T13:31:24.161724+02:00
        last-changed 2024-09-18T13:31:24.270370+02:00
        perceived-severity major
        alarm-text "The lo1 loopback is up as configured in vrf main."
        status-change 2024-09-18T13:31:24.270370+02:00
            perceived-severity cleared
            alarm-text "The lo1 loopback is up as configured in vrf main."
            ..
        status-change 2024-09-18T13:31:24.161724+02:00
            perceived-severity major
            alarm-text "The lo1 loopback is unknown when configured up in vrf main."
            ..
        ..
    ..

To show a summary of the alarm state, use show alarm summary, or show state system alarm summary.

vsr> show alarm summary
show-alarm-summary
    alarm-summary indeterminate
        total 0
        not-cleared 0
        cleared 0
        ..
    alarm-summary warning
        total 0
        not-cleared 0
        cleared 0
        ..
    alarm-summary minor
        total 0
        not-cleared 0
        cleared 0
        ..
    alarm-summary major
        total 1
        not-cleared 0
        cleared 1
        ..
    alarm-summary critical
        total 0
        not-cleared 0
        cleared 0
        ..
    ..

The alarms can be compressed (i.e. only the last status change is kept) using the cmd compress-alarm command. They can be removed using the flush alarm command.

User alarms¶

As mentioned above, static alarms are automatically generated at startup. With user alarms, it is possible to manually configure alarms offering enhanced customization and flexibility in alert management.

In this example, an alarm is triggered when an ICMP tracker named ICMP-TRACKER goes down.

First, purge any residual alarm, and create a loopback interface with its tracker as well as the alarm configuration:

vsr> flush alarm alarm-clearance-status any
purge-alarm
    purged-alarms 1
    ..

vsr running config# / vrf main interface loopback lo1 ipv4 address 1.1.1.1/24
vsr running config# / tracker icmp ICMP-TRACKER address 1.1.1.1 vrf main
vsr running config# / system alarm alarm-inventory alarm-type user-alarm icmp-tracker-down description "Alarm raising when the ICMP tracker ICPM-TRACKER goes down."
vsr running config#! / system alarm alarm-inventory alarm-type user-alarm icmp-tracker-down resource "/tracker/icmp[name='ICMP-TRACKER']/state"
vsr running config#! / system alarm alarm-inventory alarm-type user-alarm icmp-tracker-down severity-level-trigger critical text "Tracker ICMP-TRACKER {value}, alarm {name}"
vsr running config# / system alarm alarm-inventory alarm-type user-alarm icmp-tracker-down severity-level-trigger critical equal down
vsr running config# / system alarm alarm-inventory alarm-type user-alarm icmp-tracker-down severity-level-trigger cleared text "Tracker ICMP-TRACKER {value}"

vsr> show state / system alarm alarm-inventory alarm-type user-alarm
alarm-type user-alarm icmp-tracker-down
    severity-level-trigger critical
        text "Tracker ICMP-TRACKER {value}, alarm {name}"
        equal down
        ..
    severity-level-trigger cleared
        text "Tracker ICMP-TRACKER {value}"
        ..
    resource "/tracker/icmp[name='ICMP-TRACKER']/state"
    description "Alarm raising when the ICMP tracker ICPM-TRACKER goes down."
    will-clear true
    severity-level critical
    ..

Note

The path to the resource must contain outer quotes if it contains any inside as in our example. Otherwise, the inner quotes will be deleted by nc-cli and the path will become incorrect.

Then, disable the interface to trigger the alarm:

vsr running config# / vrf main interface loopback lo1 enabled false

vsr> show alarm list
show-alarm-list
    number-of-alarms 2
    last-changed 2024-09-18T13:31:28.672671+02:00
    alarm "/vrf[name=\"main\"]/interface/loopback[name=\"lo1\"]/enabled" link-alarm loopback
        time-created 2024-09-18T13:31:28.619657+02:00
        is-cleared true
        last-raised 2024-09-18T13:31:28.619647+02:00
        last-changed 2024-09-18T13:31:28.667757+02:00
        perceived-severity major
        alarm-text "The lo1 loopback is down as configured in vrf main."
        status-change 2024-09-18T13:31:28.667757+02:00
            perceived-severity cleared
            alarm-text "The lo1 loopback is down as configured in vrf main."
            ..
        status-change 2024-09-18T13:31:28.619647+02:00
            perceived-severity major
            alarm-text "The lo1 loopback is up when configured down in vrf main."
            ..
        ..
    alarm "/vrouter:state/vrouter-tracker:tracker/vrouter-pm:icmp[name='ICMP-TRACKER']/state" user-alarm icmp-tracker-down
        time-created 2024-09-18T13:31:28.672680+02:00
        is-cleared false
        last-raised 2024-09-18T13:31:28.672671+02:00
        last-changed 2024-09-18T13:31:28.672671+02:00
        perceived-severity critical
        alarm-text "Tracker ICMP-TRACKER down, alarm icmp-tracker-down"
        status-change 2024-09-18T13:31:28.672671+02:00
            perceived-severity critical
            alarm-text "Tracker ICMP-TRACKER down, alarm icmp-tracker-down"
            ..
        ..
    ..

And finally, reenable the interface to clear the alarm:

vsr running config# / vrf main interface loopback lo1 enabled true

vsr> show alarm list
show-alarm-list
    number-of-alarms 2
    last-changed 2024-09-18T13:31:29.891805+02:00
    alarm "/vrf[name=\"main\"]/interface/loopback[name=\"lo1\"]/enabled" link-alarm loopback
        time-created 2024-09-18T13:31:28.619657+02:00
        is-cleared true
        last-raised 2024-09-18T13:31:29.828816+02:00
        last-changed 2024-09-18T13:31:29.886275+02:00
        perceived-severity major
        alarm-text "The lo1 loopback is up as configured in vrf main."
        status-change 2024-09-18T13:31:29.886275+02:00
            perceived-severity cleared
            alarm-text "The lo1 loopback is up as configured in vrf main."
            ..
        status-change 2024-09-18T13:31:29.828816+02:00
            perceived-severity major
            alarm-text "The lo1 loopback is down when configured up in vrf main."
            ..
        status-change 2024-09-18T13:31:28.667757+02:00
            perceived-severity cleared
            alarm-text "The lo1 loopback is down as configured in vrf main."
            ..
        status-change 2024-09-18T13:31:28.619647+02:00
            perceived-severity major
            alarm-text "The lo1 loopback is up when configured down in vrf main."
            ..
        ..
    alarm "/vrouter:state/vrouter-tracker:tracker/vrouter-pm:icmp[name='ICMP-TRACKER']/state" user-alarm icmp-tracker-down
        time-created 2024-09-18T13:31:28.672680+02:00
        is-cleared true
        last-raised 2024-09-18T13:31:28.672671+02:00
        last-changed 2024-09-18T13:31:29.891805+02:00
        perceived-severity critical
        alarm-text "Tracker ICMP-TRACKER up"
        status-change 2024-09-18T13:31:29.891805+02:00
            perceived-severity cleared
            alarm-text "Tracker ICMP-TRACKER up"
            ..
        status-change 2024-09-18T13:31:28.672671+02:00
            perceived-severity critical
            alarm-text "Tracker ICMP-TRACKER down, alarm icmp-tracker-down"
            ..
        ..
    ..

The same configuration can be made using this NETCONF XML configuration:

vsr> show config xml absolute / system alarm
<config xmlns="urn:6wind:vrouter">
  <system xmlns="urn:6wind:vrouter/system">
    <alarm xmlns="urn:6wind:vrouter/alarm">
      <enabled>true</enabled>
      <max-alarm-status-changes>4</max-alarm-status-changes>
      <notify-status-changes>all-state-changes</notify-status-changes>
      <alarm-inventory>
        <alarm-type>
          <alarm-type-id>user-alarm</alarm-type-id>
          <alarm-type-qualifier>icmp-tracker-down</alarm-type-qualifier>
          <severity-level-trigger>
            <severity-level-id>critical</severity-level-id>
            <text>Tracker ICMP-TRACKER {value}, alarm {name}</text>
            <equal>down</equal>
          </severity-level-trigger>
          <severity-level-trigger>
            <severity-level-id>cleared</severity-level-id>
            <text>Tracker ICMP-TRACKER {value}</text>
          </severity-level-trigger>
          <resource>/tracker/icmp[name='ICMP-TRACKER']/state</resource>
          <description>Alarm raising when the ICMP tracker ICPM-TRACKER goes down.</description>
        </alarm-type>
      </alarm-inventory>
    </alarm>
  </system>
</config>