From 8fdd3b45c0c2b2a5751efd79e2be4cc0241af53e Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Fri, 22 Feb 2008 09:13:14 +0000 Subject: added some doc for imgssapi and imtcp input modules --- doc/imtcp.html | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 doc/imtcp.html (limited to 'doc/imtcp.html') diff --git a/doc/imtcp.html b/doc/imtcp.html new file mode 100644 index 00000000..b2c6d21d --- /dev/null +++ b/doc/imtcp.html @@ -0,0 +1,51 @@ + + +TCP Syslog Input Module + + + +

TCP Syslog Input Module

Module Name: imtcp

Author: Rainer Gerhards +<rgerhards@adiscon.com>

Description:

Provides the ability to receive syslog messages via TCP. +Encryption can be provided by using stunnel +(an alternative is the use +the imgssapi +modul).

In the future, multiple receivers may be configured by +specifying +$InputTCPServerRun multiple times. This is not currently supported. +

Configuration Directives:

$InputTCPServerRun <port>
+Starts a TCP server on selected port
$InputTCPMaxSessions <number>
+Sets the maximum number of sessions supported

+Caveats/Known Bugs: +

module always binds to all interfaces
only a single listener can be bound
can not be loaded together with imgssapi +(which includes the functionality of imtcp)

Sample:

This sets up a TCP server on port 514:
+

+ +

[rsyslog.conf overview] +[manual index] [rsyslog site]

This documentation is part of the +rsyslog +project.
+Copyright © 2008 by Rainer +Gerhards and +Adiscon. +Released under the GNU GPL version 3 or higher.

+ \ No newline at end of file -- cgit v1.2.3 From 350f28efd97ff8f84fa0c86b5655e1cef8d4596e Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Wed, 21 May 2008 11:41:15 +0200 Subject: added new transport auth methods to doc set --- doc/imtcp.html | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'doc/imtcp.html') diff --git a/doc/imtcp.html b/doc/imtcp.html index b2c6d21d..86c50dba 100644 --- a/doc/imtcp.html +++ b/doc/imtcp.html @@ -1,8 +1,6 @@ -TCP Syslog Input Module - - +TCP Syslog Input Module

TCP Syslog Input Module

Module Name: imtcp

@@ -23,7 +21,12 @@ $InputTCPServerRun multiple times. This is not currently supported.

$InputTCPServerRun <port>
Starts a TCP server on selected port

$InputTCPMaxSessions <number>
-Sets the maximum number of sessions supported

+Sets the maximum number of sessions supported

$InputTCPServerStreamDriverMode <number>
+Sets the driver mode for the currently selected network stream driver. <number> is driver specifc.

$InputTCPServerStreamDriverAuthMode <mode-string>
+Sets the authentication mode for the currently selected network stream driver. <mode-string> is driver specifc.

$InputTCPServerStreamDriverPermittedPeer <id-string>
+Sets permitted peer IDs. Only these peers are able to connect to the +listener. <id-string> semantics depend on the currently selected +AuthMode and network stream driver. PermittedPeers may not be set in anonymous modes.

Caveats/Known Bugs:

Date: Wed, 21 May 2008 11:45:40 +0200 Subject: added some forgotten doc --- doc/imtcp.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/imtcp.html') diff --git a/doc/imtcp.html b/doc/imtcp.html index 86c50dba..12f8020d 100644 --- a/doc/imtcp.html +++ b/doc/imtcp.html @@ -20,7 +20,7 @@ $InputTCPServerRun multiple times. This is not currently supported.

$InputTCPServerRun <port>
Starts a TCP server on selected port
$InputTCPMaxSessions <number>
+
- $InputTCPMaxSessions <number>
Sets the maximum number of sessions supported
$InputTCPServerStreamDriverMode <number>
Sets the driver mode for the currently selected network stream driver. <number> is driver specifc.
$InputTCPServerStreamDriverAuthMode <mode-string>
Sets the authentication mode for the currently selected network stream driver. <mode-string> is driver specifc.
$InputTCPServerStreamDriverPermittedPeer <id-string>
-- cgit v1.2.3 From 9b59581a6f7d161c7aafbc3300689337939bb382 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 18 Jul 2008 16:41:52 +0200 Subject: use the $ModLoad syntax consistently. Update the documentation to use the new, preferred $ModLoad syntax: - no more MySQL - name of the in/output plugin without the trailing .so Signed-off-by: Rainer Gerhards --- doc/imtcp.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/imtcp.html') diff --git a/doc/imtcp.html b/doc/imtcp.html index b2c6d21d..2c8ead56 100644 --- a/doc/imtcp.html +++ b/doc/imtcp.html @@ -35,7 +35,7 @@ Sets the maximum number of sessions supported

Sample:

This sets up a TCP server on port 514:

Adiscon

Date: Fri, 31 Oct 2008 14:47:30 +0100 Subject: restructured rsyslog.conf documentation Signed-off-by: Rainer Gerhards --- doc/imtcp.html | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc/imtcp.html') diff --git a/doc/imtcp.html b/doc/imtcp.html index ecc72748..583cd531 100644 --- a/doc/imtcp.html +++ b/doc/imtcp.html @@ -2,6 +2,8 @@ TCP Syslog Input Module +back +

TCP Syslog Input Module

Module Name: imtcp

Author: Rainer Gerhards -- cgit v1.2.3 From 483be404716d8e3e55f200955e1904219eb97a9b Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Wed, 10 Dec 2008 14:26:19 +0100 Subject: enhanced imtcp, among others to handel invalid NetScreen framing - added $InputTCPServerAddtlFrameDelimiter config directive, which enabeles to specify an additional, non-standard message delimiter for processing plain tcp syslog. This is primarily a fix for the invalid framing used in Juniper's NetScreen products. Credit to forum user Arv for suggesting this solution. - added $InputTCPServerInputName property, which enables a name to be specified that will be available during message processing in the inputname property. This is considered useful for logic that treats messages differently depending on which input received them. --- doc/imtcp.html | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) (limited to 'doc/imtcp.html') diff --git a/doc/imtcp.html b/doc/imtcp.html index 583cd531..0ee0f96a 100644 --- a/doc/imtcp.html +++ b/doc/imtcp.html @@ -20,11 +20,36 @@ $InputTCPServerRun multiple times. This is not currently supported.

Configuration Directives:

$InputTCPServerAddtlFrameDelimiter <Delimiter>
+This directive permits to specify an additional frame delimiter for plain tcp syslog. +The industry-standard specifies using the LF character as frame delimiter. Some vendors, +notable Juniper in their NetScreen products, use an invalid frame delimiter, in Juniper's +case the NUL character. This directive permits to specify the ASCII value of the delimiter +in question. Please note that this does not guarantee that all wrong implementations can +be cured with this directive. It is not even a sure fix with all versions of NetScreen, +as I suggest the NUL character is the effect of a (common) coding error and thus will +probably go away at some time in the future. But for the time being, the value 0 can +probably be used to make rsyslog handle NetScreen's invalid syslog/tcp framing. +For additional information, see this +forum thread. +
If this doesn't work for you, please do not blame the rsyslog team. Instead file +a bug report with Juniper! +
Note that a similar, but worse, issue exists with Cisco's IOS implementation. They do +not use any framing at all. This is confirmed from Cisco's side, but there seems to be +very limited interest in fixing this issue. This directive can not fix the Cisco bug. +That would require much more code changes, which I was unable to do so far. Full details +can be found at the Cisco tcp syslog anomaly +page.
$InputTCPServerRun <port>
Starts a TCP server on selected port
- $InputTCPMaxSessions <number>
Sets the maximum number of sessions supported
$InputTCPServerStreamDriverMode <number>
-Sets the driver mode for the currently selected network stream driver. <number> is driver specifc.
$InputTCPServerStreamDriverAuthMode <mode-string>
+Sets the driver mode for the currently selected network stream driver. <number> is driver specifc.
$InputTCPServerInputName <name>
+Sets a name for the inputname property. If no name is set "imtcp" is used by default. Setting a +name is not strictly necessary, but can be useful to apply filtering based on which input +the message was received from. +
$InputTCPServerStreamDriverAuthMode <mode-string>
Sets the authentication mode for the currently selected network stream driver. <mode-string> is driver specifc.
$InputTCPServerStreamDriverPermittedPeer <id-string>
Sets permitted peer IDs. Only these peers are able to connect to the listener. <id-string> semantics depend on the currently selected -- cgit v1.2.3 From aba90e82484118f3568ec51c01de5ba845da589a Mon Sep 17 00:00:00 2001 From: Rainer Gerhards
Date: Fri, 22 May 2009 17:06:52 +0200 Subject: added capability to run multiple tcp listeners (on different ports) Well, actually this and a lot of related things. I improved the testbench so that the new capabilities are automatically tested and also did some general cleanup. The current multiple tcp listener solution will probably receive some further cleanup, too, but looks quite OK so far. I also reviewed the way tcpsrv et all work, in preparation of using this code for imdiag. I need to document the findings, especially as the code is rather complicated "thanks" to the combination of plain tcp and gssapi transport modes. --- doc/imtcp.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/imtcp.html') diff --git a/doc/imtcp.html b/doc/imtcp.html index 0ee0f96a..9ea7efa1 100644 --- a/doc/imtcp.html +++ b/doc/imtcp.html @@ -14,9 +14,10 @@ Encryption can be provided by using stunnel (an alternative is the use the imgssapi modul).
-
In the future, multiple receivers may be configured by +
Multiple receivers may be configured by specifying -$InputTCPServerRun multiple times. This is not currently supported. +$InputTCPServerRun multiple times. This is available since version 4.3.1, earlier +versions do NOT support it.

Configuration Directives:
Caveats/Known Bugs:
Sample:
-
This sets up a TCP server on port 514:
+
This sets up a TCP server on port 514 and permits it to accept up to 500 connections:

-$ModLoad imtcp # -needs to be done just once +<textarea rows="15" cols="60">$ModLoad imtcp # needs to be done just once +$InputTCPMaxSessions 500 $InputTCPServerRun 514 +
Note that the parameters (here: max sessions) need to be set before the listener +is activated. Otherwise, the parameters will not apply. +

[rsyslog.conf overview] [manual index] [rsyslog site]
-
This documentation is part of the -rsyslog +
This documentation is part of the rsyslog project.
-Copyright © 2008 by Rainer -Gerhards and +Copyright © 2008,2009 by Rainer Gerhards and Adiscon. Released under the GNU GPL version 3 or higher.
- + + -- cgit v1.2.3 From 1ada506e2d90377c2475e103340d8986bf8847f9 Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Tue, 27 Oct 2009 17:31:27 +0100 Subject: added the capability to have ruleset-specific main message queues This offers considerable additional flexibility AND superior performance (in cases where multiple inputs now can avoid lock contention) --- doc/imtcp.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/imtcp.html') diff --git a/doc/imtcp.html b/doc/imtcp.html index 0671d6d5..434b3903 100644 --- a/doc/imtcp.html +++ b/doc/imtcp.html @@ -73,7 +73,7 @@ Binds the listener to a specific ruleset.

can not be loaded together with imgssapi (which includes the functionality of imtcp)

Sample:

Example:

This sets up a TCP server on port 514 and permits it to accept up to 500 connections:

$ModLoad imtcp # needs to be done just once
-- 
cgit v1.2.3

From ebf058226120b89bc2735ff72c4c12c14cfa2599 Mon Sep 17 00:00:00 2001
From: Rainer Gerhards <rgerhards@adiscon.com>
Date: Mon, 1 Mar 2010 11:33:48 +0100
Subject: added capability to turn off standard LF delimiter in TCP server

via new directive "$InputTCPServerDisableLFDelimiter on"
---
 doc/imtcp.html | 28 ++++++++++++++++++----------
 1 file changed, 18 insertions(+), 10 deletions(-)

(limited to 'doc/imtcp.html')

diff --git a/doc/imtcp.html b/doc/imtcp.html
index 434b3903..422bbd55 100644
--- a/doc/imtcp.html
+++ b/doc/imtcp.html
@@ -23,7 +23,7 @@ versions do NOT support it.
 
 Configuration Directives:
 <ul>
-<li>$InputTCPServerAddtlFrameDelimiter <Delimiter> 
+<li>$InputTCPServerAddtlFrameDelimiter <Delimiter> 
 This directive permits to specify an additional frame delimiter for plain tcp syslog.
 The industry-standard specifies using the LF character as frame delimiter. Some vendors,
 notable Juniper in their NetScreen products, use an invalid frame delimiter, in Juniper's
@@ -43,28 +43,36 @@ very limited interest in fixing this issue. This directive can not fix th
 That would require much more code changes, which I was unable to do so far. Full details
 can be found at the <a href="http://www.rsyslog.com/Article321.phtml">Cisco tcp syslog anomaly</a>
 page.
-<li>$InputTCPServerNotifyOnConnectionClose [on/off] (available since 4.5.5) 
+<li>$InputTCPServerDisableLFDelimiter <on/off> (available since 5.5.3) 
+Industry-strandard plain text tcp syslog uses the LF to delimit syslog frames. However,
+some users brought up the case that it may be useful to define a different delimiter and
+totally disable LF as a delimiter (the use case named were multi-line messages). This mode
+is non-standard and will probably come with a lot of problems. However, as there is need
+for it and it is relatively easy to support, we do so. Be sure to turn this setting to
+"on" only if you exactly know what you are doing. You may run into all sorts of troubles,
+so be prepared to wrangle with that!
+<li>$InputTCPServerNotifyOnConnectionClose [on/off] (available since 4.5.5) 
 instructs imtcp to emit a message if the remote peer closes a connection. 
 Important: This directive is global to all listeners and must be given right
 after loading imtcp, otherwise it may have no effect.</li>
-<li>$InputTCPServerRun <port> 
+<li>$InputTCPServerRun <port> 
 Starts a TCP server on selected port</li>
-<li>$InputTCPMaxListeners <number> 
+<li>$InputTCPMaxListeners <number> 
 Sets the maximum number of listeners (server ports) supported. Default is 20. This must be set before the first $InputTCPServerRun directive.</li>
-<li>$InputTCPMaxSessions <number> Sets the maximum number of sessions supported. Default is 200. This must be set before the first $InputTCPServerRun directive</li>
-<li>$InputTCPServerStreamDriverMode <number> 
+<li>$InputTCPMaxSessions <number> Sets the maximum number of sessions supported. Default is 200. This must be set before the first $InputTCPServerRun directive</li>
+<li>$InputTCPServerStreamDriverMode <number> 
 Sets the driver mode for the currently selected <a href="netstream.html">network stream driver</a>. <number> is driver specifc.</li>
-<li>$InputTCPServerInputName <name> 
+<li>$InputTCPServerInputName <name> 
 Sets a name for the inputname property. If no name is set "imtcp" is used by default. Setting a 
 name is not strictly necessary, but can be useful to apply filtering based on which input
 the message was received from.
-<li>$InputTCPServerStreamDriverAuthMode <mode-string> 
+<li>$InputTCPServerStreamDriverAuthMode <mode-string> 
 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> 
+<li>$InputTCPServerStreamDriverPermittedPeer <id-string> 
 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>
-<li>$InputTCPServerBindRuleset <ruleset> 
+<li>$InputTCPServerBindRuleset <ruleset> 
 Binds the listener to a specific <a href="multi_ruleset.html">ruleset</a>.</li>
 </ul>
 Caveats/Known Bugs:
-- 
cgit v1.2.3

From 0edf73f88096f3656da466027417d04ce7a2511c Mon Sep 17 00:00:00 2001
From: Rainer Gerhards <rgerhards@adiscon.com>
Date: Fri, 1 Apr 2011 16:26:21 +0200
Subject: added new config directive $InputTCPFlowControl...

... to select if tcp received messages shall be flagged as
light delayable or not.
---
 doc/imtcp.html | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'doc/imtcp.html')

diff --git a/doc/imtcp.html b/doc/imtcp.html
index 422bbd55..b0aaa3c1 100644
--- a/doc/imtcp.html
+++ b/doc/imtcp.html
@@ -57,6 +57,15 @@ instructs imtcp to emit a message if the remote peer closes a connection. 
 after loading imtcp, otherwise it may have no effect.</li>
 <li>$InputTCPServerRun <port> 
 Starts a TCP server on selected port</li>
+<li>$InputTCPFlowControl <on/off> 
+This setting specifies whether some message flow control shall be exercised on the
+related TCP input. If set to on, messages are handled as "light delayable", which means
+the sender is throttled a bit when the queue becomes near-full. This is done in order
+to preserve some queue space for inputs that can not throttle (like UDP), but it
+may have some undesired effect in some configurations. Still, we consider this as
+a useful setting and thus it is the default. To turn the handling off, simply
+configure that explicitely.
+</li>
 <li>$InputTCPMaxListeners <number> 
 Sets the maximum number of listeners (server ports) supported. Default is 20. This must be set before the first $InputTCPServerRun directive.</li>
 <li>$InputTCPMaxSessions <number> Sets the maximum number of sessions supported. Default is 200. This must be set before the first $InputTCPServerRun directive</li>
-- 
cgit v1.2.3

From 6625a8790d3e89b3ecc0612cf08fc917b9631398 Mon Sep 17 00:00:00 2001
From: Rainer Gerhards <rgerhards@adiscon.com>
Date: Mon, 9 May 2011 10:07:23 +0200
Subject: added capability for imtcp to activate keep-alive packets

at the socket layer.
reference: http://kb.monitorware.com/post20791.html
---
 doc/imtcp.html | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'doc/imtcp.html')

diff --git a/doc/imtcp.html b/doc/imtcp.html
index b0aaa3c1..7653f601 100644
--- a/doc/imtcp.html
+++ b/doc/imtcp.html
@@ -55,6 +55,9 @@ so be prepared to wrangle with that!
 instructs imtcp to emit a message if the remote peer closes a connection. 
 Important: This directive is global to all listeners and must be given right
 after loading imtcp, otherwise it may have no effect.</li>
+<li>$InputTCPServerKeepAlive <on/off> 
+enable of disable keep-alive packets at the tcp socket layer. The default is
+to disable them.</li>
 <li>$InputTCPServerRun <port> 
 Starts a TCP server on selected port</li>
 <li>$InputTCPFlowControl <on/off> 
-- 
cgit v1.2.3

From 4fb7ba113c4d4afd485feb2729c5ff67bc8ddd4a Mon Sep 17 00:00:00 2001
From: Rainer Gerhards <rgerhards@adiscon.com>
Date: Mon, 19 Mar 2012 15:28:25 +0100
Subject: added configuration directive to disable octet-counted framing

... for imtcp, directive is $InputTCPServerSupportOctetCountedFraming
---
 doc/imtcp.html | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'doc/imtcp.html')

diff --git a/doc/imtcp.html b/doc/imtcp.html
index 422bbd55..cd10f712 100644
--- a/doc/imtcp.html
+++ b/doc/imtcp.html
@@ -74,6 +74,12 @@ 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>
 <li>$InputTCPServerBindRuleset <ruleset> 
 Binds the listener to a specific <a href="multi_ruleset.html">ruleset</a>.</li>
+<li>$InputTCPSupportOctetCountedFraming <on|off> 
+If set to "on", the legacy octed-counted framing (similar to RFC5425 framing) is
+activated. This is the default and should be left unchanged until you know
+very well what you do. It may be useful to turn it off, if you know this framing
+is not used and some senders emit multi-line messages into the message stream.
+</li>
 </ul>
 Caveats/Known Bugs:
 <ul>
-- 
cgit v1.2.3

From 1269e9598dbefe25b0403f40221c82d166b98ef1 Mon Sep 17 00:00:00 2001
From: Florian Riedl <friedel@adiscon.com>
Date: Tue, 2 Oct 2012 11:16:21 +0200
Subject: doc: update module doc to new capabilities

---
 doc/imtcp.html | 95 ++++++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 76 insertions(+), 19 deletions(-)

(limited to 'doc/imtcp.html')

diff --git a/doc/imtcp.html b/doc/imtcp.html
index 649b08f8..01ea2802 100644
--- a/doc/imtcp.html
+++ b/doc/imtcp.html
@@ -21,9 +21,11 @@ can also be provided by using <a href="rsyslog_stunnel.html">stunnel</a>
 $InputTCPServerRun multiple times. This is available since version 4.3.1, earlier
 versions do NOT support it.
 
+
 Configuration Directives:
+Global Directives:
 <ul>
-<li>$InputTCPServerAddtlFrameDelimiter <Delimiter> 
+<li>AddtlFrameDelimiter <Delimiter> 
 This directive permits to specify an additional frame delimiter for plain tcp syslog.
 The industry-standard specifies using the LF character as frame delimiter. Some vendors,
 notable Juniper in their NetScreen products, use an invalid frame delimiter, in Juniper's
@@ -43,7 +45,7 @@ very limited interest in fixing this issue. This directive can not fix th
 That would require much more code changes, which I was unable to do so far. Full details
 can be found at the <a href="http://www.rsyslog.com/Article321.phtml">Cisco tcp syslog anomaly</a>
 page.
-<li>$InputTCPServerDisableLFDelimiter <on/off> (available since 5.5.3) 
+<li>DisableLFDelimiter <on/off> 
 Industry-strandard plain text tcp syslog uses the LF to delimit syslog frames. However,
 some users brought up the case that it may be useful to define a different delimiter and
 totally disable LF as a delimiter (the use case named were multi-line messages). This mode
@@ -51,16 +53,14 @@ is non-standard and will probably come with a lot of problems. However, as there
 for it and it is relatively easy to support, we do so. Be sure to turn this setting to
 "on" only if you exactly know what you are doing. You may run into all sorts of troubles,
 so be prepared to wrangle with that!
-<li>$InputTCPServerNotifyOnConnectionClose [on/off] (available since 4.5.5) 
+<li>NotifyOnConnectionClose [on/off] 
 instructs imtcp to emit a message if the remote peer closes a connection. 
 Important: This directive is global to all listeners and must be given right
 after loading imtcp, otherwise it may have no effect.</li>
-<li>$InputTCPServerKeepAlive <on/off> 
+<li>KeepAlive <on/off> 
 enable of disable keep-alive packets at the tcp socket layer. The default is
 to disable them.</li>
-<li>$InputTCPServerRun <port> 
-Starts a TCP server on selected port</li>
-<li>$InputTCPFlowControl <on/off> 
+<li>FlowControl <on/off> 
 This setting specifies whether some message flow control shall be exercised on the
 related TCP input. If set to on, messages are handled as "light delayable", which means
 the sender is throttled a bit when the queue becomes near-full. This is done in order
@@ -69,24 +69,32 @@ may have some undesired effect in some configurations. Still, we consider this a
 a useful setting and thus it is the default. To turn the handling off, simply
 configure that explicitely.
 </li>
-<li>$InputTCPMaxListeners <number> 
+<li>MaxListeners <number> 
 Sets the maximum number of listeners (server ports) supported. Default is 20. This must be set before the first $InputTCPServerRun directive.</li>
-<li>$InputTCPMaxSessions <number> Sets the maximum number of sessions supported. Default is 200. This must be set before the first $InputTCPServerRun directive</li>
-<li>$InputTCPServerStreamDriverMode <number> 
+<li>MaxSessions <number> Sets the maximum number of sessions supported. Default is 200. This must be set before the first $InputTCPServerRun directive</li>
+<li>StreamDriver.Mode <number> 
 Sets the driver mode for the currently selected <a href="netstream.html">network stream driver</a>. <number> is driver specifc.</li>
-<li>$InputTCPServerInputName <name> 
-Sets a name for the inputname property. If no name is set "imtcp" is used by default. Setting a 
-name is not strictly necessary, but can be useful to apply filtering based on which input
-the message was received from.
-<li>$InputTCPServerStreamDriverAuthMode <mode-string> 
+<li>StreamDriver.AuthMode <mode-string> 
 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> 
+<li>PermittedPeer <id-string> 
 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>
-<li>$InputTCPServerBindRuleset <ruleset> 
+AuthMode and  <a href="netstream.html">network stream driver</a>. PermittedPeer may not be set in anonymous modes.
+ PermittedPeer may be set either to a single peer or an array of peers either of type IP or name, depending on the tls certificate.
+ Single peer: PermittedPeer="127.0.0.1"
+ Array of peers: PermittedPeer=["test1.example.net","10.1.2.3","test2.example.net","..."]</li>
+</ul>
+Action Directives:
+<ul>
+<li>Port <port> 
+Starts a TCP server on selected port</li>
+<li>Name <name> 
+Sets a name for the inputname property. If no name is set "imtcp" is used by default. Setting a 
+name is not strictly necessary, but can be useful to apply filtering based on which input
+the message was received from.
+<li>Ruleset <ruleset> 
 Binds the listener to a specific <a href="multi_ruleset.html">ruleset</a>.</li>
-<li>$InputTCPSupportOctetCountedFraming <on|off> 
+<li>SupportOctetCountedFraming <on|off> 
 If set to "on", the legacy octed-counted framing (similar to RFC5425 framing) is
 activated. This is the default and should be left unchanged until you know
 very well what you do. It may be useful to turn it off, if you know this framing
@@ -102,6 +110,55 @@ is not used and some senders emit multi-line messages into the message stream.
 Example:
 This sets up a TCP server on port 514 and permits it to accept up to 500 connections: 
 
+<textarea rows="15" cols="60">module(load="/folder/to/rsyslog/plugins/imtcp/.libs/imtcp" MaxSessions="500") # needs to be done just once
+input(type="imtcp" port="514")
+

Note that the global parameters (here: max sessions) need to be set when the module is loaded. Otherwise, the parameters will not apply. +

+ +

Legacy Configuration Directives:

$InputTCPServerAddtlFrameDelimiter <Delimiter>
+equivalent to: AddtlFrameDelimiter +
$InputTCPServerDisableLFDelimiter <on/off> (available since 5.5.3)
+equivalent to: DisableLFDelimiter +
$InputTCPServerNotifyOnConnectionClose [on/off] (available since 4.5.5)
+equivalent to: NotifyOnConnectionClose
+
$InputTCPServerKeepAlive <on/off>
+equivalent to: KeepAlive
$InputTCPServerRun <port>
+equivalent to: Port
$InputTCPFlowControl <on/off>
+equivalent to: FlowControl +
$InputTCPMaxListeners <number>
+equivalent to: MaxListeners
$InputTCPMaxSessions <number>
+equivalent to: MaxSessions
$InputTCPServerStreamDriverMode <number>
+equivalent to: StreamDriver.Mode
$InputTCPServerInputName <name>
+equivalent to: Name +
$InputTCPServerStreamDriverAuthMode <mode-string>
+equivalent to: StreamDriver.AuthMode
$InputTCPServerStreamDriverPermittedPeer <id-string>
+equivalent to: PermittedPeer.
$InputTCPServerBindRuleset <ruleset>
+equivalent to: Ruleset.
$InputTCPSupportOctetCountedFraming <on|off>
+equivalent to: SupportOctetCountedFraming +

+Caveats/Known Bugs: +

module always binds to all interfaces
can not be loaded together with imgssapi +(which includes the functionality of imtcp)

Example:

This sets up a TCP server on port 514 and permits it to accept up to 500 connections:
+

$ModLoad imtcp # needs to be done just once
 $InputTCPMaxSessions 500
 $InputTCPServerRun 514
-- 
cgit v1.2.3

From 0dc56f1426315854c09e78b37104ed1e818a75bb Mon Sep 17 00:00:00 2001
From: Rainer Gerhards <rgerhards@adiscon.com>
Date: Mon, 15 Oct 2012 19:01:05 +0200
Subject: imtcp: support for Linux-Type ratelimiting added

---
 doc/imtcp.html | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

(limited to 'doc/imtcp.html')

diff --git a/doc/imtcp.html b/doc/imtcp.html
index 01ea2802..4bda46ba 100644
--- a/doc/imtcp.html
+++ b/doc/imtcp.html
@@ -17,10 +17,6 @@
 Encryption is natively provided by selecting the approprioate network stream driver and
 can also be provided by using <a href="rsyslog_stunnel.html">stunnel</a>
 (an alternative is the use the <a href="imgssapi.html">imgssapi</a> module).
-Multiple receivers may be configured by specifying
-$InputTCPServerRun multiple times. This is available since version 4.3.1, earlier
-versions do NOT support it.
-
 
 Configuration Directives:
 Global Directives:
@@ -100,6 +96,13 @@ activated. This is the default and should be left unchanged until you know
 very well what you do. It may be useful to turn it off, if you know this framing
 is not used and some senders emit multi-line messages into the message stream.
 </li>
+<li>RateLimit.Interval [number] - (available since 7.3.1) specifies the rate-limiting
+interval in seconds. Default value is 0, which turns off rate limiting. Set it to a number
+of seconds (5 recommended) to activate rate-limiting.
+</li>
+<li>RateLimit.Burst [number] - (available since 7.3.1) specifies the rate-limiting
+burst in number of messages. Default is 10,000.
+</li>
 </ul>
 Caveats/Known Bugs:
 <ul>
-- 
cgit v1.2.3

From 475adc28659a6dd10cdc76a9207384260b8ffbc9 Mon Sep 17 00:00:00 2001
From: Rainer Gerhards <rgerhards@adiscon.com>
Date: Mon, 28 Jan 2013 14:10:01 +0100
Subject: doc: some cleanup

---
 doc/imtcp.html | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'doc/imtcp.html')

diff --git a/doc/imtcp.html b/doc/imtcp.html
index 01ea2802..feb0bdd7 100644
--- a/doc/imtcp.html
+++ b/doc/imtcp.html
@@ -110,7 +110,7 @@ is not used and some senders emit multi-line messages into the message stream.
 Example:
 This sets up a TCP server on port 514 and permits it to accept up to 500 connections: 
 
-<textarea rows="15" cols="60">module(load="/folder/to/rsyslog/plugins/imtcp/.libs/imtcp" MaxSessions="500") # needs to be done just once
+<textarea rows="15" cols="60">module(load="imtcp" MaxSessions="500")
 input(type="imtcp" port="514")

Note that the global parameters (here: max sessions) need to be set when the module is loaded. Otherwise, the parameters will not apply. -- cgit v1.2.3