Templates

Print version

2. Templates

After successful installation, you can import any of the predefined templates. Each template is the collection of Zabbix Items corresponding to a set of OIDs, triggers, graphs and applications. The template can be easily linked to any monitored host (RAy3) allowing quick access to the required values.

2.1. What Templates do we Provide?

The Templates list:

  • Name: RAy3 Template

    • Consists of all specific OIDs provided by RACOM for RAy3 and OIDs for the Ethernet statistics

  • Name: PING Template

    • Pings a defined host and triggers whenever the host is unreachable

All templates can be downloaded from the RAy3 download site at https://www.racom.eu/download/hw/ray/free/eng/03b_fw/ray3-zabbix.zip.

2.1.1. How do I Import the RAy3 Templates?

In order to import the template, click on the Configuration → Templates button at the top of the Zabbix web page. Select the Import Template button at the top right corner.

Importing Template button

Fig. 2.1: Importing Template button


[Note]Note

Since Zabbix 3, Value mappings can be imported together with the template.

Importing Template options

Fig. 2.2: Importing Template options


Now you can see the RAy3 template in the Template list window along with the other default templates.

[Note]Note

If you already imported the template and you need to update it, just import the newer version with the same name and the current template will be automatically overwritten.

Each Item has a Description, SNMP OID number, community string, UDP port (161), key, update interval and other parameters assigned to it. One of the key parameters is the update interval, because it defines how often Zabbix will request various replies from the RAy3 stations. These intervals are different for individual OIDs and are predefined based on our experience. You could consider changing these to suit your needs. For more details, read Chapter 3, RAy3 Templates in Detail.

Individual items can be enabled or disabled.

Only monitor the values which you really need and with reasonable update times.

The items are divided into usage groups, called Applications in Zabbix. These applications serve to provide better clarification of the defined items.

If you wish to be notified whenever any monitored value is out of its threshold range, you can define a Trigger for this purpose. These notifications are viewable on the Zabbix dashboard, item history or you can have e-mail / jabber / sms notifications enabled. Each notification can have one of six predefined severity levels (warning, critical, …).

[Note]Note

You can use a Clone option to create a copy of any template item or trigger for an individual host. In this case, you can edit its predefined values to meet your requirements for each host separately.

Graphs are automatically created for each monitored numeric value, but you can also create special graphs with several values on a single graph. We provide 3 predefined graphs containing for example Ethernet throughput (in, out) within one graph.

For more information, see the Zabbix documentation. You can delete, add or edit any template component. The predefined state serves as a quick start, but you do not have to use these at all and you can create your own set of monitored values/items.

2.2. MACROs

Macros are variables, identified by a specific syntax: {MACRO}. MACROs resolve to a specific value depending on the context. Effective use of MACROs allows to save time and make Zabbix configuration more transparent.

With our templates, each RipEX automatically obtains the following MACROs:

  • {$HOST.SSHKEY} – Full path to a stored admin SSH key to access the unit (by default “/home/zabbix/.ssh/id_rsa”)

  • {$HOST.SSHPORT} – SSH port to access the unit (by default “22”)

  • {$SNMP_COMMUNITY} – SNMPv2c community string (security parameter in SNMP version 2, by default “mwl-snmp”)

You can edit the values in Configuration -> Hosts -> choose the particular RAy3 -> Macros -> Inherited and host macros. Edit any value and all Items will be automatically updated.

Template Macros

Fig. 2.3: Template Macros


2.3. RAy3 Firmware and Template Compatibility

Since RAy3 FW 1.0.14.0, the SNMP non-table items OIDs are defined in accordance with the RFC (ending ‘.0’) – to improve SolarWinds compatibility. Keep this in mind when upgrading RAy3 firmware. Firmwares < 1.0.14.0. are able to reply to SNMP queries with OIDs ending with .0, but the reply does not contain .0 in its OID. This works fine (for example) with Zabbix NMS, but (for example) SolarWinds does not accept such replies.

Since RAy3 FW 1.0.16.0, the SNMP product OID of RAy3 changed from ‘1’ to ‘4’. The old template will NOT work with new RAy3 firmware. See the procedure below.

Suggested way of updating the RAy3 template is very straight-forward. Download the latest template from our website, see Firmware RAy3 section. The name of the template is “RAy3 Template”. There are two possible procedures and situations.

  1. All RAy3 units in your NMS already have firmware >= 1.0.16.0. Rename your current RAy3 template to “RAy3 Template” and Import the new one with the same name. This will replace the older template.

    Importing RAy3 template

    Fig. 2.4: Importing RAy3 template


  2. You operate both RAy3 links with newer and older firmware. In such a case, you need two different templates. Make sure that your current template in Zabbix has a different name than “RAy3 Template”, e.g. “RAy3 old firmware Template”. Then, import the new template.

    Mark hosts with new firmware (>= 1.0.16.0) and use “Mass update” button.

    Mass update of RAy3 units

    Fig. 2.5: Mass update of RAy3 units


Select the “Templates” submenu and select a new template. Check the “replace” box and apply the changes.

Replacing RAy3 template for selected units

Fig. 2.6: Replacing RAy3 template for selected units


In both situations, the history values should still be available and new values will be queried successfully.

NOTE: If you have any issues updating RAy3 firmware and/or Zabbix templates, contact our technical support group via support@racom.eu.

[Note]Note

If you use template utilizing Item’s KEYs of non-table items with ‘.0′ at the end, you need to check the “Clear when unlinking” box once replacing hosts’ template, because you would double the Items of each host. Unfortunately, you lose your historical data. You could manually edit all Item keys with trailing .0 manually in Zabbix GUI.

Replacing RAy3 template for selected units with Clearing the hosts' items

Fig. 2.7: Replacing RAy3 template for selected units with Clearing the hosts’ items