1SA-CHECK_SPAMD(1)     User Contributed Perl Documentation    SA-CHECK_SPAMD(1)
2
3
4

NAME

6       sa-check_spamd - spamd monitoring script for use with Nagios, etc.
7

SYNOPSIS

9       sa-check_spamd [options]
10
11       Options:
12
13        -c secs, --critical=secs          Critical ping response threshold
14        -h, -?, --help                    Print usage message
15        -H hostname, --hostname=hostname  Hostname of spamd service to ping
16        -p port, --port=port              Port of spamd service to ping
17        --socketpath=path                 Connect to given UNIX domain socket
18        -t secs, --timeout=secs           Max time to wait for a ping response
19        -v, --verbose                     Verbose debug output
20        -V, --version                     Output version info
21        -w secs, --warning=secs           Warning ping response threshold
22

DESCRIPTION

24       The purpose of this program is to provide a tool to monitor the status
25       of "spamd" server processes.  spamd is the daemonized version of the
26       spamassassin executable, both provided in the SpamAssassin
27       distribution.
28
29       This program is designed for use, as a plugin, with the Nagios service
30       monitoring software available from http://nagios.org.  It might be
31       compatible with other service monitoring packages.  It is also useful
32       as a command line utility or as a component of a custom shell script.
33

OPTIONS

35       Options of the long form can be shortened as long as the remain
36       unambiguous (i.e. --host can be used instead of --hostname).
37
38       -c secs, --critical=secs
39           Critical ping response threshold in seconds.  If a spamd ping
40           response takes longer than the value specified (in seconds) the
41           program will exit with a value of 2 to indicate the critical
42           status.
43
44           This value must be at least as long as the value specified for
45           warning and less than the value specified for timeout.
46
47       -h, -?, --help
48           Prints this usage message and exits.
49
50       -H hostname, --hostname=hostname
51           The hostname, or IP address, of the spamd service to ping.  By
52           default the hostname localhost is used.  If --socketpath is set
53           this value will be ignored.
54
55       -p port, --port=port
56           The port of the spamd service to ping.  By default port 783 (the
57           spamd default port number) is used.  If --socketpath is set this
58           value will be ignored.
59
60       --socketpath=path
61           Connect to given UNIX domain socket.  Use instead of a hostname and
62           TCP port.  When set, any hostname and TCP port specified will be
63           ignored.
64
65       -t secs, --timeout=secs
66           The maximum time to wait for a ping response.  Once exceeded the
67           program will exit with a value of 2 to indicate the critical
68           status.  The default timeout value is 45 seconds.  The timeout must
69           be no less than 1 second.
70
71           This value must be greater than the values specified for both the
72           critical and warning values.
73
74       -v, --verbose
75           Display verbose debug output on STDOUT.
76
77       -V, --version
78           Display version info on STDOUT.
79
80       -w secs, --warning=secs
81           Warning ping response threshold in seconds.  If a spamd ping
82           response takes longer than the value specified (in seconds), and
83           does not exceed the critical threshold value, the program will exit
84           with a value of 1 to indicate the warning status.
85
86           This value must be no longer than the value specified for critical
87           and less than the value specified for timeout.
88

EXIT CODES

90       The program will indicate the status of the spamd process being
91       monitored by exiting with one of these values:
92
93       0   OK: A spamd ping response was received within all threshold times.
94
95       1   WARNING: A spamd ping response exceeded the warning threshold but
96           not the critical threshold.
97
98       2   CRITICAL: A spamd ping response exceeded either the critical
99           threshold or the timeout value.
100
101       3   UNKNOWN: An error, probably caused by a missing dependency or an
102           invalid configuration parameter being supplied, occurred in the
103           sa-check_spamd program.
104

SEE ALSO

106       spamc(1) spamd(1) spamassassin(1)
107

PREREQUISITES

109       "Mail::SpamAssassin" version 3.1.1 or higher (3.1.6 or higher
110       recommended)
111

AUTHOR

113       Daryl C. W. O'Shea, DOS Technologies <spamassassin@dostech.ca>
114

116       sa-check_spamd is distributed under the Apache License, Version 2.0, as
117       described in the file "LICENSE" included with the Apache SpamAssassin
118       distribution and available at
119       http://www.apache.org/licenses/LICENSE-2.0
120
121       Copyright (C) 2015 The Apache Software Foundation
122
123
124
125perl v5.36.0                      2023-01-21                 SA-CHECK_SPAMD(1)
Impressum