Edit cache_LogicalInterfaceNames

Title:

Last edited: 11:26:23 am on 4 October 2010 by salchicha.sico.local

*Cache of http://www.science.uva.nl/research/air/wiki/LogicalInterfaceNames>http://www.science.uva.nl/research/air/wiki/LogicalInterfaceNames*

<div class="header">
	<h2>AIR Wiki : <a href="http://www.science.uva.nl/research/air/wiki/TextSearch?phrase=LogicalInterfaceNames">LogicalInterfaceNames</a></h2>
	<a href="http://www.science.uva.nl/research/air/wiki/HomePage" title="">HomePage</a> ::
	<a href="http://www.science.uva.nl/research/air/wiki/CategoryCategory" title="">Categories</a> :: <a href="http://www.science.uva.nl/research/air/wiki/PageIndex" title="">PageIndex</a> :: <a href="http://www.science.uva.nl/research/air/wiki/RecentChanges" title="">RecentChanges</a> :: <a href="http://www.science.uva.nl/research/air/wiki/RecentlyCommented" title="">RecentlyCommented</a> :: <a href="http://www.science.uva.nl/research/air/wiki/UserSettings" title="">Login/Register</a> 	
</div>
<div class="page" ondblclick="document.location='http://www.science.uva.nl/research/air/wiki/LogicalInterfaceNames/edit';" >
<h3>How to reorder or rename logical interface names in Linux</h3>

<br />
One of the problems of Linux is that the order of the network interfaces is unpredictable. Between reboots it usually stays the same, but often after an upgrade to a new kernel or the addition or replacement of a network card (NIC) the order of all network interfaces changes. For example, what used to be eth0 now becomes eth1 or eth2 or visa versa.<br />
<br />
Obviously there is some logic to which network interface gets which name, but Linux documentation states that this may change and no user or program should ever assume anything about this. This is annoying, in particular if your management interface is at eth1 at one node in a cluster and at eth2 in another node of the same cluster (which we have experienced). I personally like to have my (primary) management interface always to be eth0.<br />
<br />
Thankfully, there are ways to achieve this. They can be divided in four methods:<br />
<div class="indent">1. Order the network interfaces based on physical properties of the NIC. (e.g. the physical location in the machine)<br />
2. Order the network interfaces based on the MAC address of the NIC.<br />
3. Order the network interfaces based on the driver of the NIC.<br />
4. Order the network interfaces based on the physical location of the NIC in the computer</div>
<br />
So you have to pick a method that suits you. I recommend either to use ifrename (based on physcial properties, especially useful if you often change network cards in your hosts) or writing a udev rule (based on the MAC address). However, I listed the other methods as well. Be aware that the last two methods mentioned in this article are only for the masochistic (you <em>will</em> scream and shoot to get those to work).<br />
<br />
<em>Note</em>: Linux kernels up to 2.4 did only probe for the first Ethernet card, ignoring other NICs. We assume you use a 2.6 or higher kernel or already fixed this, for example by specifying <a class="ext" href="http://www.tldp.org/HOWTO/BootPrompt-HOWTO-11.html">ether=0,0,eth1 as kernel parameter</a><span class='exttail'>&#8734;</span>.<br />
<br />
<h4>Based on the physical properties</h4>

<br />
Perhaps the most elegant way to name the ethernet NIC is to do so based on their physical properties, like link speed and port type.<br />
<br />
<h5>Using the ifrename tool</h5>

<br />
Ifrename is a tool specifically designed to (re)name network interfaces based on characteristics like MAC address (wildcards supported), bus information, and hardware settings. It uses a control file (/etc/iftab) to specify rules about how the interfaces will be named. (thanks to Matt Baron for this tip.)<br />
<br />
<div class="code">
<pre># Example /etc/iftab file
eth2           mac 08:00:09:DE:82:0E
eth3           driver wavelan interrupt 15 baseaddress 0x390
eth4           driver pcnet32 businfo 0000:02:05.0
# wildcard name: pick the lowest available name of air0, air1, air2, etc.
air&star;           mac 00:07:0E:&star; arp 1</pre></div>
<br />
<br />
<h5>Using the ethtool and ip programs</h5>

<br />
It is possible to check the NIC properties using the ethtool program, and to change the name using the ip program (thanks to Jollynn Schmidt for this tip):<br />
<br />
<div class="code">
<pre>if ethtool eth0 | grep -q &quot;Port: FIBRE&quot;; then
	   ip link set dev eth0 name not_eth0
	   ip link set dev eth1 name eth0
	   ip link set dev not_eth0 name eth1
fi</pre></div>
<br />
<br />
The disadvantage of ethtool is that it can only be run by root, even when you're only using it to query for information. Though this is a minor annoyance of ethtool, it doesn't matter in this case, since you want to set a device name and thus need to be root anyway.<br />
<br />
<h4>Based on the MAC address</h4>

<br />
Secondly, it is also possible to name the network interface based on the MAC address of each NIC. The advantage is that it is possible to use this method if you have two NICs which use the same driver (unlike the next method: based on driver).<br />
<br />
First, you must determine the MAC address of your interfaces. You can do this locally on a machine running <div class="code">
<pre>ifconfig -a</pre></div>
<br />
The MAC address is listed as "hwaddr" (hardware address). Alternatively, you can even determine MAC addresses remotely using <tt>ping</tt> and <tt>/sbin/arp</tt>.<br />
<br />
There are three ways to map the MAC address to the logical interface name. Either by using the udev rules, with the get-mac-address.sh script, or by using the nameif program.<br />
<br />
The udev method should work on all recent Linux distributions, and is recommended. The get-mac-address.sh script and the nameif program are know to work with Debian, while on Red Hat, you can change the interface configuration file.<br />
<br />
<h5>Using udev rules</h5>

udev replaced devfs in Linux 2.6. First make sure that your Linux system has udev installed, rather then devfs. If you have a <tt>/etc/udev</tt> directory, but not <tt>/etc/devfs</tt> directory, you are probably fine. If not, be aware that changing your kernel from devfs to udev is possible, but is not just a matter of adding a new module. Perhaps for now, another method is easier for you.<br />
<br />
Now that you have udev, it is rather simple. You only need to create a udev rule mapping the MAC address to the interface name. Store this in a file inside the <tt>/etc/udev/rules.d/</tt> directory:<br />
<div class="code">
<pre>KERNEL==&quot;eth?&quot;, SYSFS{address}==&quot;00:37:e9:17:64:af&quot;, NAME=&quot;eth0&quot;  # MAC of first NIC in lowercase
KERNEL==&quot;eth?&quot;, SYSFS{address}==&quot;00:21:e9:17:64:b5&quot;, NAME=&quot;eth1&quot;  # MAC of second NIC in lowercase</pre></div>
<br />
<br />
Most distibutions already come with an example config file for you. E.g. <tt>/etc/udev/rules.d/network-devices.rules</tt> or <tt>/etc/udev/rules.d/010_netinterfaces.rules</tt>. More information can be found at <a class="ext" href="http://www.reactivated.net/writing_udev_rules.html">http://www.reactivated.net/writing_udev_rules.html</a><span class='exttail'>&#8734;</span> or <a class="ext" href="http://www.debianhelp.co.uk/udev.htm">http://www.debianhelp.co.uk/udev.htm</a><span class='exttail'>&#8734;</span>. (Thanks to Casey Scott and Ron Hermsen for the pointers.)<br />
<br />
Another rule I've seen is:<br />
<div class="code">
<pre>SUBSYSTEM==&quot;net&quot;, DRIVERS==&quot;?*&quot;, ATTRS{address}==&quot;00:16:3e:00:02:00&quot;, NAME=&quot;eth0&quot;
SUBSYSTEM==&quot;net&quot;, DRIVERS==&quot;?*&quot;, ATTRS{address}==&quot;00:16:3e:00:02:01&quot;, NAME=&quot;eth1&quot;</pre></div>
<br />
<br />
I'm not sure about the difference between these rules. Information is welcome (please leave a comment below)<br />
<br />
<br />
<h5>Using the interface configuration file</h5>

If you run a Red-Hat-based distribution, you can simply add the MAC addres in the interface configuration file <tt>/etc/sysconfig/network-scripts/ifcfg-eth0</tt>:<br />
<br />
<div class="code">
<pre>DEVICE=eth0
HWADDR=00:37:e9:17:64:af</pre></div>
<br />
<br />
You can give it any DEVICE name you want, like DEVICE=ethmgmt, as long as you remember to rename the config file:<br />
<tt>/etc/sysconfig/network-scripts/ifcfg-ethmgmt</tt><br />
<br />
Source: <a class="ext" href="http://forums.serverwatch.com/showthread.php?t=18476">http://forums.serverwatch.com/showthread.php?t=18476</a><span class='exttail'>&#8734;</span><br />
<br />
<h5>Using the get-mac-address.sh script</h5>

Another solution is to use the <tt>get-mac-address.sh</tt> script to map interface names by MAC address. On Debian, this script is distributed as part of the <a class="ext" href="http://packages.debian.org/ifupdown">ifupdown package</a><span class='exttail'>&#8734;</span> (in <tt>/usr/share/doc/ifupdown/examples/get-mac-address.sh</tt>). Copy this script to a saner place (e.g. <tt>/usr/local/bin</tt>), and you can setup <tt>/etc/network/interfaces</tt> in this manner:<br />
<br />
<div class="code">
<pre>auto lo eth0 eth1

iface lo inet loopback

mapping eth0 eth1
	    script /usr/local/bin/get-mac-address.sh
	    map 00:37:E9:17:64:AF netA
	    map 00:21:E9:17:64:B5 netB

iface netA inet static
	    address etc...

iface netB inet static
	    address etc...</pre></div>
<br />
<br />
Source: <a class="ext" href="https://www.gelato.unsw.edu.au/archives/gelato-technical/2004-February/000334.html">https://www.gelato.unsw.edu.au/archives/gelato-technical/2004-February/000334.html</a><span class='exttail'>&#8734;</span><br />
<br />
The disadvantage of this method is that defines a mapping, rather then changing the actual logical interface name.<br />
<br />
<h5>Using the nameif program</h5>

<br />
Alternative to the get-mac-address.sh script, you can also use the slightly more convenient <tt>nameif</tt> program, which is distributed as part of the <a class="ext" href="http://packages.debian.org/net-tools">net-tools package</a><span class='exttail'>&#8734;</span> on Debian.<br />
<br />
The advantage of nameif is that you can specify the interface names in the <tt>/etc/mactab</tt> file:<br />
<div class="code">
<pre>ethmgnt 00:37:E9:17:64:AF
ethwireless 00:21:E9:17:64:B5</pre></div>
<br />
<br />
It is not possible to rename an interface to a name of an existing interface. So you can't rename eth1 to eth0 as long as eth0 still exists. It is possible to still swap the names eth0 and eth1 by using a temporary name (e.g. first rename eth1 to ethfoo, then eth0 to eth1 and finally ethfoo to eth0). Note that this method may lead to problems if you use common names such as eth0 and eth1. If you upgrade a kernel, the names may be different than you expected, and you may rename a NIC to eth0 while eth0 still exists, leading to name collisions. Therefor, it is recommended to use other names like "ethmgmnt", "ethwired", "ethwireless" and "eth10ge", as shown in the example above.<br />
<br />
<h4>Based on the driver</h4>

<br />
<strong>Warning</strong>: This only works if the driver is available as a loadable module. Not if it is built into the kernel.<br />
<br />
This is a relative easy method, since it does not rely on external scripts. The idea is to just load the kernel module for your eth0 interface before the modules for other network cards.<br />
<br />
First of all, you must determine which driver is used for each network card. Thankfully Linux does have a system to load the appropriate driver automatically, based on the <a class="ext" href="http://pci-ids.sourceforge.net/">PCI ID</a><span class='exttail'>&#8734;</span> of the network card. Unfortunately, there is no single command to simply get the driver (and other information like the link speed) based on just the interface name in Linux. Your best bet is to look for kernel messages:<br />
<div class="code">
<pre>dmesg | grep eth</pre></div>
<br />
This should give you a good estimate of the driver name. You can verify if the name indeed does exist and is loaded:<br />
<div class="code">
<pre>lsmod</pre></div>
<br />
<br />
<strong>Note</strong>: <br />
lsmod gave:<br />
<div class="code">
<pre>e1000           84868  0
tg3             70816  0</pre></div>
<br />
However, the 0 indicates that these drivers are not controlling any device! That is strange, since <tt>modprobe -r tg3</tt> and <tt>modprobe -r e1000</tt> do disable the network cards. Apparently, this is a flaw in <tt>lsmod</tt>.<br />
<br />
Note that running <tt>modprobe tg3</tt> en then <tt>modprobe e1000</tt> does bring them up in the correct order, with the correct interface names. This is a good check if this approach (using the driver to decide the interface name) can work.<br />
<br />
<h5>Red Hat</h5>

In Red Hat, if the driver is called "tg3" (the Tigon driver), you simply specify the network name by adding this enty in <tt>/etc/modules.conf</tt>:<br />
<div class="code">
<pre>~alias eth0 tg3</pre></div>
<br />
<br />
<h5>Debian</h5>

On a Debian system, <tt>/etc/modules.conf</tt> is generated automatically and should not be edited directly. Instead, create a file in the subdirectory <tt>/etc/modules/</tt> (do not use <tt>/etc/modprobe.d/</tt>, that seems out-of-date). For example, create the file <tt>/etc/modutils/interfaces</tt> and add the appropriate modules. For example:<br />
<div class="code">
<pre>alias eth0 tg3
alias eth1 e1000</pre></div>
<br />
Next, update <tt>/etc/modules.conf</tt> by running:<br />
<div class="code">
<pre>update-modules</pre></div>
<br />
<br />
<strong>Alternative method</strong>: I have encountered scenario's where the kernel did already load the modules for the drivers, even before <tt>/etc/modules.conf</tt> was read. The result was that in effect, the specification in <tt>/etc/modules.conf</tt> was ignored, and this method did not work. As an alternative, it is possible to also list the drivers, in the appropriate order, in <tt>/etc/modules</tt> (thus <em>not</em> <tt>/etc/modules.conf</tt>):<br />
<div class="code">
<pre>tg3
e1000</pre></div>
<br />
The result will be that the tg3 driver is loaded before the e1000 kernel. Since <tt>/etc/modules</tt> only exists for Debian, this trick will most likely not work for other distributions.<br />
<br />
<h4>Based on the physical location in the computer</h4>

<br />
<strong>Warning</strong>: This only works if the driver is built into the kernel, not as a loadable module. <br />
<br />
<em>Note: It is relatively hard to get this to work, and we encountered problems with it. The other methods are recommended.</em><br />
<br />
It is possible to name the network interfaces based on the interrupt (IRQ) and memory address. This should work if you have network cards in PCI busses, and it involves appending the proper parameters to the "ether=" or "netdev=" kernel parameters.<br />
<br />
First of all, you can detect the PCI slot of the devices using <div class="code">
<pre>lspci -v</pre></div>
 This is reported to fail sometimes for certain cards. Now, write down the IRQ and IO (memory) address of each network card, and use this information to specify the interface name in your LILO or GRUB configuration file.<br />
<br />
For LILO, you need to add an add line to the appropriate boot configuration. For example: <br />
<div class="code">
<pre>append=&quot;netdev=irq=21,io=0x2040,name=eth0 netdev=irq=20,io=0x3000,name=eth1 netdev=irq18,io=0x2000,name=eth2&quot;</pre></div>
<br />
Under grub, it can just be listed as parameter. e.g.: <div class="code">
<pre>kernel /boot/vmlinuz netdev=irq=24,name=eth0</pre></div>
<br />
<br />
<h5>More Information</h5>

<a class="ext" href="http://www.tldp.org/HOWTO/Ethernet-HOWTO-8.html">http://www.tldp.org/HOWTO/Ethernet-HOWTO-8.html</a><span class='exttail'>&#8734;</span><br />
<a class="ext" href="http://www.tldp.org/HOWTO/BootPrompt-HOWTO-11.html">http://www.tldp.org/HOWTO/BootPrompt-HOWTO-11.html</a><span class='exttail'>&#8734;</span><br />
<br />
<hr />

Written by Freek Dijkstra. Licensed under public domain. (That is, feel free to modify, redistribute, cripple, or even sell it as your own work, and there is no need to mention the source, even though you are of course welcome to do so.)<br />
<br />
<h5>Categories</h5>

<a href="http://www.science.uva.nl/research/air/wiki/CategorySysAdmin" title="">CategorySysAdmin</a><br />
<a href="http://www.science.uva.nl/research/air/wiki/CategoryProcedures" title="">CategoryProcedures</a></div>				<div class="commentsheader">
				<p>There are 3 comments on this page. 				[<a href="http://www.science.uva.nl/research/air/wiki/LogicalInterfaceNames?show_comments=1#comments">Display comments</a>]</p>
				</div>
				
<div class="footer">
<form action="http://www.science.uva.nl/research/air/wiki/TextSearch" method="get">
<a href="EditAPage">Edit</a> ::
<a href="http://www.science.uva.nl/research/air/wiki/LogicalInterfaceNames/history" title="Click to view recent edits to this page">Page History</a> ::
<a href="http://www.science.uva.nl/research/air/wiki/LogicalInterfaceNames/revisions" title="Click to view recent revisions list for this page">2008-03-16 15:14:17</a> <a href="http://www.science.uva.nl/research/air/wiki/LogicalInterfaceNames/revisions.xml" title="Click to view recent page revisions in XML format."><img src="images/xml.png" width="36" height="14" align="middle" style="border : 0px;" alt="XML" /></a> ::
Owner: <a href="http://www.science.uva.nl/research/air/wiki/FreekDijkstra" title="">FreekDijkstra</a> ::
 
Search: <input name="phrase" size="15" class="searchbox" />
</form>
</div>

<div class="smallprint">
<a class="ext" href="http://validator.w3.org/check/referer">Valid XHTML 1.0 Transitional</a><span class='exttail'>&#8734;</span> ::
<a class="ext" href="http://jigsaw.w3.org/css-validator/check/referer">Valid CSS</a><span class='exttail'>&#8734;</span> ::
Powered by <a class="ext" href="http://wikka.jsnx.com/">Wikka Wakka Wiki 1.1.6.0</a><span class='exttail'>&#8734;</span></div>

<div class="smallprint">Page was generated in 0.0428 seconds</div>

- lock this page
- enter new password
- reenter same password

Send e-mail alerts to these addresses upon next save: