Simplify Multiple MAC addresses with additional selectable column for tables in list view and detail view

Author: bctiemann

netbox/dcim/models/device_components.py

@@ -732,25 +732,6 @@ def mac_address(self):
         if self.primary_mac_address:
             return self.primary_mac_address.mac_address
 
-    @property
-    def mac_address_display(self):
-        """
-        Rich representation of MAC addresses for use in table columns (e.g. InterfaceTable).
-        Handles various configurations of MAC addresses for an interface:
-        11:22:33:44:55:66      <-- Single MAC address on interface, assigned as primary
-        11:22:33:44:55:66 (2)  <-- Multiple MAC addresses on interface, one assigned as primary
-        2 available            <-- 1 or more MAC addresses on interface, none assigned as primary
-        -                      <-- No MAC addresses on interface
-        """
-        available_mac_count = self.mac_addresses.count()
-        if self.primary_mac_address:
-            if available_mac_count > 1:
-                return f"{self.primary_mac_address} ({available_mac_count})"
-            return self.primary_mac_address
-        if available_mac_count:
-            return f"{available_mac_count} available"
-        return None
-
 
 class Interface(
     InterfaceValidationMixin,

netbox/dcim/tables/devices.py

@@ -583,6 +583,15 @@ class BaseInterfaceTable(NetBoxTable):
         orderable=False,
         verbose_name=_('IP Addresses')
     )
+    primary_mac_address = tables.Column(
+        verbose_name=_('MAC Address'),
+        linkify=True
+    )
+    mac_addresses = tables.TemplateColumn(
+        template_code=INTERFACE_MACADDRESSES,
+        orderable=False,
+        verbose_name=_('MAC Addresses')
+    )
     fhrp_groups = tables.TemplateColumn(
         accessor=Accessor('fhrp_group_assignments'),
         template_code=INTERFACE_FHRPGROUPS,
@@ -614,11 +623,6 @@ class BaseInterfaceTable(NetBoxTable):
         verbose_name=_('Q-in-Q SVLAN'),
         linkify=True
     )
-    primary_mac_address = tables.Column(
-        verbose_name=_('MAC Address'),
-        accessor=Accessor('mac_address_display'),
-        linkify=True
-    )
 
     def value_ip_addresses(self, value):
         return ",".join([str(obj.address) for obj in value.all()])
@@ -681,11 +685,12 @@ class Meta(DeviceComponentTable.Meta):
         model = models.Interface
         fields = (
             'pk', 'id', 'name', 'device', 'module_bay', 'module', 'label', 'enabled', 'type', 'mgmt_only', 'mtu',
-            'speed', 'speed_formatted', 'duplex', 'mode', 'primary_mac_address', 'wwn', 'poe_mode', 'poe_type',
-            'rf_role', 'rf_channel', 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'description',
-            'mark_connected', 'cable', 'cable_color', 'wireless_link', 'wireless_lans', 'link_peer', 'connection',
-            'tags', 'vdcs', 'vrf', 'l2vpn', 'tunnel', 'ip_addresses', 'fhrp_groups', 'untagged_vlan', 'tagged_vlans',
-            'qinq_svlan', 'inventory_items', 'created', 'last_updated', 'vlan_translation_policy'
+            'speed', 'speed_formatted', 'duplex', 'mode', 'mac_addresses', 'primary_mac_address', 'wwn',
+            'poe_mode', 'poe_type', 'rf_role', 'rf_channel', 'rf_channel_frequency', 'rf_channel_width', 'tx_power',
+            'description', 'mark_connected', 'cable', 'cable_color', 'wireless_link', 'wireless_lans', 'link_peer',
+            'connection', 'tags', 'vdcs', 'vrf', 'l2vpn', 'tunnel', 'ip_addresses', 'fhrp_groups',
+            'untagged_vlan', 'tagged_vlans', 'qinq_svlan', 'inventory_items', 'created', 'last_updated',
+            'vlan_translation_policy',
         )
         default_columns = ('pk', 'name', 'device', 'label', 'enabled', 'type', 'description')
 
@@ -719,10 +724,11 @@ class Meta(DeviceComponentTable.Meta):
         model = models.Interface
         fields = (
             'pk', 'id', 'name', 'module_bay', 'module', 'label', 'enabled', 'type', 'parent', 'bridge', 'lag',
-            'mgmt_only', 'mtu', 'mode', 'primary_mac_address', 'wwn', 'rf_role', 'rf_channel', 'rf_channel_frequency',
-            'rf_channel_width', 'tx_power', 'description', 'mark_connected', 'cable', 'cable_color', 'wireless_link',
-            'wireless_lans', 'link_peer', 'connection', 'tags', 'vdcs', 'vrf', 'l2vpn', 'tunnel', 'ip_addresses',
-            'fhrp_groups', 'untagged_vlan', 'tagged_vlans', 'qinq_svlan', 'actions',
+            'mgmt_only', 'mtu', 'mode', 'mac_addresses', 'primary_mac_address', 'wwn', 'rf_role', 'rf_channel',
+            'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'description', 'mark_connected', 'cable',
+            'cable_color', 'wireless_link', 'wireless_lans', 'link_peer', 'connection', 'tags', 'vdcs', 'vrf',
+            'l2vpn', 'tunnel', 'ip_addresses', 'fhrp_groups', 'untagged_vlan', 'tagged_vlans', 'qinq_svlan',
+            'actions',
         )
         default_columns = (
             'pk', 'name', 'label', 'enabled', 'type', 'parent', 'lag', 'mtu', 'mode', 'description', 'ip_addresses',
@@ -1172,4 +1178,6 @@ class Meta(PrimaryModelTable.Meta):
             'pk', 'id', 'mac_address', 'assigned_object_parent', 'assigned_object', 'description', 'is_primary',
             'comments', 'tags', 'created', 'last_updated',
         )
-        default_columns = ('pk', 'mac_address', 'assigned_object_parent', 'assigned_object', 'description')
+        default_columns = (
+            'pk', 'mac_address', 'is_primary', 'assigned_object_parent', 'assigned_object', 'description',
+        )

netbox/dcim/tables/template_code.py

@@ -62,6 +62,16 @@
   {% endif %}
 """
 
+INTERFACE_MACADDRESSES = """
+  {% if value.count > 3 %}
+    <a href="{% url 'ipam:macaddress_list' %}?{{ record|meta:"model_name" }}_id={{ record.pk }}">{{ value.count }}</a>
+  {% else %}
+    {% for mac in value.all %}
+      <a href="{{ mac.get_absolute_url }}">{{ mac }}</a>
+    {% endfor %}
+  {% endif %}
+"""
+
 INTERFACE_FHRPGROUPS = """
   {% for assignment in value.all %}
     <a href="{{ assignment.group.get_absolute_url }}">{{ assignment.group }}</a>

netbox/templates/dcim/interface.html

@@ -143,11 +143,9 @@ <h2 class="card-header">{% trans "Addressing" %}</h2>
           <tr>
             <th scope="row">{% trans "MAC Address" %}</th>
             <td>
-              {% if object.mac_address_display %}
-                <span class="font-monospace">{{ object.mac_address_display|linkify }}</span>
-                {% if object.primary_mac_address %}
-                  <span class="badge text-bg-primary">{% trans "Primary" %}</span>
-                {% endif %}
+              {% if object.primary_mac_address %}
+                <span class="font-monospace">{{ object.primary_mac_address|linkify }}</span>
+                <span class="badge text-bg-primary">{% trans "Primary" %}</span>
               {% else %}
                 {{ ''|placeholder }}
               {% endif %}

netbox/templates/virtualization/vminterface.html

@@ -78,11 +78,9 @@ <h2 class="card-header">{% trans "Addressing" %}</h2>
         <tr>
           <th scope="row">{% trans "MAC Address" %}</th>
           <td>
-            {% if object.mac_address_display %}
-              <span class="font-monospace">{{ object.mac_address_display|linkify }}</span>
-              {% if object.primary_mac_address %}
-                <span class="badge text-bg-primary">{% trans "Primary" %}</span>
-              {% endif %}
+            {% if object.primary_mac_address %}
+              <span class="font-monospace">{{ object.primary_mac_address|linkify }}</span>
+              <span class="badge text-bg-primary">{% trans "Primary" %}</span>
             {% else %}
               {{ ''|placeholder }}
             {% endif %}