nagios-snmp-plugins/README.md

90 lines
2.9 KiB
Markdown
Raw Permalink Normal View History

2016-12-04 10:31:25 +00:00
# Manubulon SNMP Plugins
2017-11-29 15:28:59 +00:00
#### Table of Contents
1. [About](#about)
2. [License](#license)
3. [Support](#support)
4. [Requirements](#requirements)
5. [Installation](#installation)
6. [Configuration](#configuration)
7. [FAQ](#faq)
8. [Thanks](#thanks)
9. [Contributing](#contributing)
## About
2016-12-04 10:31:25 +00:00
Manubulon SNMP plugins is a set of Icinga/Nagios plugins
2017-11-29 15:28:59 +00:00
to check hosts/devices using the SNMP protocol.
### Plugin Overview
Plugin | Description
------------------------------|----------------------------------------
check\_snmp\_storage | Storage checks (disks, swap, memory, etc.)
check\_snmp\_int | Interface states, usage on hosts, switches, routers, etc.
check\_snmp\_process | Running processes, their number, used CPU and memory.
check\_snmp\_load | Load/CPU checks
check\_snmp\_mem | Memory and swap usage
check\_snmp\_env | Environmental status of fan, temp, power supplies.
check\_snmp\_vrrp | Interface state of a VRRP cluster
check\_snmp\_cpfw | Checkpoint Firewall-1 status
check\_snmp\_win | Windows services
check\_snmp\_css | CSS service states
check\_snmp\_nsbox | Nsbox VHost and diode status
check\_snmp\_boostedge | Boostedge services
check\_snmp\_linkproof\_ndr | Linkproof NHR
## License
These plugins are licensed under the terms of the GNU General Public License.
You will find a copy of this license in the LICENSE file included in the source package.
2016-12-04 10:31:25 +00:00
2017-11-29 15:28:59 +00:00
## Support
2016-12-04 10:31:25 +00:00
2017-11-29 15:28:59 +00:00
Join the [Icinga community channels](https://www.icinga.com/about/get-involved/) for questions.
2016-12-04 10:31:25 +00:00
2017-11-29 15:28:59 +00:00
If you want to help maintain this project, just contact
me on [twitter](https://twitter.com/dnsmichi) and I'll
happily grant commit access.
2016-12-04 10:31:25 +00:00
## Requirements
2017-11-29 15:28:59 +00:00
* Perl in `/usr/bin/perl`
* Perl modules
[Net::SNMP](http://search.cpan.org/~dtown/Net-SNMP-v6.0.1/lib/Net/SNMP.pm) and
[Getopt::Long](http://search.cpan.org/~jv/Getopt-Long-2.49.1/lib/Getopt/Long.pm)
2016-12-04 10:31:25 +00:00
* `icinga` user able to write files in /tmp/ directory
2017-11-29 15:28:59 +00:00
* SNMP v3 authentication: Perl modules
[Crypt::DES](http://search.cpan.org/~dparis/Crypt-DES-2.07/DES.pm),
[Crypt::Rijndael](http://search.cpan.org/~leont/Crypt-Rijndael-1.13/Rijndael.pm) and
[Digest::HMAC](http://search.cpan.org/~gaas/Digest-HMAC-1.03/lib/Digest/HMAC.pm)
2016-12-04 10:31:25 +00:00
2017-11-29 15:28:59 +00:00
## Installation
2016-12-04 10:31:25 +00:00
2017-11-29 15:28:59 +00:00
Detailed installation instructions can be found [here](doc/02-Installation.md).
2016-12-04 10:31:25 +00:00
2017-11-29 15:28:59 +00:00
## Configuration
2016-12-04 10:31:25 +00:00
2017-11-29 15:28:59 +00:00
Proceed [here](doc/03-Configuration.md) to get details on the configuration with Icinga 2, Icinga 1.x, etc.
2016-12-04 10:31:25 +00:00
2017-11-29 15:28:59 +00:00
## FAQ
2016-12-04 10:31:25 +00:00
2017-11-29 15:28:59 +00:00
## Thanks
2016-12-04 10:31:25 +00:00
2017-11-29 15:28:59 +00:00
Patrick Proy for creating and maintaining the original plugins.
2016-12-04 10:31:25 +00:00
2017-11-29 15:28:59 +00:00
## Contributing
2016-12-04 10:31:25 +00:00
2017-11-29 15:28:59 +00:00
Fork this repository on GitHub and send in a PR.
2016-12-04 10:31:25 +00:00
There's a `.perltidyrc` file in the main repository tree. If you are uncertain about the coding style,
create your patch and then run:
2017-11-29 15:28:59 +00:00
```
$ perltidy -b plugins/*.pl
```
2016-12-04 10:31:25 +00:00
This requires the `perltidy` module being installed.