> ## 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.

# VXLANConfig

> VXLANConfig is a config document to create a VXLAN (Virtual eXtensible LAN) link over a parent link.

```yaml theme={null}
apiVersion: v1alpha1
kind: VXLANConfig
name: vxlan900 # Name of the vxlan link (interface) to be created.
id: 100 # VXLAN network identifier (VNI) to be used for the vxlan link.
local: 10.255.0.1 # Source IP address (IPv4 or IPv6) to use in outgoing packets for the tunnel endpoint.
parent: vtep0 # Name of the parent link (interface) used as the physical device for the tunnel endpoint.
learning: false # Enable learning of source link addresses (MAC learning).

# # Multicast group IP address (IPv4 or IPv6) to join for the tunnel.
# group: 239.1.1.1

# # Destination UDP port for VXLAN traffic.
# port: 4789

# # Override the hardware (MAC) address of the link.
# hardwareAddr: 2e:3c:4d:5e:6f:70
```

<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 vxlan link (interface) to be created.</td>

      <td />
    </tr>

    <tr>
      <td>`id`</td>
      <td>uint32</td>
      <td>VXLAN network identifier (VNI) to be used for the vxlan link.</td>

      <td />
    </tr>

    <tr>
      <td>`local`</td>
      <td>Addr</td>
      <td>Source IP address (IPv4 or IPv6) to use in outgoing packets for the tunnel endpoint.</td>

      <td />
    </tr>

    <tr>
      <td>`group`</td>
      <td>Addr</td>
      <td>Multicast group IP address (IPv4 or IPv6) to join for the tunnel.\
      Either the group or the local address should be set, not both.</td>

      <td />
    </tr>

    <tr>
      <td>`parent`</td>
      <td>string</td>
      <td>Name of the parent link (interface) used as the physical device for the tunnel endpoint.\
      Link aliases can be used here as well.</td>

      <td />
    </tr>

    <tr>
      <td>`port`</td>
      <td>uint16</td>
      <td>Destination UDP port for VXLAN traffic.\
      If not set, defaults to 4789.</td>

      <td />
    </tr>

    <tr>
      <td>`learning`</td>
      <td>bool</td>
      <td>Enable learning of source link addresses (MAC learning).\
      If not set, defaults to true.</td>

      <td />
    </tr>

    <tr>
      <td>`hardwareAddr`</td>
      <td>HardwareAddr</td>
      <td>Override the hardware (MAC) address of the link.</td>

      <td />
    </tr>

    <tr>
      <td>`up`</td>
      <td>bool</td>
      <td>Bring the link up or down.\
      \
      If not specified, the link will be brought up.</td>

      <td />
    </tr>

    <tr>
      <td>`mtu`</td>
      <td>uint32</td>
      <td>Configure LinkMTU (Maximum Transmission Unit) for the link.\
      \
      If not specified, the system default LinkMTU will be used (usually 1500).</td>

      <td />
    </tr>

    <tr>
      <td>`addresses`</td>
      <td>[AddressConfig](#addresses%5B%5D)</td>
      <td>Configure addresses to be statically assigned to the link.</td>

      <td />
    </tr>

    <tr>
      <td>`routes`</td>
      <td>[RouteConfig](#routes%5B%5D)</td>
      <td>Configure routes to be statically created via the link.</td>

      <td />
    </tr>

    <tr>
      <td>`multicast`</td>
      <td>bool</td>
      <td>Set the multicast capability of the link.</td>

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

## addresses\[]

AddressConfig represents a network address configuration.

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

  <tbody>
    <tr>
      <td>`address`</td>
      <td>Prefix</td>
      <td>IP address to be assigned to the link.\
      \
      This field must include the network prefix length (e.g. /24 for IPv4, /64 for IPv6).</td>

      <td />
    </tr>

    <tr>
      <td>`routePriority`</td>
      <td>uint32</td>
      <td>Configure the route priority (metric) for routes created for this address.\
      \
      If not specified, the system default route priority will be used.</td>

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

## routes\[]

RouteConfig represents a network route configuration.

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

  <tbody>
    <tr>
      <td>`destination`</td>
      <td>Prefix</td>
      <td>The route's destination as an address prefix.\
      \
      If not specified, a default route will be created for the address family of the gateway.</td>

      <td />
    </tr>

    <tr>
      <td>`gateway`</td>
      <td>Addr</td>
      <td>The route's gateway (if empty, creates link scope route).</td>

      <td />
    </tr>

    <tr>
      <td>`source`</td>
      <td>Addr</td>
      <td>The route's source address (optional).</td>

      <td />
    </tr>

    <tr>
      <td>`metric`</td>
      <td>uint32</td>
      <td>The optional metric for the route.</td>

      <td />
    </tr>

    <tr>
      <td>`mtu`</td>
      <td>uint32</td>
      <td>The optional MTU for the route.</td>

      <td />
    </tr>

    <tr>
      <td>`table`</td>
      <td>RoutingTable</td>
      <td>The routing table to use for the route.\
      \
      If not specified, the main routing table will be used.</td>

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.