VLAN - ArchWiki

Jump to content

# VLAN

2 languages

- 日本語
- 中文（简体）

From ArchWiki

Related articles

- Network configuration
- Network tools
- Netctl
- systemd-networkd

Virtual LANs give you the ability to subdivide a LAN. Linux can accept VLAN tagged traffic and presents each VLAN ID as a different network interface (eg: `eth0.100` for VLAN ID `100`).

This article explains how to configure a VLAN using iproute2 and systemd-networkd or netctl.

## Instant Configuration

In the following examples, let us assume the interface is `eth0`, the assigned name is `eth0.100` and the VLAN ID is `100`.

### Create the VLAN device

Add the VLAN interface with the following command:

    # ip link add link eth0 name eth0.100 type vlan id 100

Run `ip link` to confirm that it has been created.

This interface behaves like a normal interface. All traffic routed to it will go through the master interface (in this example, `eth0`) but with a VLAN tag. Only VLAN-aware devices can accept them if configured correctly, else the traffic is dropped.

Using a name like `eth0.100` is just convention and not enforced; you can alternatively use `eth0_100` or something descriptive like `IPTV`. To see the VLAN ID on an interface, in case you used an unconventional name:

    # ip -details link show eth0.100

The `-details` (`-d`) flag shows full details of an interface:

    # ip -details addr show
    4: eth0.100@eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default
       link/ether 96:4a:9c:84:36:51 brd ff:ff:ff:ff:ff:ff promiscuity 0
       vlan protocol 802.1Q id 100 <REORDER_HDR>
       inet6 fe80::944a:9cff:fe84:3651/64 scope link
          valid_lft forever preferred_lft forever

### Add an IP

Now add an IPv4 address to the just created VLAN link, and activate the link:

    # ip addr add 192.168.100.1/24 brd 192.168.100.255 dev eth0.100
    # ip link set dev eth0.100 up

### Turning down the device

To cleanly shut down the setting before you remove the link, you can do:

    # ip link set dev eth0.100 down

### Removing the device

Removing a VLAN interface is significantly less convoluted

    # ip link delete eth0.100

## Persistent Configuration

### systemd-networkd

#### Single interface

Use the following number-prefixed configuration files (Remember the file contents are case sensitive and the number-prefix can be changed):

    /etc/systemd/network/10-eth0.network

    [Match]
    Name=eth0

    [Network]
    DHCP=ipv4
    ;these are arbitrary names, but must match the *.netdev and *.network files
    VLAN=eth0.100
    VLAN=eth0.200

    /etc/systemd/network/20-eth0.100.netdev

    [NetDev]
    Name=eth0.100
    Kind=vlan

    [VLAN]
    Id=100

    /etc/systemd/network/21-eth0.200.netdev

    [NetDev]
    Name=eth0.200
    Kind=vlan

    [VLAN]
    Id=200

You will have to have associated .network files for each .netdev to handle addressing and routing. For example, to set the eth0.100 interface with a static IP and the eth0.200 interface with DHCP (but ignoring the supplied default route), use:

    /etc/systemd/network/30-eth0.100.network

    [Match]
    Name=eth0.100

    [Network]
    DHCP=no

    [Address]
    Address=192.168.0.25/24

    /etc/systemd/network/31-eth0.200.network

    [Match]
    Name=eth0.200

    [Network]
    DHCP=yes

    [DHCP]
    UseRoutes=false

Then enable `systemd-networkd.service`. See systemd-networkd for details.

#### Single interface with multiple VLANs each with its own gateway

Each vlan gets its own routing table and a RoutingPolicyRule that specifies which source ip addresses this routing applies to.

    /etc/systemd/network/10-eth0.network

    [Match]
    Name=eth0

    [Network]
    VLAN=eth0.10
    VLAN=eth0.11
    DNS=192.168.100.101
    DNS=192.168.100.102

    /etc/systemd/network/20-eth0.10.netdev

    [NetDev]
    Name=eth0.10
    Kind=vlan

    [VLAN]
    Id=10

    /etc/systemd/network/30-eth0.10.network

    [Match]
    Name=eth0.10

    [Network]
    Address=192.168.1.14/24
    Address=192.168.1.24/24

    [Route]
    Gateway=192.168.1.1
    Table=10

    [RoutingPolicyRule]
    From=192.168.1.0/24
    Table=10

    /etc/systemd/network/21-eth0.11.netdev

    [NetDev]
    Name=eth0.11
    Kind=vlan

    [VLAN]
    Id=11

    /etc/systemd/network/31-eth0.11.network

    [Match]
    Name=eth0.11

    [Network]
    Address=192.168.100.54/24

    [Route]
    Gateway=192.168.100.1
    Table=11

    [RoutingPolicyRule]
    From=192.168.100.0/24
    Table=11

##### Checks

    # ip rule

    0:      from all lookup local
    0:      from 192.168.1.0/24 lookup 10
    0:      from 192.168.100.0/24 lookup 11
    32766:  from all lookup main
    32767:  from all lookup default

Use `ip route list table`. E.g.:

    # ip route list table 10

    default via 192.168.1.1 dev enp1.10 proto static

    # ip route list table 11

    default via 192.168.100.1 dev enp1.11 proto static

#### Bonded interface

Similar to above, you are just going to stack more of the concepts in place. You will want to ensure that you have got a bond set up in your switch and also make sure its a trunk with tagged vlans corresponding to what you create below. Convention would be to create a bond interface with the name `bond0`, however there is a known issue where the `bonding` module, when loaded, creates a bond device of the name `bond0` which systemd then refuses to configure (as systemd tries to respectfully leave alone any device it did not create).

Tip: To prevent the `bonding` module to create an initial `bond0` interface, set the `max_bonds` option of the bonding module to `0` (default value is `1`):

    /etc/modprobe.d/bonding.conf

    options bonding max_bonds=0

See Kernel modules#Setting module options and Linux Ethernet Bonding Driver HOWTO (Kernel Documentation)for details.

For the purposes of this write up, we are going to use `bondname` and you can make the choice yourself.

First, we create the bond device:

    /etc/systemd/network/bondname.netdev

    [NetDev]
    Name=bondname
    Kind=bond

    [Bond]
    Mode=802.3ad
    LACPTransmitRate=fast

Now create a .network directive that references the vlans and interface carriers. In this case we will use the convention for a dual port fiber module:

    /etc/systemd/network/bondname.network

    [Match]
    Name=bondname

    [Network]
    VLAN=vlan10
    VLAN=vlan20
    VLAN=vlan30
    BindCarrier=enp3s0f0 enp3s0f1

We are using the vlan<number> naming convention here, you can use something else but realize that this is a named reference so you will have to have a corresponding set of files with the same name.

We will now set up the physical network interfaces:

    /etc/systemd/network/enp3s0f0.network

    [Match]
    Name=enp3s0f0

    [Network]
    Bond=bondname

    /etc/systemd/network/enp3s0f1.network

    [Match]
    Name=enp3s0f1

    [Network]
    Bond=bondname

At this time you could reboot, and likely should, because the bonded interface is created at boot time. Restarting systemd-networkd will consume changes from these files typically, but device creation seems to occur at startup.

We will now set up the VLANs. You should be aware that having multiple VLANs can result in a situation where your machine has multiple default routes, so you will need to specify a Destination directive in the network directives to ensure that only one VLAN is being used for a default route. In this case we will use the VLAN with an ID of 10 as our default route.

    /etc/systemd/network/vlan10.netdev

    [NetDev]
    Name=vlan10
    Kind=vlan

    [VLAN]
    Id=10

Now create the associated network directive to set an address:

    /etc/systemd/network/vlan10.network

    [Match]
    Name=vlan10

    [Network]
    VLAN=vlan10

    [Address]
    Address=10.10.10.2/24

    [Route]
    Destination=0.0.0.0/0
    Gateway=10.10.10.1

We will create a similar pair of files for the VLAN with an ID of 20:

    /etc/systemd/network/vlan20.netdev

    [NetDev]
    Name=vlan20
    Kind=vlan

    [VLAN]
    Id=20

    /etc/systemd/network/vlan20.network

    [Match]
    Name=vlan20

    [Network]
    VLAN=vlan20

    [Address]
    Address=10.10.20.2/24

    [Route]
    Destination=10.10.20.0/24
    Gateway=10.10.20.1

And again for the VLAN with an ID of 30:

    /etc/systemd/network/vlan30.netdev

    [NetDev]
    Name=vlan30
    Kind=vlan

    [VLAN]
    Id=30

    /etc/systemd/network/vlan30.network

    [Match]
    Name=vlan30

    [Network]
    VLAN=vlan30

    [Address]
    Address=10.10.30.2/24

    [Route]
    Destination=10.10.30.0/24
    Gateway=10.10.30.1

Note that the Destination on `vlan10` is set to `0.0.0.0/0`, which will match all outbound, becoming the default route.

### netctl

You can use netctl for this purpose, see the self-explanatory example profiles in `/etc/netctl/examples/vlan-{dhcp,static}`.

### Setting bridge IP

Sometimes you might want to configure the bridge ip on which docker operates, for example when the default ip clashes with other ip addresses in the network. Docker has a straight forward way of setting the `bip` (bridge IP) via the `/etc/docker/daemon.json`. When this file does not exist yet you can create it.

    /etc/docker/docker.json

    {
        "bip": "<desired ip range>/24"
    }

## Troubleshooting

### udev renames the virtual devices

An annoyance is that udev may try to rename virtual devices as they are added, thus ignoring the `name` configured for them (in this case `eth0.100`):

    # ip link add link eth0 name eth0.100 type vlan id 100
    # ip link show

This could generate the following output:

    1: lo: <LOOPBACK,UP,LOWER_UP> mtu 16436 qdisc noqueue state UNKNOWN
        link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
    2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq state UP qlen 1000
        link/ether aa:bb:cc:dd:ee:ff brd ff:ff:ff:ff:ff:ff
    3: rename1@eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state DOWN
        link/ether aa:bb:cc:dd:ee:ff brd ff:ff:ff:ff:ff:ff

udev has ignored the configured virtual interface name `eth0.100` and named it `rename1`.

The solution is to edit `/etc/udev/rules.d/network_persistent.rules` and append `DRIVERS=="?*"` to the end of the physical interface configuration line.

For example, for the interface `aa:bb:cc:dd:ee:ff` (`eth0`):

    /etc/udev/rules.d/network_persistent.rules

    SUBSYSTEM=="net", ATTR{address}=="aa:bb:cc:dd:ee:ff", NAME="eth0", DRIVERS=="?*"

A reboot should mean that VLANs configure correctly with the names assigned to them.

Category:

- Networking