diff --git a/src/plugins/input/tcp/README.rst b/src/plugins/input/tcp/README.rst new file mode 100644 index 00000000..1de739e9 --- /dev/null +++ b/src/plugins/input/tcp/README.rst @@ -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 + + + TCP input + tcp + + 4739 + + + + +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] diff --git a/src/plugins/input/udp/README.rst b/src/plugins/input/udp/README.rst index daf1d9f6..b5338f9a 100644 --- a/src/plugins/input/udp/README.rst +++ b/src/plugins/input/udp/README.rst @@ -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]