InterfaceModeChoices.MODE_TAGGED not working in 4.0.5

[balpoint]

Deployment Type

Self-hosted

NetBox Version

v4.0.5

Python Version

3.10

Steps to Reproduce

Hi i have a script within Netbox and one of the things i do with the script is let my team fill out a form to configure specific interface parameters. One of these paramaters is interface mode, i do that as followed (cutdown version for lenght and clarity purposes):

class editMode(Script):
    class Meta:
        name = "Edit Mode "
        description = "Change interface mode"
        commit_default = False
        field_order = ['mode']
    mode = ChoiceVar (
        required = False,
        choices=[(InterfaceModeChoices.MODE_ACCESS, "Access"), (InterfaceModeChoices.MODE_TAGGED, "Tagged")]
    )
    interface = ObjectVar(
        model = Interface,
        required = True
    )
    def run(self, data, commit):
        interface = data['interface']
        mode = data['mode']
        mode_changed = False
        if 'mode' in data and mode in [InterfaceModeChoices.MODE_ACCESS, InterfaceModeChoices.MODE_TAGGED]:
            mode_changed = True
            interface.mode = mode
        interface.save()
        if mode_changed:
            self.log_success(f"The mode of interface {interfacce.name} has been changed to {mode}.")

Downgrading Netbox from 4.0.5 to 4.0.2 and everything works as it always has, cannot find any change related to this behavior.

Expected Behavior

The expected behavior is that 802.1Q Mode for the selected interface changes to tagged, for access this works fine.

Observed Behavior

The observed behavior is that whenever tagged is selected the script completes succesful but no change is made on the selected interface. No errors, even in debug mode there is no indication that anything is wrong, it simply does not do anything.

Downgrading Netbox from 4.0.5 to 4.0.2 and everything works as it always has, cannot find any change related to this behavior.

[DanSheps]

This is not a bug, there is nothing wrong with the Interface.mode setting in the UI, API or python API. This appears to be a problem with your script. As such, I have converted this to a discussion.

[balpoint]

But this is just the thing i am probably missing because i don't see any changes in the changelog regarding the use/workings of this setting. Also there is no error just that i see the changes going trough script logging wise but resulting in a empty interface config.

I've pasted the full script for people to look.

It works in version 4.0.2 and 4.0.3 but breaks without any obvious warnings or changes in version 4.0.5

from django.utils.text import slugify
from django.contrib.contenttypes.models import ContentType
from extras.scripts import *
from dcim.choices import DeviceStatusChoices, SiteStatusChoices, DeviceFaceChoices, InterfaceModeChoices
from dcim.models import *
from ipam.models import *
from vpn.models import *
from vpn.choices import *
from ipam.choices import *
from extras.models import Tag, ConfigContext
from tenancy.models import *

class ChangeVlan(Script):
    class Meta:
        name = "Add / change interface VLAN(s)"
        description = "Add / change interface VLAN's"
        commit_default = False
        field_order = ['site', 'device', 'interface']

    site = ObjectVar(
        model = Site,
        required = True
    )
    device = ObjectVar(
        model = Device,
        query_params={
            'site_id': '$site',
            'role': 'leaf'
        },
        required = True

    )
    interface = ObjectVar(
        model = Interface,
        query_params={
            'device_id': '$device'
        },
        required = True
    )
    mode = ChoiceVar (
        choices=InterfaceModeChoices.CHOICES
    )
    vlan = MultiObjectVar(
        model = VLAN,
        required = True,
        query_params={
            'site_id': '$site'
        },
        description = "<br>WARNING:</b> VLANS will be replaced with the ones selected here !<br />If your vlan is not in the list please create it first <a href=\"https://netbox.triplinq.net/extras/scripts/vlan.AddVLAN/\">here</a><br /><br />"
    )

    description = StringVar (
        label = "Please fill in a description for this interface",
        required = False
    )
    # function to remove unneeded IRBs (runs at the end of every change)
    def removeIRB(self, device):
        vlans = []
        deleted_objects = []
        interfaces = Interface.objects.filter(device=device)
        for iface in interfaces:
            if "irb" not in iface.name:
                if iface.tagged_vlans != []:
                    for vlan in iface.tagged_vlans.all():
                        vlans.append(vlan.vid)
                if iface.untagged_vlan != None:
                    vlans.append(iface.untagged_vlan.vid)
        for iface in interfaces:
            if "irb" in iface.name:
                if int(iface.name.split('.')[1]) not in vlans:
                    deleted_objects.append(iface.name)
                    iface.delete()
                    self.log_success(f"deleted_objects {deleted_objects}")
        return deleted_objects


    def run(self, data, commit):
        access_int = data['interface']
        if access_int.type == "lag":
            for tag in access_int.tags.all():
                if "esi" in tag.slug:
                    interfaces = Interface.objects.filter(tags=tag, type="lag")
            if "interfaces" not in locals():
                interfaces = [access_int]
        else:
            interfaces = [access_int]
        for access_int in interfaces:
            access_int.mode = data['mode']
            access_int.mtu = 9216
            if data['description'] != "":
                access_int.description = data['description']
            if data['mode'] == InterfaceModeChoices.MODE_TAGGED:
                access_int.tagged_vlans.set(data['vlan'])
                self.log_success(f"Vlan's {list(data['vlan'])} have been assigned to interface {access_int.name} on {access_int.device}")
            else:
                access_int.untagged_vlan = data['vlan'][0]
                self.log_success(f"{data['vlan'][0]} have been assigned to interface {access_int.name} on {access_int.device}")
            access_int.enabled = True
            access_int.save()

            layer3 = []
            for vlan in data['vlan']:
                if vlan.custom_field_data['LAYER3'] == True:
                    layer3.append(vlan)
            for l3 in layer3:
                irb_name = "irb" + "." + str(l3.vid)
                irb_prefixes = Prefix.objects.filter(vlan_id=l3.id)
                for prefix in irb_prefixes:
                    prefix_ip = prefix.get_child_ips()
                    try:
                        if Interface.objects.get(device=access_int.device, name=irb_name):
                            self.log_info(f"Layer 3 interface {irb_name} already exists on {access_int.device}")
                            irb_interface = Interface.objects.get(device=access_int.device, name=irb_name)
                    except:
                        self.log_info(f"Layer 3 interface {irb_name} will be added on {access_int.device}")
                        irb_interface = Interface (
                            name = irb_name,
                            device = access_int.device,
                            type = "virtual",
                            mode = InterfaceModeChoices.MODE_ACCESS,
                            untagged_vlan = l3,
                            vrf=prefix.vrf,
                        )
                        irb_interface.save()
                        if "ACL" in l3.custom_field_data:
                            irb_interface.custom_field_data["ACL"] = l3.custom_field_data["ACL"]
                            irb_interface.save()
                        self.log_success(f"Created new IRB interface: {irb_name} on {access_int.device}")
                    interface_ips = []
                    for interface_ip in IPAddress.objects.filter(assigned_object_id=irb_interface.id):
                        interface_ips.append(interface_ip.address)

                    for ip in prefix_ip:
                        if ip.role == "anycast" and ip.status == "reserved" and ip.address not in interface_ips:
                            irb_ip = IPAddress(
                                address = ip.address,
                                assigned_object = Interface.objects.get(device=access_int.device, name=irb_name),
                                role=IPAddressRoleChoices.ROLE_ANYCAST,
                                vrf=prefix.vrf
                            )
                            irb_ip.save()
                            self.log_success(f"Created new IP address ({ip.address}) for {irb_name} on {access_int.device}")
                        
            # run IRB cleanup
            self.removeIRB(access_int.device)