~ubuntu-branches/ubuntu/lucid/rsyslog/lucid-updates

« back to all changes in this revision

Viewing changes to doc/imtcp.html

  • Committer: Bazaar Package Importer
  • Author(s): Michael Biebl
  • Date: 2009-06-23 12:12:43 UTC
  • mfrom: (1.1.11 upstream) (3.2.8 sid)
  • Revision ID: james.westby@ubuntu.com-20090623121243-d2fejarzidywnn17
Tags: 4.2.0-1
* New upstream release of the now stable v4 branch.
  - Fix warnings when /etc/rsyslog.d/ is empty. Closes: #530228
* debian/patches/imudp_multiple_udp_sockets.patch
  - Removed, merged upstream.
* debian/rsyslog.default
  - Set default compat mode to '4'.
* debian/rsyslog.logcheck.ignore.server
  - Update logcheck rules files to also ignore rsyslogd and imklog stop
    messages.
* debian/control
  - Bump Standards-Version to 3.8.2. No further changes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<html><head>
3
3
<meta http-equiv="Content-Language" content="en"><title>TCP Syslog Input Module</title></head>
4
4
<body>
 
5
<a href="rsyslog_conf_modules.html">back</a>
 
6
 
5
7
<h1>TCP Syslog Input Module</h1>
6
8
<p><b>Module Name:&nbsp;&nbsp;&nbsp; imtcp</b></p>
7
9
<p><b>Author: </b>Rainer Gerhards
18
20
</p>
19
21
<p><b>Configuration Directives</b>:</p>
20
22
<ul>
 
23
<li>$InputTCPServerAddtlFrameDelimiter &lt;Delimiter&gt;<br>
 
24
This directive permits to specify an additional frame delimiter for plain tcp syslog.
 
25
The industry-standard specifies using the LF character as frame delimiter. Some vendors,
 
26
notable Juniper in their NetScreen products, use an invalid frame delimiter, in Juniper's
 
27
case the NUL character. This directive permits to specify the ASCII value of the delimiter
 
28
in question. Please note that this does not guarantee that all wrong implementations can
 
29
be cured with this directive. It is not even a sure fix with all versions of NetScreen,
 
30
as I suggest the NUL character is the effect of a (common) coding error and thus will
 
31
probably go away at some time in the future. But for the time being, the value 0 can
 
32
probably be used to make rsyslog handle NetScreen's invalid syslog/tcp framing.
 
33
For additional information, see this
 
34
<a href="http://kb.monitorware.com/problem-with-netscreen-log-t1652.html">forum thread</a>.
 
35
<br><b>If this doesn't work for you, please do not blame the rsyslog team. Instead file
 
36
a bug report with Juniper!</b>
 
37
<br>Note that a similar, but worse, issue exists with Cisco's IOS implementation. They do
 
38
not use any framing at all. This is confirmed from Cisco's side, but there seems to be
 
39
very limited interest in fixing this issue. This directive <b>can not</b> fix the Cisco bug.
 
40
That would require much more code changes, which I was unable to do so far. Full details
 
41
can be found at the <a href="http://www.rsyslog.com/Article321.phtml">Cisco tcp syslog anomaly</a>
 
42
page.
21
43
<li>$InputTCPServerRun &lt;port&gt;<br>
22
44
Starts a TCP server on selected port</li>
23
45
<li><ul><li>$InputTCPMaxSessions &lt;number&gt;</li></ul>
24
46
Sets the maximum number of sessions supported</li><li>$InputTCPServerStreamDriverMode &lt;number&gt;<br>
25
 
Sets the driver mode for the currently selected <a href="netstream.html">network stream driver</a>. &lt;number&gt; is driver specifc.</li><li>$InputTCPServerStreamDriverAuthMode &lt;mode-string&gt;<br>
 
47
Sets the driver mode for the currently selected <a href="netstream.html">network stream driver</a>. &lt;number&gt; is driver specifc.</li>
 
48
<li>$InputTCPServerInputName &lt;name&gt;<br>
 
49
Sets a name for the inputname property. If no name is set "imtcp" is used by default. Setting a 
 
50
name is not strictly necessary, but can be useful to apply filtering based on which input
 
51
the message was received from.
 
52
<li>$InputTCPServerStreamDriverAuthMode &lt;mode-string&gt;<br>
26
53
Sets the authentication mode for the currently selected <a href="netstream.html">network stream driver</a>. &lt;mode-string&gt; is driver specifc.</li><li>$InputTCPServerStreamDriverPermittedPeer &lt;id-string&gt;<br>
27
54
Sets permitted peer IDs. Only these peers are able to connect to the
28
55
listener. &lt;id-string&gt; semantics depend on the currently selected