> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siderolabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

> EthernetConfig is a config document to configure Ethernet interfaces.

# EthernetConfig

```yaml theme={null}
apiVersion: v1alpha1
kind: EthernetConfig
name: enp0s2 # Name of the link (interface).
# Configuration for Ethernet features.
features:
    tx-tcp-segmentation: false
# Configuration for Ethernet link rings.
rings:
    rx: 256 # Number of RX rings.
# Configuration for Ethernet link channels.
channels:
    rx: 4 # Number of RX channels.

# # Wake-on-LAN modes to enable.
# wakeOnLan:
#     - unicast
#     - magic
```

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
      <th>Value(s)</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>`name`</td>
      <td>string</td>
      <td>Name of the link (interface).</td>

      <td />
    </tr>

    <tr>
      <td>`features`</td>
      <td>map\[string]bool</td>
      <td>Configuration for Ethernet features.<br /><br />Set of features available and whether they can be enabled or disabled is driver specific.<br />Use `talosctl get ethernetstatus <link> -o yaml` to get the list of available features and<br />their current status.</td>

      <td />
    </tr>

    <tr>
      <td>`rings`</td>
      <td><a href="#rings">EthernetRingsConfig</a></td>
      <td>Configuration for Ethernet link rings.<br /><br />This is similar to `ethtool -G` command.</td>

      <td />
    </tr>

    <tr>
      <td>`channels`</td>
      <td><a href="#channels">EthernetChannelsConfig</a></td>
      <td>Configuration for Ethernet link channels.<br /><br />This is similar to `ethtool -L` command.</td>

      <td />
    </tr>

    <tr>
      <td>`wakeOnLan`</td>
      <td>\[]WOLMode</td>
      <td>Wake-on-LAN modes to enable.<br /><br />If this field is omitted, Wake-on-LAN configuration is not changed.<br />An empty list disables Wake-on-LAN.<br /><br />This is similar to `ethtool -s <link> wol <options>` command.</td>
      <td>`phy`<br />`unicast`<br />`multicast`<br />`broadcast`<br />`arp`<br />`magic`<br />`magicsecure`<br />`filter`<br /></td>
    </tr>
  </tbody>
</table>

## rings

EthernetRingsConfig is a configuration for Ethernet link rings.

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
      <th>Value(s)</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>`rx`</td>
      <td>uint32</td>
      <td>Number of RX rings.</td>

      <td />
    </tr>

    <tr>
      <td>`tx`</td>
      <td>uint32</td>
      <td>Number of TX rings.</td>

      <td />
    </tr>

    <tr>
      <td>`rx-mini`</td>
      <td>uint32</td>
      <td>Number of RX mini rings.</td>

      <td />
    </tr>

    <tr>
      <td>`rx-jumbo`</td>
      <td>uint32</td>
      <td>Number of RX jumbo rings.</td>

      <td />
    </tr>

    <tr>
      <td>`rx-buf-len`</td>
      <td>uint32</td>
      <td>RX buffer length.</td>

      <td />
    </tr>

    <tr>
      <td>`cqe-size`</td>
      <td>uint32</td>
      <td>CQE size.</td>

      <td />
    </tr>

    <tr>
      <td>`tx-push`</td>
      <td>bool</td>
      <td>TX push enabled.</td>

      <td />
    </tr>

    <tr>
      <td>`rx-push`</td>
      <td>bool</td>
      <td>RX push enabled.</td>

      <td />
    </tr>

    <tr>
      <td>`tx-push-buf-len`</td>
      <td>uint32</td>
      <td>TX push buffer length.</td>

      <td />
    </tr>

    <tr>
      <td>`tcp-data-split`</td>
      <td>bool</td>
      <td>TCP data split enabled.</td>

      <td />
    </tr>
  </tbody>
</table>

## channels

EthernetChannelsConfig is a configuration for Ethernet link channels.

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
      <th>Value(s)</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>`rx`</td>
      <td>uint32</td>
      <td>Number of RX channels.</td>

      <td />
    </tr>

    <tr>
      <td>`tx`</td>
      <td>uint32</td>
      <td>Number of TX channels.</td>

      <td />
    </tr>

    <tr>
      <td>`other`</td>
      <td>uint32</td>
      <td>Number of other channels.</td>

      <td />
    </tr>

    <tr>
      <td>`combined`</td>
      <td>uint32</td>
      <td>Number of combined channels.</td>

      <td />
    </tr>
  </tbody>
</table>