Config template - interfaces under tagged VLANs?

[etfz]

Hi,

Looking to generate some VLAN configuration for MikroTik RouterOS. Unfortunately, the configuration required is a little backwards compared to the documentation, where you define a VLAN primarily, and then include relevants interfaces.

For example, if I have VLAN 5 tagged on sfp-sfpplus1, ether2 and ether3, and VLAN 10 tagged on ether2 and ether3, I need to generate the following configuration:

/interface bridge vlan add bridge=bridge vlan-ids=5 tagged=sfp-sfpplus1,ether2,ether3
/interface bridge vlan add bridge=bridge vlan-ids=10 tagged=ether2,ether3

Is there any sane way to accomplish this?

[candlerb]

The templating language jinja2 is quite powerful - it has variables, looping etc.

You'd want to iterate over all interfaces, accumulate the list of VLANs seen; then iterate over each unique VLAN seen and find the interfaces which are a member of it (tagged or untagged). Here is something that comes close:

{%- for i in device.interfaces.all() %}
{%- for v in (i.tagged_vlans.all()|list) + [i.untagged_vlan] %}
{%- if v -%}{# and v not in seen #}
/interface bridge vlan add bridge=bridge vlan-ids={{v.vid}}
{%- set ifs = device.interfaces.filter(tagged_vlans=v)|list %}
{%- if ifs %} tagged={{ ifs|join(",") }}
{%- endif %}
{%- set ifs = device.interfaces.filter(untagged_vlan=v)|list -%}
{%- if ifs %} untagged={{ ifs|join(",") }}
{%- endif %}
{%- endif %}
{%- endfor %}
{%- endfor %}

Unfortunately, when it sees the same vlan multiple times, it repeats the config. Fixing that seems to be tricky, because Netbox doesn't enable the "do" extension, which would allow you to update a list or a dict of vlans already seen. You could raise that as a feature request.

With Jinja2, it's also possible to add your own custom filters in Python, like these which Netbox itself provides - but I don't know if there's a supported way to add your own in Netbox, without writing a complete Plugin.

EDIT: I realised this doesn't handle interface setting "Tagged (all)". That's tricky; I think you'd need to get a list of all VLANs in the site. Actually, that suggests a solution for the first problem, as long as you've assigned each VLAN to the site:

{%- for v in device.site.vlans.all() %}
{%- set ift = device.interfaces.filter(tagged_vlans=v)|list %}
{%- set ifu = device.interfaces.filter(untagged_vlan=v)|list -%}
{%- if ift or ifu %}
/interface bridge vlan add bridge=bridge vlan-ids={{v.vid}}
{%- if ift %} tagged={{ ift|join(",") }}{% endif %}
{%- if ifu %} untagged={{ ifu|join(",") }}{% endif %}
{%- endif %}
{%- endfor %}

It's a bit tricker to add in interfaces with tagged-all. In Python/Django it's easy to combine querysets:

device.interfaces.filter(tagged_vlans=v) | device.interfaces.filter(mode="tagged-all")

But that conflicts with the pipe operator in Jinja2. The following seems to work though:

{%- for v in device.site.vlans.all() %}
{%- set ift = ((device.interfaces.filter(tagged_vlans=v)|list) + (device.interfaces.filter(mode="tagged-all")|list)) | unique | sort(attribute="name") %}
{%- set ifu = device.interfaces.filter(untagged_vlan=v) | sort(attribute="name") -%}
{%- if ift or ifu %}
/interface bridge vlan add bridge=bridge vlan-ids={{v.vid}}
{%- if ift %} tagged={{ ift|join(",") }}{% endif %}
{%- if ifu %} untagged={{ ifu|join(",") }}{% endif %}
{%- endif %}
{%- endfor %}

[candlerb]

Here's an alternative formulation thanks to @v0tti in #12573

{%- for v in device.site.vlans.all() %}
{%- set ift = ((v.interfaces_as_tagged.exclude(type="virtual").filter(device=device)|list)
             + (device.interfaces.filter(mode="tagged-all")|list))|sort(attribute="name") %}
{%- set ifu = v.interfaces_as_untagged.exclude(type="virtual").filter(device=device)|sort(attribute="name") %}
{%- if ift or ifu %}
/interface bridge vlan add bridge=bridge vlan-ids={{v.vid}}
{%- if ift %} tagged={{ ift|join(",") }}{% endif %}
{%- if ifu %} untagged={{ ifu|join(",") }}{% endif %}
{%- endif %}
{%- endfor %}

[dreng]

I'm experimenting with VLANs and config templates too. I started with this simple example:

{% for interface in device.interfaces.all() %}
  Interface ({{ interface.id }}): {{ interface }}
  Untagged VLANs: {{ interface.untagged_vlan }}
  Tagged VLANs: {% for vlan in interface.tagged_vlans.all() %}{{ vlan.vid }} {% endfor %}
{% endfor %}

The problem is that I set one of the interfaces in the test environment to "802.1Q Mode: Tagged (All)". I can't seem to find a way to query the tagged VLANs then. I would expect that list of all VLANs is returned. Instead, interface.tagged_vlans.all() returns an empty list. I even can't query the 802.1Q Mode in order to work around this.

Am I missing something?

[candlerb]

Am I missing something?

"Tagged (All)" is effectively just a status meaning "no list of VLANs provided". In many switches, not configuring a list of VLANs on the port makes it participate in any or all VLANs that are there.

Netbox doesn't return all VLAN objects, because it doesn't know what set of VLANs is available to this particular device or rack or location.

If you want all VLANs in the site, you could use device.site.vlans.all() - assuming each VLAN has been bound directly to a site (i.e. it probably doesn't work if bound to a vlan group, but I haven't tested that). See above and #12573.

I even can't query the 802.1Q Mode in order to work around this

The 802.1Q Mode is an enumerated value: "access", "tagged" or "tagged-all". In nbshell:

>>> Device.objects.get(name="gw2").interfaces.get(name="ether5").mode
'tagged'

[dreng]

Thanks for clarifying! So, this will do the trick:

{% for interface in device.interfaces.all() %}
  Interface ({{ interface.id }}): {{ interface }}
  Untagged VLANs: {{ interface.untagged_vlan.vid }}
  Tagged VLANs: {% if interface.mode == 'tagged-all' %}{% for vlans in device.site.vlans.all() %}{{ vlans.vid }} {% endfor %}{% else %}{% for vlan in interface.tagged_vlans.all() %}{{ vlan.vid }} {% endfor %}{% endif %}
{% endfor %}

This is unfortunately horribly formatted, but otherwise the output looks awful.

[peterbaumert]

Maybe a "jinja templates" section in the device types github would be a good addon where people could share their examples. Or a completly own repo?