Trying to create a L2VPN Termination

[beufanet]

Hello, running netbox 4.2.9 here.

Trying to create a L2VPN Termination for VLAN using Netbox Scripts.

The function is the following one:

    @staticmethod
    def associate_l2vpn_vlan(caller, l2vpn_id, vlan_id):
        MacVRF_L2VPN = L2VPN.objects.get(id=l2vpn_id)
        MacVRF_VLAN = VLAN.objects.get(id=vlan_id)
        caller.log_info(f"Will create L2VPN termination for VLAN [{MacVRF_VLAN}](MacVRF.get_absolute_url()) on L2VPN [{MacVRF_L2VPN}](MacVRF_L2VPN.get_absolute_url())")
        macvrf = L2VPNTermination(
            l2vpn=MacVRF_L2VPN,
            #assigned_object_type='ipam.vlan',
            assigned_object_type=VLAN,
            assigned_object_id=vlan_id,
        )
        macvrf.save()
        caller.log_success(f"Created L2VPN termination for VLAN [{MacVRF_VLAN}](MacVRF.get_absolute_url()) on L2VPN [{MacVRF_L2VPN}](MacVRF_L2VPN.get_absolute_url())")

But when executing the call using :

        vlan_mac_vrf = LocalUtils.associate_l2vpn_vlan(
            self,
            l2vpn_id=data["l2vpn_termination"].id,
            vlan_id=new_vlan.id,
        )

I got the folllowing errors:

• when using 'VLAN' line:

An exception occurred: ValueError: Cannot assign "<class 'ipam.models.vlans.VLAN'>": "L2VPNTermination.assigned_object_type" must be a "ContentType" instance.

Traceback (most recent call last):
  File "/opt/netbox/netbox/extras/jobs.py", line 43, in run_script
    script.output = script.run(data, commit)
                    ^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/netbox/scripts/vlan-changes.py", line 907, in run
    vlan_mac_vrf = LocalUtils.associate_l2vpn_vlan(
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/netbox/scripts/vlan-changes.py", line 757, in associate_l2vpn_vlan
    L2VPNTermination(
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/db/models/base.py", line 543, in __init__
    _setattr(self, field.name, rel_obj)
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/db/models/fields/related_descriptors.py", line 287, in __set__
    raise ValueError(
ValueError: Cannot assign "<class 'ipam.models.vlans.VLAN'>": "L2VPNTermination.assigned_object_type" must be a "ContentType" instance.

• when using the 'ipam.vlan' object_type:

n exception occurred: ValueError: Cannot assign "'ipam.vlan'": "L2VPNTermination.assigned_object_type" must be a "ContentType" instance.

Traceback (most recent call last):
  File "/opt/netbox/netbox/extras/jobs.py", line 43, in run_script
    script.output = script.run(data, commit)
                    ^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/netbox/scripts/vlan-changes.py", line 907, in run
    vlan_mac_vrf = LocalUtils.associate_l2vpn_vlan(
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/netbox/scripts/vlan-changes.py", line 757, in associate_l2vpn_vlan
    L2VPNTermination(
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/db/models/base.py", line 543, in __init__
    _setattr(self, field.name, rel_obj)
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/db/models/fields/related_descriptors.py", line 287, in __set__
    raise ValueError(
ValueError: Cannot assign "'ipam.vlan'": "L2VPNTermination.assigned_object_type" must be a "ContentType" instance.

Anything I missed ?

[pheus]

Hi there,

You're on the right track! When creating an L2VPNTermination, you can manually specify assigned_object_type and assigned_object_id, but it’s cleaner and less error-prone to let NetBox handle that part automatically.

Instead of doing:

macvrf = L2VPNTermination(
    l2vpn=MacVRF_L2VPN,
    assigned_object_type=VLAN,
    assigned_object_id=vlan_id,
)

You can just use the assigned_object parameter directly:

macvrf = L2VPNTermination(
    l2vpn=MacVRF_L2VPN,
    assigned_object=MacVRF_VLAN,
)

This way, NetBox will automatically set the correct ContentType and object ID under the hood.

If for some reason you do need to set the content type manually (not recommended unless necessary), then you’d need:

from django.contrib.contenttypes.models import ContentType

vlan_ct = ContentType.objects.get_for_model(VLAN)

macvrf = L2VPNTermination(
    l2vpn=MacVRF_L2VPN,
    assigned_object_type=vlan_ct.pk,
    assigned_object_id=vlan_id,
)

But again — using assigned_object is the preferred and more Pythonic way.

Hope that clears it up!

[pheus]

Minor note on naming conventions:
You might want to consider updating variable names like MacVRF_L2VPN and MacVRF_VLAN to follow PEP 8 naming conventions. For example, macvrf_l2vpn and macvrf_vlan would be more idiomatic in Python. This makes the code more consistent and easier to read for others in the Python community.

[beufanet]

Thanks, indeed, was stucked because doing Netbox API and Netbox Scripts, so was not able to understand what I did wrong.
Thanks for the answer ;)