mirror of
https://github.com/rsyslog/rsyslog.git
synced 2025-12-20 09:40:42 +01:00
55 lines
2.6 KiB
HTML
55 lines
2.6 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html><head>
|
||
<meta http-equiv="Content-Language" content="en"><title>TCP Syslog Input Module</title></head>
|
||
<body>
|
||
<h1>TCP Syslog Input Module</h1>
|
||
<p><b>Module Name: imtcp</b></p>
|
||
<p><b>Author: </b>Rainer Gerhards
|
||
<rgerhards@adiscon.com></p>
|
||
<p><b>Description</b>:</p>
|
||
<p>Provides the ability to receive syslog messages via TCP.
|
||
Encryption can be provided by using <a href="rsyslog_stunnel.html">stunnel</a>
|
||
(an alternative is the use
|
||
the <a href="imgssapi.html">imgssapi</a>
|
||
modul).</p>
|
||
<p>In the future, multiple receivers may be configured by
|
||
specifying
|
||
$InputTCPServerRun multiple times. This is not currently supported.
|
||
</p>
|
||
<p><b>Configuration Directives</b>:</p>
|
||
<ul>
|
||
<li>$InputTCPServerRun <port><br>
|
||
Starts a TCP server on selected port</li>
|
||
<li><ul><li>$InputTCPMaxSessions <number></li></ul>
|
||
Sets the maximum number of sessions supported</li><li>$InputTCPServerStreamDriverMode <number><br>
|
||
Sets the driver mode for the currently selected <a href="netstream.html">network stream driver</a>. <number> is driver specifc.</li><li>$InputTCPServerStreamDriverAuthMode <mode-string><br>
|
||
Sets the authentication mode for the currently selected <a href="netstream.html">network stream driver</a>. <mode-string> is driver specifc.</li><li>$InputTCPServerStreamDriverPermittedPeer <id-string><br>
|
||
Sets permitted peer IDs. Only these peers are able to connect to the
|
||
listener. <id-string> semantics depend on the currently selected
|
||
AuthMode and <a href="netstream.html">network stream driver</a>. PermittedPeers may not be set in anonymous modes.</li>
|
||
</ul>
|
||
<b>Caveats/Known Bugs:</b>
|
||
<ul>
|
||
<li>module always binds to all interfaces</li>
|
||
<li>only a single listener can be bound</li>
|
||
<li>can not be loaded together with <a href="imgssapi.html">imgssapi</a>
|
||
(which includes the functionality of imtcp)</li>
|
||
</ul>
|
||
<p><b>Sample:</b></p>
|
||
<p>This sets up a TCP server on port 514:<br>
|
||
</p>
|
||
<textarea rows="15" cols="60">$ModLoad imtcp #
|
||
needs to be done just once
|
||
$InputTCPServerRun 514
|
||
</textarea>
|
||
<p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>]
|
||
[<a href="manual.html">manual index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
|
||
<p><font size="2">This documentation is part of the
|
||
<a href="http://www.rsyslog.com/">rsyslog</a>
|
||
project.<br>
|
||
Copyright <20> 2008 by <a href="http://www.gerhards.net/rainer">Rainer
|
||
Gerhards</a> and
|
||
<a href="http://www.adiscon.com/">Adiscon</a>.
|
||
Released under the GNU GPL version 3 or higher.</font></p>
|
||
</body></html>
|