# 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="/files/kkjuGdeba1z5xeKITcyk" 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
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.bindplane.com/integrations/sources/netflow.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
