Display IP role labels in interfaces table

[candlerb]

NetBox version

v2.11.10

Feature type

Change to existing functionality

Proposed functionality

When listing interfaces under a device, each interface can have multiple IP addresses. If the IP address has a "role" defined, I would like to see its role label displayed next to it.

Example: a particular interface on this device has a regular address 192.168.4.2/24 and a CARP address 192.168.4.1/24. Both are currently shown as the same:

I would like to see the label next to the .1 address.

(Arguably it would be useful to show IP address Status flags too, apart from Active - IMO that would just clutter the display)

Use case

When you see an interface with multiple IPs, you can immediately tell which is the fixed IP and which is the floating VIP.

Database changes

None

External dependencies

None

[thatmattlove]

What would you think about a tooltip instead of displaying a badge? Within a tooltip, we could easily display multiple pieces of information about the related object without having to sacrifice horizontal screen real estate.

[candlerb]

I would still like the special addresses to be visually distinct, without having to hover over them.

How about: colourize the address and have a tooltip? For example, if the IP address is CARP, then show it as white on a green background (like the "CARP" label is); the tooltip shows that the role is CARP.

Potentially this could also be used to highlight status (!= Active).

If the address has both status != Active and role != None, one of these would have to take precedence in the colourization (although the tooltip can show both). I don't really mind; arguably if an address is Deprecated or Reserved this is most important thing to highlight. In any case, it's unlikely to have status DHCP or SLAAC and have a role associated with it.

[bellwood]

Tooltips aren't particularly mobile friendly so a single label would probably suffice.

@jeremystretch I have a PR to resolve this if you're willing to accept one for this feature request.

Edit: This would actually be a badge-success as 3.0 appears to be using badges over labels

[bluikko]

These labels used to show and were really useful. I guess they were lost when the tables were changed from templates.

[candlerb]

Here is proof-of-concept of labels beside addresses:

I rather like this, although it would be nice to bump the label up a pixel or two.

This patch (to Netbox v2.11.11) implements it, if you want to try it out for yourself:

--- a/netbox/dcim/tables/template_code.py
+++ b/netbox/dcim/tables/template_code.py
@@ -42,7 +42,10 @@ DEVICEBAY_STATUS = """

 INTERFACE_IPADDRESSES = """
 {% for ip in record.ip_addresses.all %}
-    <a href="{{ ip.get_absolute_url }}">{{ ip }}</a><br />
+    <a href="{{ ip.get_absolute_url }}">{{ ip }}</a>
+    {% if ip.status != 'active' %} <span class="label label-{{ ip.get_status_class }}">{{ ip.get_status_display %}</span>{% endif %}
+    {% if ip.role %} <span class="label label-{{ ip.get_role_class }}">{{ ip.get_role_display }}</span>{% endif %}
+    <br />
 {% endfor %}
 """

And here's what happens if the IP address itself is colorized if it has a non-active status or non-null role applied.

It's not great that the font sizes don't match. The label class sets font-size: 75%, but resetting it to 100% is worse:

Anyway, again here's the code for tinkering.

--- a/netbox/dcim/tables/template_code.py
+++ b/netbox/dcim/tables/template_code.py
@@ -42,7 +42,7 @@ DEVICEBAY_STATUS = """

 INTERFACE_IPADDRESSES = """
 {% for ip in record.ip_addresses.all %}
-    <a href="{{ ip.get_absolute_url }}">{{ ip }}</a><br />
+    <a {% if ip.status != 'active' %}class="label label-{{ ip.get_status_class }}"{% elif ip.role %}class="label label-{{ ip.get_role_class }}"{% endif %} href="{{ ip.get_absolute_url }}">{{ ip }}</a><br />
 {% endfor %}
 """

[bluikko]

labels beside addresses

With the caveats on colorizing the address it self (small font / does not line up horizontally with the others; user needs to figure out what the colors mean), IMO the labels beside addresses look the best.

Horizontal screen real estate is precious and needs to be conserved (yay the new collapsible menu in v3!) - I guess adding it in a new column (that can be hidden in the column selection) would be much more work than your simple change? I would prefer to always see the labels but some other people may not need them...

[candlerb]

Adding a new column would not be difficult. But I don't like it, because the labels would not be immediately next to the addresses. When you have multiple addresses on an interface, and some addresses are wider than others, it makes the association between address and label unclear. This is a single table cell, with multiple addresses on multiple lines split by <br>

[thatmattlove]

I took a swing at implementing @candlerb's solution in the beta, while also using tooltips to show the status or role display text. Thoughts?

[candlerb]

There is a problem with this patch: it removes the <br/>, so if you have two addresses on an interface they can display side by side. I see this with an IPv4 and an IPv6 address on the same interface:

[thatmattlove]

This is supposed to mitigate that, and does when the badge classes are applied. I did not, however, test this with multiple IPs without badge classes (i.e. active status with no role). I'll take a look.