Skip to content

Commit

Permalink
doc: add TCP input readme, fix typo in UDP readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Lukas955 committed Jul 10, 2018
1 parent 4bb0c10 commit 70d4059
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 1 deletion.
37 changes: 37 additions & 0 deletions src/plugins/input/tcp/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
TCP (input plugin)
==================

The plugin receives IPFIX messages over TCP transport protocol from one or more exporters
and pass them into the collector. Multiple instances of the plugin can run concurrently.
However, they must listen on different ports or local IP addresses.

Unlike UDP, TCP is reliable transport protocol that allows exporters to detect connection or
disconnection of the collector. Therefore, the issues with templates retransmission and
initial period of inability to interpret flow records does not apply here.

Example configuration
---------------------

.. code-block:: xml
<input>
<name>TCP input</name>
<plugin>tcp</plugin>
<params>
<localPort>4739</localPort>
<localIPAddress></localIPAddress>
</params>
</input>
Parameters
----------

Mandatory parameters:

:``localPort``:
Local port on which the plugin listens. [default: 4739]
:``localIPAddress``:
Local IPv4/IPv6 address on which the TCP input plugin listens. If the element
is left empty, the plugin binds to all available network interfaces. The element can occur
multiple times (one IP address per occurrence) to manually select multiple interfaces.
[default: empty]
2 changes: 1 addition & 1 deletion src/plugins/input/udp/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Mandatory parameters:
:``localPort``:
Local port on which the plugin listens. [default: 4739]
:``localIPAddress``:
Local IPv4/IPv6 address an which the UDP input plugin listens. If the element
Local IPv4/IPv6 address on which the UDP input plugin listens. If the element
is left empty, the plugin binds to all available network interfaces. The element can occur
multiple times (one IP address per occurrence) to manually select multiple interfaces.
[default: empty]
Expand Down

0 comments on commit 70d4059

Please sign in to comment.