Back to Talos

VLANConfig

website/content/v1.13/reference/configuration/network/vlanconfig.md

1.13.03.8 KB
Original Source
<!-- markdownlint-disable -->

{{< highlight yaml >}} apiVersion: v1alpha1 kind: VLANConfig name: enp0s3.34 # Name of the VLAN link (interface) to be created. vlanID: 34 # VLAN ID to be used for the VLAN link. parent: enp0s3 # Name of the parent link (interface) on which the VLAN link will be created.

Configure addresses to be statically assigned to the link.

addresses: - address: 192.168.1.100/24 # IP address to be assigned to the link.

Configure routes to be statically created via the link.

routes: - destination: 192.168.0.0/16 # The route's destination as an address prefix. gateway: 192.168.1.1 # The route's gateway (if empty, creates link scope route).

# Set the VLAN mode to use.

vlanMode: 802.1q

{{< /highlight >}}

FieldTypeDescriptionValue(s)
namestringName of the VLAN link (interface) to be created. <details><summary>Show example(s)</summary>{{< highlight yaml >}}
name: enp0s3.34
{{< /highlight >}}</details>
vlanIDuint16VLAN ID to be used for the VLAN link. <details><summary>Show example(s)</summary>{{< highlight yaml >}}
vlanID: 34
{{< /highlight >}}</details>
vlanModeVLANProtocolSet the VLAN mode to use.
If not set, defaults to '802.1q'. <details><summary>Show example(s)</summary>{{< highlight yaml >}}
vlanMode: 802.1q
{{< /highlight >}}</details>802.1q
802.1ad
parentstringName of the parent link (interface) on which the VLAN link will be created.
Link aliases can be used here as well. <details><summary>Show example(s)</summary>{{< highlight yaml >}}
parent: enp0s3
{{< /highlight >}}</details>
upboolBring the link up or down.

If not specified, the link will be brought up. | | |mtu |uint32 |Configure LinkMTU (Maximum Transmission Unit) for the link.

If not specified, the system default LinkMTU will be used (usually 1500). | | |addresses |<a href="#VLANConfig.addresses.">[]AddressConfig</a> |Configure addresses to be statically assigned to the link. | | |routes |<a href="#VLANConfig.routes.">[]RouteConfig</a> |Configure routes to be statically created via the link. | | |multicast |bool |Set the multicast capability of the link. | |

addresses[] {#VLANConfig.addresses.}

AddressConfig represents a network address configuration.

FieldTypeDescriptionValue(s)
addressPrefixIP address to be assigned to the link.

This field must include the network prefix length (e.g. /24 for IPv4, /64 for IPv6). <details><summary>Show example(s)</summary>{{< highlight yaml >}} address: 192.168.1.100/24 {{< /highlight >}}{{< highlight yaml >}} address: fd00::1/64 {{< /highlight >}}</details> | | |routePriority |uint32 |Configure the route priority (metric) for routes created for this address.

If not specified, the system default route priority will be used. | |

routes[] {#VLANConfig.routes.}

RouteConfig represents a network route configuration.

FieldTypeDescriptionValue(s)
destinationPrefixThe route's destination as an address prefix.

If not specified, a default route will be created for the address family of the gateway. <details><summary>Show example(s)</summary>{{< highlight yaml >}} destination: 10.0.0.0/8 {{< /highlight >}}</details> | | |gateway |Addr |The route's gateway (if empty, creates link scope route). <details><summary>Show example(s)</summary>{{< highlight yaml >}} gateway: 10.0.0.1 {{< /highlight >}}</details> | | |source |Addr |The route's source address (optional). | | |metric |uint32 |The optional metric for the route. | | |mtu |uint32 |The optional MTU for the route. | | |table |RoutingTable |The routing table to use for the route.

If not specified, the main routing table will be used. | |