User Guide

User Interface Components

ui components image
  1. Result filter. Accepts a POSIX extended regular expression.

  2. Revert to the last-known-good configuration. This is the last configuration that was successfully applied.

  3. Apply all changes.

  4. Backup and Restore plugin.

  5. Bulk Tools plugin.

  6. Expandable object. Click to view extra linked items.

  7. Item actions. From left to right: Test mode, clone, edit, delete, disable.

    • Test mode works in distributed environments only. It stops the item being shown in the collector node, but it still shows in the slave node.

    • Clone makes a copy of the item.

    • Edit opens an Edit dialog.

    • Delete removes an item, and possibly all sub-items if the checkbox is ticked.

    • Disable removes the item from the nagios configuration but keeps it in the nagrestconf configuration.

  8. Tab pages. Easy access to the main tables.

  9. Add new item. Opens a dialog box form.

  10. Action Sidebar. Plugin components are added here.

Lists

Many text entry fields accept multiple values and in all cases the values should be separated by a single space. For example, to enter two contacts, 'bob' and 'jack', type bob jack into the text entry field.

Compound Fields

A few text entry fields accept compound values, namely, 'Custom Variables' in the Edit Service dialog, and timeperiod definitions.

The format for entering custom variables is <name>|<value>[,<name>|<value>]…

For example, to add a single custom variable, '_SNMP_community', with the value, 'public', enter the following in the text entry field:

_SNMP_community|public

To add an additional custom variable in the text entry field, '_TechContact' with the value, 'Jane Doe', then separate each pair with a comma, for example:

_SNMP_community|public,_TechContact|Jane Doe

This creates a service entry with the following entries:

define service {
   ...
   _SNMP_community   public
   _TechContact      Jane Doe
   ...
}

Filters

Filtering, available in the Hosts and Services tabs, accepts a POSIX extended regular expression. A terse but complete description of regular expressions might be available on your system using man 7 regex, or refer to the regex page at man7.org.

All fields in the result filter are logically AND'ed together. For example, if the Hosts tab results are filterd using the hostgroup dropdown box, then the filter regular expression will only apply to hosts in that hostgroup.

Examples

View all items containing 'abc' anywhere in the name.

abc

View all items starting with 'abc'.

^abc

View all items starting with 'abc' or 'def'.

^(abc|def)

View all items ending with '001'.

001$

View all items ending with '001','002' or '003'.

00[1-3]$

View all items starting with 'lon' followed by one of 'db2','mysql' or 'mssql'.

^lon.*(db2|mysql|mssql)

Service Sets

Service Sets group a number of service checks together, which can then be applied to one or more hosts.

One or more service sets can be applied to a host. When service sets are layered this way there may be duplicate services, and if there are duplicate services then the last service set containing the duplicate overrides any other. The last service set is the rightmost service set.

Service sets can be specified in the Host add or edit dialogs, or can be applied to many hosts at once by using the Bulk Tools plugin.

When using the Host edit dialog the service sets can be changed but the service sets will not be applied unless the 'Re-apply Service Sets' check box, locate next to the 'Apply Changes' button, is ticked before pressing 'Apply Changes' as shown below.

When using Bulk Tools, new service sets can be applied to many hosts using the 'Modify hosts' tab in the 'Bulk Tools' dialog, but again they will not be applied. To apply the service sets to the hosts first make the service set changes in bulk, then switch to the 'Refresh Hosts' tab and apply the changes as shown below.