How to add tags to new interface in custom script

[krasotinpa]

Hi!

Please advise me how to add tags to new interface wich I create in custom script?

Should I create interface first and then add tags? Or there is a way do it on Interface object ctreation?

This code works

class CreateInterface(Script):
    # skip...
    def run(self, data, commit):
        # Create new interface
        new_if = Interface(
            device=data['device'],
            name=data['interface_name'],
        )
        new_if.save()

        # Add tags
        for t in data['tags']:
            new_if.tags.add(str(t))
        new_if.save()

[pheus]

Hi there,

The NetBox Customizations repository has some excellent, real-world examples you can follow — in particular, take a look at create_vm.py:
https://github.com/netbox-community/customizations/blob/master/scripts/create_vm.py

For your use-case, you can streamline validation and tagging like this:

class CreateInterface(Script):
    # … other fields, args, etc.

    def run(self, data, commit):
        # Instantiate the interface
        new_if = Interface(
            device=data["device"],
            name=data["interface_name"],
        )

        # Validate all fields before saving
        new_if.full_clean()
        new_if.save()

        # Apply tags in one call
        new_if.tags.set(data["tags"])

A few tips:

• Validation first – always call full_clean() before save() to catch any invalid input early.
• Simplified tagging – tags.set() is slightly cleaner than iterating with add(), and it replaces any existing tags in one step.

Hope that helps

[krasotinpa]

Thank you, @pheus !