/ 
YATG-4.112532
River stage zero No dependents
/ YATG::Store::NSCA

NAME

YATG::Store::NSCA - Back-end module to send polled data to a Nagios service

VERSION

version 4.112532

DESCRIPTION

This module checks for device ports which are administratively enabled, but which are showing not connected to anything, at the time of polling. A Nagios CRITICAL result will be generated for such ports.

Only one check result per device is submitted (i.e. not one result per port). If there are multiple ports in an alarm state on the same device, then they will all be mentioned in the single service check report.

When all enabled ports are connected, an OK result is returned.

CONFIGURATION

At a minimum, you must provide details of the location of your Nagios NSCA server, in the main configuration file:

nsca:
    nsca_server: '192.0.2.1'

In your YATG configuration file, you must also include this store module on the OIDs required to generate a check result:

oids:
    "ifOperStatus":   [ifindex, nsca]
    "ifAlias":        [ifindex, nsca]

Optional Configuration

You can also supply the following settings in the main configuration file to override builtin defaults, like so:

nsca:
    send_nsca_cmd: '/usr/bin/send_nsca'
    config_file:   '/etc/send_nsca.cfg'
    ignore_ports:  '^(?:Vlan|Po)\d+$'
    ignore_descr:  '(?:SPAN)'
    service_name:  'Interfaces Status'
send_nsca_cmd

The location of the send_nsca command on your system. YATG will default to searching for send_nsca in the application's current PATH.

config_file

The location of the configuration file for the send_nsca program. This defaults to /etc/send_nsca.cfg.

ignore_ports

Device port names (OID ifDescr) to skip when submitting results. This defaults to anything like a Vlan interface, or Cisco PortChannel. Supply the content of a Perl regular expression, as in the example above.

ignore_descr

Device port description fields matching this value cause the port to be skipped when submitting results. This defaults to anything containing the word "SPAN". Supply the content of a Perl regular expression, as in the example above.

service_name

The Nagios Service Check name to use when submitting results. This must match the configured name on your Nagios server, and defaults to "Interfaces Status".

SEE ALSO

Opsview at http://www.opsview.org

AUTHOR

Oliver Gorwits <oliver@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by University of Oxford.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.