# NetFlow

### Data Support

* Process [Template Records](https://www.cisco.com/en/US/technologies/tk648/tk362/technologies_white_paper09186a00800a3db9.html) if present
* Process Netflow V5, V9, and IPFIX messages
* Mapping of custom fields is not yet supported

### Supported Platforms

| Platform | Metrics | Logs | Traces |
| -------- | ------- | ---- | ------ |
| Linux    |         | ✓    |        |
| Windows  |         | ✓    |        |
| macOS    |         | ✓    |        |

### Configuration Fields

<table><thead><tr><th width="131.4765625">Field</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td>Scheme</td><td>The scheme to use for the NetFlow source. Can be <code>netflow</code> or <code>sflow</code>.</td><td><code>netflow</code></td></tr><tr><td>Hostname</td><td>The hostname or IP address to bind to.</td><td><code>0.0.0.0</code></td></tr><tr><td>Port</td><td>The port to use for the NetFlow source.</td><td><code>2055</code></td></tr><tr><td>Sockets</td><td>The number of sockets to use for the NetFlow source.</td><td><code>1</code></td></tr><tr><td>Workers</td><td>The number of workers to use for the NetFlow source.</td><td><code>1</code></td></tr></tbody></table>

### Example Configuration

This configuration sets up a basic NetFlow source with necessary details such as host, port, and version.

<figure><img src="https://1405008107-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmiOMzBfoNFwmKJFHMcJ%2Fuploads%2Fgit-blob-eb84d662c2fad344ac833e92bccd4152432d81bc%2Fintegrations-sources-netflow-image-1.png?alt=media" alt="Bindplane docs - NetFlow - image 1"><figcaption></figcaption></figure>

**Standalone Source**

```yaml
apiVersion: bindplane.observiq.com/v1
kind: Source
metadata:
  id: netflow
  name: netflow
spec:
  type: netflow
  parameters:
    - name: scheme
      value: 'netflow'
    - name: hostname
      value: 'localhost'
    - name: port
      value: 2055
    - name: sockets
      value: 1
    - name: workers
      value: 1
```