forked from CESNET/ipfixcol2
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add TCP input readme, fix typo in UDP readme
- Loading branch information
Showing
2 changed files
with
38 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters