1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of PROTOCOLS.CFG</TITLE>
</HEAD><BODY>
<H1>PROTOCOLS.CFG</H1>
Section: File Formats (5)<BR>Updated: Version 4.3.17: 23 Feb 2014<BR><A HREF="#index">Index</A>
<A HREF="../index.html">Return to Main Contents</A><HR>
<A NAME="lbAB"> </A>
<H2>NAME</H2>
protocols.cfg - Configuration of TCP network services
<P>
<A NAME="lbAC"> </A>
<H2>SYNOPSIS</H2>
<B>$XYMONHOME/etc/protocols.cfg</B>
<P>
<A NAME="lbAD"> </A>
<H2>DESCRIPTION</H2>
<B>protocols.cfg</B> contains definitions of how
<I><A HREF="../man1/xymonnet.1.html">xymonnet</A>(1)</I>
should test a TCP-based network service (i.e. all common
network services except HTTP and DNS).
For each service, a simple dialogue can be defined to
check that the service is functioning normally, and optional
flags determine if the service has e.g. a banner or requires
SSL- or telnet-style handshaking to be tested.
<P>
<A NAME="lbAE"> </A>
<H2>FILE FORMAT</H2>
protocols.cfg is a text file. A simple service definition for
the SMTP service would be this:
<BR>
<P>
<BR> [smtp]
<BR>
<BR> send "mail\r\nquit\r\n"
<BR>
<BR> expect "220"
<BR>
<BR> options banner
<BR>
<P>
This defines a service called "smtp". When the connection is
first established, xymonnet will send the string "mail\r\nquit\r\n"
to the service. It will then expect a response beginning with "220".
Any data returned by the service (a so-called "banner") will be recorded
and included in the status message.
<P>
The full set of commands available for the protocols.cfg file are:
<P>
<DL COMPACT>
<DT>[NAME]<DD>
Define the name of the TCP service, which will also be the column-name
in the resulting display on the test status. If multiple tests share
a common definition (e.g. ssh, ssh1 and ssh2 are tested identically),
you may list these in a single "[ssh|ssh1|ssh2]" definition,
separating each service-name with a pipe-sign.
<P>
<DT>send STRING<DD>
<DT>expect STRING<DD>
Defines the strings to send to the service after a connection is
established, and the response that is expected. Either of these
may be omitted, in which case
<I><A HREF="../man1/xymonnet.1.html">xymonnet</A>(1)</I>
will simply not send any data, or match a response against anything.
<P>
The send- and expect-strings use standard escaping for non-printable
characters. "\r" represents a carriage-return (ASCII 13), "\n"
represents a line-feed (ASCII 10), "\t" represents a TAB (ASCII 8).
Binary data is input as "\xNN" with NN being the hexadecimal value
of the byte.
<P>
<DT>port NUMBER<DD>
Define the default TCP port-number for this service. If no portnumber
is defined,
<I><A HREF="../man1/xymonnet.1.html">xymonnet</A>(1)</I>
will attempt to lookup the portnumber in the standard /etc/services
file.
<P>
<DT>options option1[,option2][,option3]<DD>
Defines test options. The possible options are
<BR>
<BR> banner - include received data in the status message
<BR>
<BR> ssl - service uses SSL so perform an SSL handshake
<BR>
<BR> telnet - service is telnet, so exchange telnet options
<P>
<P>
</DL>
<A NAME="lbAF"> </A>
<H2>FILES</H2>
<B>$XYMONHOME/etc/protocols.cfg</B>
<P>
<A NAME="lbAG"> </A>
<H2>SEE ALSO</H2>
<A HREF="../man1/xymonnet.1.html">xymonnet</A>(1)
<P>
<P>
<HR>
<A NAME="index"> </A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">FILE FORMAT</A><DD>
<DT><A HREF="#lbAF">FILES</A><DD>
<DT><A HREF="#lbAG">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 09:41:01 GMT, February 23, 2014
</BODY>
</HTML>
|
