Skip to content

Commit c1e9883

Browse files
authored
README: add info about NetFlow v5/v9 support, add reference to IPFIX output plugin
1 parent bac616c commit c1e9883

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
IPFIXcol2
22
===========
33

4-
IPFIXcol is a flexible, high-performance IPFIX flow data collector designed to be extensible
5-
by plugins. The second generation of the collector includes many design and performance enhancements
6-
compared to the original `IPFIXcol <https://github.com/CESNET/ipfixcol/>`_.
4+
IPFIXcol2 is a flexible, high-performance NetFlow v5/v9 and IPFIX flow data collector designed
5+
to be extensible by plugins. The second generation of the collector includes many design and
6+
performance enhancements compared to the original `IPFIXcol <https://github.com/CESNET/ipfixcol/>`_.
77

88
.. image:: doc/main_img.svg
99

@@ -25,7 +25,7 @@ Available plugins
2525
**Input plugins** - receive IPFIX data. Each can be configured to to listen on a specific
2626
network interface and a port. Multiple instances of these plugins can run concurrently.
2727

28-
- `UDP <src/plugins/input/udp>`_ - receives IPFIX over UDP
28+
- `UDP <src/plugins/input/udp>`_ - receives NetFlow v5/v9 and IPFIX over UDP
2929
- `TCP <src/plugins/input/tcp>`_ - receives IPFIX over TCP
3030

3131
**Intermediate plugins** - modify, enrich and filter flow records.
@@ -35,10 +35,11 @@ network interface and a port. Multiple instances of these plugins can run concur
3535

3636
**Output plugins** - store or forward your flows.
3737

38-
- `FDS <src/plugins/output/fds>`_ - store all flows in FDS file format (efficient long-term storage)
38+
- `FDS file <src/plugins/output/fds>`_ - store all flows in FDS file format (efficient long-term storage)
3939
- `JSON <src/plugins/output/json>`_ - convert flow records to JSON and send/store them
4040
- `Viewer <src/plugins/output/viewer>`_ - convert IPFIX into plain text and print
4141
it on standard output
42+
- `IPFIX file <src/plugins/output/ipfix>`_ - store all flows in IPFIX File format
4243
- `Time Check <src/plugins/output/timecheck>`_ - flow timestamp check
4344
- `Dummy <src/plugins/output/dummy>`_ - simple module example
4445
- `lnfstore <extra_plugins/output/lnfstore>`_ (*) - store all flows in nfdump compatible
@@ -105,10 +106,9 @@ of the collector are given in the section
105106

106107
Coming soon
107108
-----------
108-
- NetFlow v5/v9 support
109109
- Runtime reconfiguration (improved compared to the previous generation)
110+
- Flow filtration and flow profiling
110111
- RPM/DEB packages
111-
- Support for structured data types (lists, etc.)
112112

113113
FAQ
114114
--------------

0 commit comments

Comments
 (0)