summaryrefslogtreecommitdiff
path: root/docs/connector/source/ipfix.md
blob: 8a766a835561d8017a95d4bd94efa4c658fcac15 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# IPFIX

> IPFIX source collector
>
> ## Description
>
> IPFIX source collector is used to collect IPFIX data from network devices. It supports UDP protocol.
>
> ## Source Options
>
> In order to use the IPFIX connector, the following dependencies are required. They can be download by Nexus Maven Repository.

| Datasource | Supported Versions |                                                                  Maven                                                                   |
|------------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| IPFIX      | Universal          | [Download](http://192.168.40.153:8099/service/local/repositories/platform-release/content/com/geedgenetworks/connector-ipfix-collector/) |

IPFIX source custom properties.

|                  Name                   |  Type   | Required |  Default  |                                                                          Description                                                                          |
|-----------------------------------------|---------|----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
| port.range                              | String  | Yes      | (none)    | Range of ports such as 3000 -3010                                                                                                                             |
| max.packet.size                         | Integer | No       | 65535     | The maximum size of packet for UDP                                                                                                                            |
| max.receive.buffer.size                 | Integer | No       | 104857600 | UDP maximum receive buffer size in bytes                                                                                                                      |
| service.discovery.registry.mode         | String  | No       | (none)    | Service discovery registry mode, support `0(nacos)` and `1(consul)`                                                                                           |
| service.discovery.service.name          | String  | No       | (none)    | Service discovery service name                                                                                                                                |
| service.discovery.health.check.interval | Integer | No       | (none)    | Service discovery health check interval in milliseconds                                                                                                       |
| service.discovery.nacos.server.addr     | String  | No       | (none)    | A list of host/port pairs to use for establishing the initial connection to the Nacos cluster. This list should be in the form `host1:port1,host2:port2,...`. |
| service.discovery.nacos.username        | String  | No       | (none)    | The username to use to connect to Nacos.Need specify `ipfix.service.discovery.registry.mode` to `0(nacos)`                                                    |
| service.discovery.nacos.password        | String  | No       | (none)    | The password to use to connect to Nacos.Need specify `ipfix.service.discovery.registry.mode` to `0(nacos)`                                                    |
| service.discovery.nacos.namespace       | String  | No       | (none)    | The namespace to use to connect to Nacos.Need specify `ipfix.service.discovery.registry.mode` to `0(nacos)`                                                   |
| service.discovery.nacos.group           | String  | No       | (none)    | The group to use to connect to Nacos.Need specify `ipfix.service.discovery.registry.mode` to `0(nacos)`                                                       |
| service.discovery.consul.server.ip      | String  | No       | (none)    | Consul server IP address. Need specify `ipfix.service.discovery.registry.mode` to `1(consul)`                                                                 |
| service.discovery.consul.server.port    | Integer | No       | (none)    | Consul server port. Need specify `ipfix.service.discovery.registry.mode` to `1(consul)`                                                                       |
| service.discovery.consul.token          | String  | No       | (none)    | Consul token. Need specify `ipfix.service.discovery.registry.mode` to `1(consul)`                                                                             |

## Example