Customize /etc/network/interfaces the OMV way [>= 1.11]

votdev · Jan 22nd 2015

The file '/etc/network/interfaces' will be (re-)generated by OMV on demand. Thus custom changes that are done by the user will get lost. To prevent this, the config generation now supports custom scripts to add additional configuration to the '/etc/network/interfaces' file when OMV is generating it. Using this new feature it is no problem to add bridge or VLAN configurations.

To do that a script must be located at /usr/share/openmediavault/mkconf/interfaces.d/. The script should look like the following:

Bash

#!/bin/sh
#
# This file is part of OpenMediaVault.
#
# @license   http://www.gnu.org/licenses/gpl.html GPL Version 3
# @author    Volker Theile <volker.theile@openmediavault.org>
# @copyright Copyright (c) 2009-2015 Volker Theile
#
# OpenMediaVault is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# OpenMediaVault is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with OpenMediaVault. If not, see <http://www.gnu.org/licenses/>.


set -e


. /etc/default/openmediavault
. /usr/share/openmediavault/scripts/helper-functions


OMV_INTERFACES_CONFIG=${OMV_INTERFACES_CONFIG:-"/etc/network/interfaces"}


cat <<EOF >> ${OMV_INTERFACES_CONFIG}
# The loopback network interface
auto lo
iface lo inet loopback
iface lo inet6 loopback
EOF

Display More

The feature will be available with openmediavault 1.11 (see http://sourceforge.net/p/openmediavault/code/1661).

This is obsolete starting with openmediavault 4.0.18 (see https://github.com/openmediava…d3f27749566afe2ae690033a2). Simply put your custom inetrface stanzas in a file below the /etc/network/interfaces.d directory.

eseelke · Mar 30th 2015

I can't quite seem to get a vlan interface to load.

First I installed vlan, ie apt-get install vlan

Then, I created a file called /usr/share/openmediavault/mkconf/interfaces.d/99vlan with the following contents.

Bash

#!/bin/sh
#
# This file is part of OpenMediaVault.
#
# @license   http://www.gnu.org/licenses/gpl.html GPL Version 3
# @author    Volker Theile <volker.theile@openmediavault.org>
# @copyright Copyright (c) 2009-2015 Volker Theile
#
# OpenMediaVault is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# OpenMediaVault is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with OpenMediaVault. If not, see <http://www.gnu.org/licenses/>.


set -e


. /etc/default/openmediavault
. /usr/share/openmediavault/scripts/helper-functions


OMV_INTERFACES_CONFIG=${OMV_INTERFACES_CONFIG:-"/etc/network/interfaces"}


cat <<EOF >> ${OMV_INTERFACES_CONFIG}
# The vlan network interface
auto eth0.2
iface eth0.2 inet dhcp
EOF

Display More

I then added 8021q to /etc/modules.

I rebooted, but /etc/network/interfaces does not have the interface added. Neither does the OMV web interface.

Not sure what I did wrong. Any help would be greatly appreciated.

Eddie

votdev · Mar 31st 2015

You have to build the new file with

Code

# omv-mkconf interfaces

subzero79 · Jan 19th 2016

A word of advise using this method which is good, but to be taken in account:

If you setup static ip address in the main interface via the web panel, and you want to assign another ip address to the same interface you would simply add:

Code

cat <<EOF >> ${OMV_INTERFACES_CONFIG}
# Another ip address for eth0
iface eth0 inet static
address 10.10.10.45
netmask 255.255.255.0
EOF

This will completely overwrite /etc/resolv.conf with no dns servers, so try to match the dns servers of the main interfaces so it looks something like this

Code

cat <<EOF >> ${OMV_INTERFACES_CONFIG}
# Another ip address for eth0
iface eth0 inet static
address 10.10.10.45
netmask 255.255.255.0
dns-nameservers 10.10.10.1 8.8.8.8
dns-search lan
EOF

buers · Jul 25th 2016

Unfortunately, I don't get it quite. I'd like my /etc/network/interfaces file to look like:

Code

# The loopback network interface
auto lo
iface lo inet loopback


# Configure LACP
auto bond0
iface bond0 inet dhcp
    bond-slaves eth0 eth1
    bond-mode 4
    bond-miimon 100
    bond-updelay 800
    bond-downdelay 400

Display More

Can anybody please show, how the shell script in /usr/share/openmediavault/mkconf/interfaces.d/ would look like? [I am not sure, whether my interfaces file is optimal, but it does work] OMV 2.x up to date.

jhwinters · Jun 23rd 2017

In case it's of any use to someone coming after me...

I was trying to set up my new OMV box with a bridge on eth0, and I found this thread which says it's "no problem" but doesn't actually give any clues as to how to go about it - how the new script will interact with the GUI settings, what to put in the file etc.

This is what I did, which seems to work.

1. Take a backup copy of /etc/network/interfaces in case you mess up and need to restore it so you can regain access to the GUI to change things.
2. Create a file /usr/share/openmediavault/mkconf/interfaces.d/25bridge containing:

Bash

#!/bin/sh


set -e


. /etc/default/openmediavault
. /usr/share/openmediavault/scripts/helper-functions


OMV_INTERFACES_CONFIG=${OMV_INTERFACES_CONFIG:-"/etc/network/interfaces"}


cat <<EOF >>${OMV_INTERFACES_CONFIG}


auto br0
iface br0 inet static
        bridge_ports eth0
        address <your ip address>
        netmask <your netmask>
        network <your network>
        broadcast <your broadcast address>
        gateway <your gateway>
        dns-nameservers <your dns servers>
        dns-search <your domain>


EOF

Display More

3. Go in to the GUI network settings and change the entry for eth0 to "Disabled". Save it and apply the changes.

In my case, I didn't even lose connectivity to the OMV box. The bit that took a bit of checking though was setting eth0 to "Disabled". It doesn't actually disable it - it just puts an entry in /etc/network/interfaces saying that device is "manual", which is just what you want then to attach it to your bridge.

Posting in the hope that the job will then be just that tiny bit easier for the next person to come along.

drinks2go · Aug 16th 2017

Just in case you haven't had coffee yet today,

chmod u+x /usr/share/openmediavault/mkconf/interfaces.d/99myface

(make sure the file is executable before running omv-mkconf interfaces if you're having troubles)

kcallis · Mar 11th 2019

Although I am having some network issues, I did want to look at the above. I am running under OMV4, so I what should I be placing in my /etc/network/interface.d? I have been battling with getting my VLAN interface working correctly and I would like to make sure that I am not goig to lose my /etc/network/interface file with a reboot.

iBLtz · Jan 15th 2020

i'm trying in OMV5 to add a Bridge Network to use with KVM.

I created the following file /etc/network/interfaces.d/bridge ( and chmod +x):

Bash

#!/bin/sh
#
# This file is part of OpenMediaVault.
#
# @license   http://www.gnu.org/licenses/gpl.html GPL Version 3
# @author    Volker Theile <volker.theile@openmediavault.org>
# @copyright Copyright (c) 2009-2015 Volker Theile
#
# OpenMediaVault is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# OpenMediaVault is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with OpenMediaVault. If not, see <http://www.gnu.org/licenses/>.


set -e


. /etc/default/openmediavault
. /usr/share/openmediavault/scripts/helper-functions


OMV_INTERFACES_CONFIG=${OMV_INTERFACES_CONFIG:-"/etc/network/interfaces"}


cat <<EOF >> ${OMV_INTERFACES_CONFIG}
# The loopback network interface
auto br0
iface br0 inet dhcp
bridge_ports enp3s0
bridge_fd 0
bridge_hello 0
bridge_maxage 0
bridge_stp off
EOF

Display More

and executed the build command :

Code

omv-salt deploy run systemd-networkd

i have the following output :

Code

/usr/lib/python3/dist-packages/salt/utils/jinja.py:503: DeprecationWarning: Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated, and in 3.8 it will stop working
  if isinstance(values, collections.Hashable):
/usr/lib/python3/dist-packages/salt/utils/decorators/signature.py:31: DeprecationWarning: `formatargspec` is deprecated since Python 3.5. Use `signature` and the `Signature` object directly
  *salt.utils.args.get_function_argspec(original_function)
debian:
----------
          ID: remove_systemd_networkd_config_files
    Function: module.run
      Result: True
     Comment: file.find: ['/etc/systemd/network/10-openmediavault-enp3s0.link', '/etc/systemd/network/10-openmediavault-enp3s0.network']
     Started: 22:51:40.779379
    Duration: 1.435 ms
     Changes:   
              ----------
              file.find:
                  - /etc/systemd/network/10-openmediavault-enp3s0.link
                  - /etc/systemd/network/10-openmediavault-enp3s0.network
----------
          ID: configure_interface_wired_enp3s0_network
    Function: file.managed
        Name: /etc/systemd/network/10-openmediavault-enp3s0.network
      Result: True
     Comment: File /etc/systemd/network/10-openmediavault-enp3s0.network updated
     Started: 22:51:40.783776
    Duration: 57.333 ms
     Changes:   
              ----------
              diff:
                  New file
              mode:
                  0644
----------
          ID: configure_interface_wired_enp3s0_link
    Function: file.managed
        Name: /etc/systemd/network/10-openmediavault-enp3s0.link
      Result: True
     Comment: File /etc/systemd/network/10-openmediavault-enp3s0.link updated
     Started: 22:51:40.841283
    Duration: 35.403 ms
     Changes:   
              ----------
              diff:
                  New file
              mode:
                  0644
----------
          ID: cleanup_etc_network_interfaces
    Function: file.managed
        Name: /etc/network/interfaces
      Result: True
     Comment: File /etc/network/interfaces is in the correct state
     Started: 22:51:40.877036
    Duration: 2.822 ms
     Changes:   
----------
          ID: restart_systemd_networkd
    Function: test.succeed_with_changes
      Result: True
     Comment: Success!
     Started: 22:51:40.881166
    Duration: 0.398 ms
     Changes:   
              ----------
              testing:
                  ----------
                  new:
                      Something pretended to change
                  old:
                      Unchanged
----------
          ID: restart_systemd_networkd
    Function: service.running
        Name: systemd-networkd
      Result: True
     Comment: Service restarted
     Started: 22:51:40.942073
    Duration: 152.967 ms
     Changes:   
              ----------
              systemd-networkd:
                  True


Summary for debian
------------
Succeeded: 6 (changed=5)
Failed:    0
------------
Total states run:     6
Total run time: 250.358 ms

Display More

ip a output :

Code

1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
    link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
    inet 127.0.0.1/8 scope host lo
       valid_lft forever preferred_lft forever
    inet6 ::1/128 scope host 
       valid_lft forever preferred_lft forever
2: enp3s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000
    link/ether 70:85:c2:a8:7d:45 brd ff:ff:ff:ff:ff:ff
    inet 192.168.0.6/24 brd 192.168.0.255 scope global enp3s0
       valid_lft forever preferred_lft forever
3: br-ab457bd081e0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default 
    link/ether 02:42:a9:13:6a:6e brd ff:ff:ff:ff:ff:ff
    inet 172.24.0.1/16 brd 172.24.255.255 scope global br-ab457bd081e0
       valid_lft forever preferred_lft forever
4: br-0e51239e0d2e: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default 
    link/ether 02:42:19:f8:9a:2a brd ff:ff:ff:ff:ff:ff
    inet 172.18.0.1/16 brd 172.18.255.255 scope global br-0e51239e0d2e
       valid_lft forever preferred_lft forever
5: br-1cf77c70ac89: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default 
    link/ether 02:42:5f:9e:13:2f brd ff:ff:ff:ff:ff:ff
    inet 172.22.0.1/16 brd 172.22.255.255 scope global br-1cf77c70ac89
       valid_lft forever preferred_lft forever
6: br-3ac308c0fb54: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue state DOWN group default 
    link/ether 02:42:3c:e2:c7:0f brd ff:ff:ff:ff:ff:ff
    inet 172.21.0.1/16 brd 172.21.255.255 scope global br-3ac308c0fb54
       valid_lft forever preferred_lft forever
7: docker0: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue state DOWN group default 
    link/ether 02:42:79:b0:6e:bd brd ff:ff:ff:ff:ff:ff
    inet 172.17.0.1/16 brd 172.17.255.255 scope global docker0
       valid_lft forever preferred_lft forever
8: br-72723fb11bdc: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue state DOWN group default 
    link/ether 02:42:5b:87:9f:e2 brd ff:ff:ff:ff:ff:ff
    inet 172.23.0.1/16 brd 172.23.255.255 scope global br-72723fb11bdc
       valid_lft forever preferred_lft forever
9: br-9785a5d6fc9e: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default 
    link/ether 02:42:69:46:79:e7 brd ff:ff:ff:ff:ff:ff
    inet 172.25.0.1/16 brd 172.25.255.255 scope global br-9785a5d6fc9e
       valid_lft forever preferred_lft forever
10: br-a1ec75e8a7d6: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default 
    link/ether 02:42:0c:6b:9e:70 brd ff:ff:ff:ff:ff:ff
    inet 172.20.0.1/16 brd 172.20.255.255 scope global br-a1ec75e8a7d6
       valid_lft forever preferred_lft forever
12: vethde2bc92@if11: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue master br-a1ec75e8a7d6 state UP group default 
    link/ether aa:1c:e6:08:23:ab brd ff:ff:ff:ff:ff:ff link-netnsid 4
14: veth675324c@if13: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue master br-0e51239e0d2e state UP group default 
    link/ether 1e:cd:07:2d:df:00 brd ff:ff:ff:ff:ff:ff link-netnsid 2
16: veth936f769@if15: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue master br-1cf77c70ac89 state UP group default 
    link/ether d2:12:29:8f:60:3d brd ff:ff:ff:ff:ff:ff link-netnsid 7
18: veth8fa78e9@if17: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue master br-9785a5d6fc9e state UP group default 
    link/ether ca:e9:56:b1:36:d3 brd ff:ff:ff:ff:ff:ff link-netnsid 8
20: veth4398b1d@if19: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue master br-ab457bd081e0 state UP group default 
    link/ether 2e:37:9d:98:ef:bc brd ff:ff:ff:ff:ff:ff link-netnsid 3
22: veth68ef244@if21: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue master br-0e51239e0d2e state UP group default 
    link/ether de:18:54:90:a8:42 brd ff:ff:ff:ff:ff:ff link-netnsid 6
26: veth0cc1540@if25: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue master br-0e51239e0d2e state UP group default 
    link/ether 42:f2:65:84:7e:c3 brd ff:ff:ff:ff:ff:ff link-netnsid 5

Display More

Somehow the build is not taking the "bridge" file into account. Any tip?

subzero79 · Jan 15th 2020

Doesn’t work in omv5, not even sure if it works in v4. Search for another thread that explains how to do it. If I am not mistaken now net stanzas are read from /etc/network/interfaces.d/

votdev · Jan 16th 2020

OMV5 uses systemd-networkd to configure the network.

Fuelrod · Apr 11th 2020

Quote from votdev

OMV5 uses systemd-networkd to configure the network.

I just upgraded to OMV 5 and had to relearn how the network bridging works now. Here is a good blog post that helped me figure it out.

Creating a bridge for virtual machines using systemd-networkd

tophee · Jul 11th 2020

Quote from votdev

OMV5 uses systemd-networkd to configure the network.

Glad to see this confirmed here. But I'm confused: why is my fresh OMV 5.5.3-1 instance nevertheless affected by changes in `/etc/network/interfaces`? It was my understanding that this file becomes irrelevant when switching to systemd.networkd. What am I missunderstanding?

votdev · Jul 13th 2020

Quote from tophee

What am I missunderstanding?

OMV overrides the /etc/network/interfaces with a warning, see https://github.com/openmediava…etworkd/10cleanup.sls#L28. If a user still wants to use this outdated feature, then custom configurations muts be located in /etc/network/interfaces.d.

tophee · Jul 13th 2020

Quote from votdev

OMV overrides the /etc/network/interfaces with a warning, see https://github.com/openmediava…etworkd/10cleanup.sls#L28. If a user still wants to use this outdated feature, then custom configurations muts be located in /etc/network/interfaces.d.

I'm not sure I quite understand how this works. The part I understand is that changes should go to /etc/network/interfaces.d. But what I don't understand is why those changes would even be picked up by OMV when it is no longer using this outdated feature. Or is it possible to mix /etc/network/interfaces with netplan and systemd, i.e. to have some settings specified in the old system and some in the new?

votdev · Jul 13th 2020

systemd-networkd still supports the /etc/network/interfaces configuration. But i would always use systemd nowadays. OMV configures the oldstyle config file because software or users that don't want or don't know how to use systemd-networkd or netplan should not be cut off.

tophee · Jul 13th 2020

In that case I would suggest that you (OMV) actually put that warning that you showed me in the source code into /etc/network/interfaces.d so that the user choosing that path knows that systemd is is also available.

deafmute · Nov 8th 2020

/etc/network/interfaces.d/* doesn't seem to work at all as of omv 5.5.14-1. I put some stanzas in there and nothing happens on reboot. However, the systemd network configuration locations seem to accept the old fashioned interface style stanzas fine, without wrapping them in ExecStart and the typical systemd syntax. So you can just do mv /etc/network/interfaces.d/* /etc/systemd/network and it should all work. However, it may be better long term to move everything into the correct systemd sytnax.

As above, it would be best to update the comments in /etc/network/interfaces. Perhaps remove the

source-directory /etc/network/interfaces.d so not as to give people the false impression that that folder will do anything.

ryecoaaron · Nov 8th 2020

Quote from deafmute

/etc/network/interfaces.d/* doesn't seem to work at all as of omv 5.5.14-1. I put some stanzas in there and nothing happens on reboot. However, the systemd network configuration locations seem to accept the old fashioned interface style stanzas fine, without wrapping them in ExecStart and the typical systemd syntax. So you can just do mv /etc/network/interfaces.d/* /etc/systemd/network and it should all work. However, it may be better long term to move everything into the correct systemd sytnax.

As above, it would be best to update the comments in /etc/network/interfaces. Perhaps remove the
source-directory /etc/network/interfaces.d so not as to give people the false impression that that folder will do anything.

This thread is very old. OMV 5.x uses netplan. The comment or source-directory comment in interfaces means nothing.

Exill · Feb 3rd 2021

Quote from ryecoaaron

This thread is very old. OMV 5.x uses netplan. The comment or source-directory comment in interfaces means nothing.

Thank you ryecoaaron!

I have been searching for what network manager omv use and have read a lot conflicted information.

I will try to generate netplan config files and reboot my omw instance.

Customize /etc/network/interfaces the OMV way [>= 1.11]

Participate now!

Tags