.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "XYNAGIOS 1" .TH XYNAGIOS 1 "2019-01-29" "perl v5.28.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" xynagios \- adaptor for using Nagios checks with Xymon .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBxynagios\fR [\fIoptions\fR \-\-] \fIplugin\fR [\fIoptions ...\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBxynagios\fR runs a Nagios check, and reports its output in a way compatible with the Xymon (Hobbit, \s-1BB\s0) monitoring system. .PP The Xymon test name is taken from the plugin output if it starts with \&\fItest_name\fR \fIOK|WARNING|CRITICAL|ERROR|UNKNOWN\fR\fB:\fR. Otherwise, the basename of the plugin filename is used. A \fBcheck_\fR prefix is removed for brevity. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-\-hostname=\fR\fIhost\fR" 4 .IX Item "--hostname=host" Report tests as this host. .IP "\fB\-\-strip=\fR\fIprefix\fR" 4 .IX Item "--strip=prefix" Remove \fIprefix\fR (regexp) from test names. The prefix \*(L"check_\*(R" is always removed before stripping other prefixes. Useful for trimming down overly verbose Nagios test names, e.g. \*(L"check_postgres_database_size\*(R" to \&\*(L"database_size\*(R". .IP "\fB\-\-test=\fR\fIname\fR" 4 .IX Item "--test=name" Test name to submit. Per default, the test name is derived from the plugin output, or from the plugin name, if the output doesn't indicate the name. .IP "\fB\-\-help\fR" 4 .IX Item "--help" .PD 0 .IP "\fB\-\-version\fR" 4 .IX Item "--version" .PD Print help text and version, and exit. .PP Options for sending \s-1RRD\s0 trends messages. If any of these is set, a data \&\fIhost\fR.trends message is sent. .IP "\fB\-\-trends\fR" 4 .IX Item "--trends" In addition to printing performance data in the status report (suitable for the \&\s-1NCV/SPLITNCV\s0 xymond_rrd modules), send in a data report for \&\fIhostname\fR\fB.trends\fR. This rrd module is more robust. .IP "\fB\-\-ds=\fR\fIname\fR" 4 .IX Item "--ds=name" The data source (\s-1DS\s0) \fIname\fR used in the \s-1RRD\s0 files, defaults to \fBlambda\fR. .IP "\fB\-\-dst=\fR\fItype\fR" 4 .IX Item "--dst=type" The data source \fItype\fR used in the \s-1RRD\s0 files. Useful values are \fB\s-1GAUGE\s0\fR (the default), \fB\s-1COUNTER\s0\fR, \fB\s-1DCOUNTER\s0\fR, \fB\s-1DERIVE\s0\fR, \fB\s-1DDERIVE\s0\fR, and \fB\s-1ABSOLUTE\s0\fR. See \&\fBrrdcreate\fR\|(1) for details. .IP "\fB\-\-heartbeat=\fR\fIsecs\fR" 4 .IX Item "--heartbeat=secs" \&\s-1RRD\s0 heartbeat in seconds, default is 600. .IP "\fB\-\-min=\fR\fIN\fR" 4 .IX Item "--min=N" Data source minimum value, default is \fBU\fR for unknown. .IP "\fB\-\-max=\fR\fIN\fR" 4 .IX Item "--max=N" Data source maximum value, default is \fBU\fR for unknown. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBxymon\fR\|(7), \fBxymon\fR\|(1), \fBxymoncmd\fR\|(1), \fBnagios3\fR\|(8). .SH "AUTHOR" .IX Header "AUTHOR" Christoph Berg .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" Copyright (c) Christoph Berg .PP Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: .PP .Vb 5 \& 1. Redistributions of source code must retain the above copyright notice, \& this list of conditions and the following disclaimer. \& 2. Redistributions in binary form must reproduce the above copyright notice, \& this list of conditions and the following disclaimer in the documentation \& and/or other materials provided with the distribution. .Ve .PP \&\s-1THIS SOFTWARE IS PROVIDED BY THE AUTHOR \*(L"AS IS\*(R" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\s0 (\s-1INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES\s0; \s-1LOSS OF USE, DATA, OR PROFITS\s0; \s-1OR BUSINESS INTERRUPTION\s0) \s-1HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\s0 (\s-1INCLUDING NEGLIGENCE OR OTHERWISE\s0) \s-1ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\s0