granicus.if.org Git - icinga2/blob - plugins/README.md

   1 ## Icinga 2 plugins for Windows
   2
   3 This collection of plugins is intended to provide basic functionality checks on windows machines.
   4 They (mostly) conform to the [nagios developer guidelines](https://nagios-plugins.org/doc/guidelines.html),
   5 returning adequate exit codes and printing a pertinent string with performance data.
   6
   7
   8 ### Intallation
   9
  10 The plugins are installed as part of Icinga 2.
  11
  12
  13 ### Requirements
  14
  15 - Boost 1.41.0
  16 - Windows Vista, Windows Server 2008 or newer
  17
  18
  19 ### Usage
  20
  21 Call a plugin with the "--help" option to receive information about its usage.
  22 Most of them don't need any parameters to but all of them have a -w (warning) and -c (critical) option.
  23 Those accept, if not otherwise specified, value or percentage based thresholds or threshold ranges.
  24
  25 A few examples:
  26 *./check_command.exe -w 12 -c !60%*
  27 Adds a warning threshold of 12 and an inversed critical threshold of 60%
  28
  29 *./check_command.exe -w ![20%-80%] -c [0%-40%]*
  30 The warning threshold is outside of 20% to 80% and the critical threshold is the range from 0% to 40%.
  31 A critical state always overwrites a warning state, meaning the check would be critical with a value of 30%.
  32
  33
  34 ### License
  35
  36 Icinga 2
  37 Copyright (C) 2012-2015 Icinga Development Team (http://www.icinga.org)
  38
  39 This program is free software; you can redistribute it and/or
  40 modify it under the tems of the GNU General Public License
  41 as published by the Free Software Foundation; either version 2
  42 of the License, or (at your option) any later version.
  43
  44 This program is distributed in the hope that it will be useful,
  45 but WITHOUT ANY WARRANTY; without even the implied warranty of
  46 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  47 See the GNU General Public License for more details.
  48
  49  You should have received a copy of the GNU General Public License
  50  along with this program; if not, write to the Free Software Foundation
  51  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.