Creating VLANGroups using Scripts

[fatman00]

Hi

I am trying to create a vlan group and some VLANs using a script in netbox.
But I cannot get the below code to work, and I cannot find anything in the model documentation on it.

# Create VLANs and groups
        new_vlan_group = VLANGroup(
            name=f"{data['site_short'].upper()}-VLAN-Group",
            description=f"Vlan Group for {data['site_name']}'",
            #scope_type="dcim.site",
            scope_id=site.id
        )
        new_vlan_group.save()
        self.log_success(f"Created new VLAN Group: {new_vlan_group}")

I get the below error:

An exception occurred: AttributeError: 'NoneType' object has no attribute '_meta'

Traceback (most recent call last):
  File "/opt/netbox/netbox/extras/scripts.py", line 464, in _run_script
    script.output = script.run(data=data, commit=commit)
  File "/etc/netbox/scripts/NewBranchScript.py", line 110, in run
    new_vlan_group.save()
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/db/models/base.py", line 812, in save
    self.save_base(
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/db/models/base.py", line 878, in save_base
    post_save.send(
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/dispatch/dispatcher.py", line 176, in send
    return [
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/dispatch/dispatcher.py", line 177, in <listcomp>
    (receiver, receiver(signal=self, sender=sender, **named))
  File "/opt/netbox/netbox/extras/signals.py", line 87, in handle_changed_object
    enqueue_object(queue, instance, request.user, request.id, action)
  File "/opt/netbox/netbox/extras/webhooks.py", line 72, in enqueue_object
    'data': serialize_for_webhook(instance),
  File "/opt/netbox/netbox/extras/webhooks.py", line 27, in serialize_for_webhook
    return serializer.data
  File "/opt/netbox/venv/lib/python3.10/site-packages/rest_framework/serializers.py", line 555, in data
    ret = super().data
  File "/opt/netbox/venv/lib/python3.10/site-packages/rest_framework/serializers.py", line 253, in data
    self._data = self.to_representation(self.instance)
  File "/opt/netbox/venv/lib/python3.10/site-packages/rest_framework/serializers.py", line 522, in to_representation
    ret[field.field_name] = field.to_representation(attribute)
  File "/opt/netbox/venv/lib/python3.10/site-packages/rest_framework/fields.py", line 1838, in to_representation
    return method(value)
  File "/opt/netbox/netbox/ipam/api/serializers.py", line 200, in get_scope
    serializer = get_serializer_for_model(obj.scope, prefix=NESTED_SERIALIZER_PREFIX)
  File "/opt/netbox/netbox/utilities/api.py", line 18, in get_serializer_for_model
    app_name, model_name = model._meta.label.split('.')
AttributeError: 'NoneType' object has no attribute '_meta'

It is like the scope_type is needed but dcim.site is not correct, and I cannot find out what I am supposed to put in there instead.

[julianstolp]

I think its waiting for an object, try

new_vlan_group = VLANGroup(
            name=f"{data['site_short'].upper()}-VLAN-Group",
            description=f"Vlan Group for {data['site_name']}'",
            scope=Site.objects.get(pk=site.id)
        )
        new_vlan_group.save()
        self.log_success(f"Created new VLAN Group: {new_vlan_group.name}")

I used trail and error, maybe someone knows why?

[fatman00]

Could you explaine what the pk= does?
I tried the example and it did not give any errors, but the scope was not filled with anything on the VLANGroup anyway.

[candlerb]

Aside:

new_vlan_group.save()

should be changed to:

new_vlan_group.full_clean()
new_vlan_group.save()

It's an easy trap to fall into with Django - but for backwards-compatibility reasons they won't change it now.

[julianstolp]

Aside:

new_vlan_group.save()

should be changed to:

new_vlan_group.full_clean()
new_vlan_group.save()

It's an easy trap to fall into with Django - but for backwards-compatibility reasons they won't change it now.

Thanks @candlerb for the addition. Did not know it. It is also missing in the official documentation example. https://docs.netbox.dev/en/stable/customization/custom-scripts/#example

[candlerb]

Raised as #11689

[julianstolp]

The pk stands for primary key. I used site.id because you used it in your example. This following code works for me. You most likely need to change the site_short.

from extras.scripts import *
from dcim.models import Site
from ipam.models import VLANGroup

class Test(Script):


    class Meta:
        name = 'Test'
        description = 'Test'

    site = ObjectVar(model=Site, required=True)
    site_short = StringVar(description="Short name of the site")

    def run(self, data, commit):
        site = data['site']
        vlangroupname = f"{data['site_short'].upper()}-VLAN-Group"
        new_vlan_group = VLANGroup(
            name = vlangroupname,
            description=f"Vlan Group for {site.name}",
            slug=slugify(vlangroupname),
            scope=site
        )
        new_vlan_group.full_clean()
        new_vlan_group.save()
        self.log_success(f"Created new VLAN Group: {new_vlan_group.name}")
        return