===================
Nagios integration
===================

The management server provides a short message about a bond's status
that can be used in a Nagios check. The message also contains
information about each leg in the bond.

A link to the page is available at the bottom-right corner of the bond
details page. A Nagios check can download from this URL and use the
result in an alert.

.. warning::

    The Nagios check page can be viewed without authenticating with a
    username and password because it includes the node key. Someone who
    knows a node key can interact with the Bonded Internet system as the
    node, so do not allow keys to become known outside the Bonded Internet
    or Nagios environments.


The URL of the page is as follows:

::

    <management server URL>/nagios/bond/<bond ID>?key=<bond key>

The bond ID and key are shown on the bond details page.

For example, the Nagios URL for a bond could be: 

::

    https://bondingadmin.example.com/nagios/bond/1?key=JL481-HFTK3-XDXKN-EP4EY

Examples
---------

Examples of messages provided by this page are:

::

    OK: 3 legs up for 11 hours, 15 minutes
    Static leg 1, eth0: up
    DHCP leg 2, eth1: up
    Static leg 3, eth2, failover: up

::

    Warning: 2 legs up, 1 leg down for 11 hours, 15 minutes
    Static leg 1, eth0: down
    DHCP leg 2, eth1: up
    Static leg 3, eth2, failover: up

::

    Critical: Using failover leg for 11 hours, 15 minutes
    Static leg 1, eth0: down
    DHCP leg 2, eth1: down
    Static leg 3, eth2, failover: up

::

    Critical: All legs down for 11 hours, 15 minutes
    Static leg 1, eth0: down
    DHCP leg 2, eth1: down
    Static leg 3, eth2, failover: down 

The message begins with "OK" when all active legs are up, "Warning" when
any active leg is down, and "Critical" when the bond is using the
failover leg or when all active legs are down.
