Werk #11361: Reworking of discovery rulesets for network interfaces and switch ports

Component Checks & agents
Title Reworking of discovery rulesets for network interfaces and switch ports
Date Aug 7, 2020
Checkmk Edition Checkmk Raw (CRE)
Checkmk Version 2.0.0i1
Level Prominent Change
Class New Feature
Compatibility Incompatible - Manual interaction might be required

Up to now, the discovery of network interfaces and switch ports was controlled by two main rules: "Network Interface and Switch Port Discovery" (discovery of single interfaces) and "Network interface groups" (grouping of interfaces). With this werk, we integrate "Network interface groups" into "Network Interface and Switch Port Discovery" and rework the latter. The rule "Network interface groups" is now deprecated and not applied any more.

The reworked discovery ruleset is split into three parts: the configuration of the discovery of single interfaces, the configuration of interfaces groups and conditions which determine to which interfaces this rule applies. In the following, we explain the changes in more detail.

  • In the first part, you can activate or deactivate the discovery of single interfaces. You can also configure the way monitored interfaces are represented, i.e., by index, by description or by alias.
  • The second part offers the option to group interfaces. Here, you can specify the names of the groups and they way the corresponding services display their members in the service output (again, by index, by description or by alias). Contrary to before, there is no separate option any more to define interface groups on clusters, since this option was anyway redundant.
  • The third part of the rule determines to which interfaces this rule applies. You can choose to apply this rule to all interfaces or you can set conditions such as a regular expression matching the interface description or a set of port types. Each interface will first determine the set of rules which actually applies to this interface and then merge these rules together, whereby rules higher up in the hierarchy (e.g. rules in subfolders) overwrite rules further below.
  • Note that due to the point above, this rule is a somewhat special case compared to other rulesets in checkmk. Usually, the conditions for a rule to apply are exclusively configured in the section "Conditions". However, here, you can set additional, interface-specific conditions, which offer a finer control over the discovery process.

This change is incompatible. It affects the following checks: aix_if, brocade_optical, emc_vplex_if, esx_vsphere_counters, fritz, hitachi_hnas_fc_if, hp_msa_if, hpux_if, if, if64, if64adm, if64_tplink, if_brocade, if_fortigate, if_lancom, lnx_if, mcdata_fcport, netapp_api_if, statgrab_net, ucs_bladecenter_if, vms_if, winperf_if.

For users monitoring interface groups, this change is definitely incompatible. They have to migrate their current rules for grouping interfaces from the now deprecated ruleset "Network interface groups" to the new discovery ruleset. Note that there is no option any more to discover interface groups instead of the corresponding single interfaces. To reproduce this behavior, configure your interfaces groups and switch off the discovery of single interfaces for the group members. After migrating the grouping rules, these users have to re-discover the services of affected hosts.

For all others users monitoring network interfaces, this change might be incompatible. Generally, any already discovered interface services will continue to work. However, depending on the user- defined rules from the (now reworked) ruleset "Network Interface and Switch Port Discovery", some interface services might vanish upon re-discovery or new interface services might appear. In such cases, users have to adapt the new, reworked versions of their user-defined rules.

Finally, it is worth noting that the new ruleset offers the option to match all interfaces, which allows for simplifying some rules. In particular, users might be able to simplify rules where all interface port types and states are selected.

To the list of all Werks