Site(tags) are not created when creating a Site using NetBox scripts function #3508

New Issue

adam · 2025-12-29T18:29:34+01:00

adam commented

2025-12-29 18:29:34 +01:00

Originally created by @ryanmerolle on GitHub (Mar 26, 2020).

Environment

Python version: 3.6.8
NetBox version: 2.7.10

Steps to Reproduce

Using the below script in the scripts directory for netbox & entering a new site name, creates the site, but without tags.

from django.utils.text import slugify
from dcim.models import Site
from extras.scripts import *

class NewColoScript(Script):

    class Meta:
        name = "New Colo"
        description = "Provision a new colo site"
        field_order = ['site_name']

    site_name = StringVar(
        label="Site Name",
        description="Site Code Per the Colo Provider",
        required=True
    )

    def run(self, data, commit):

        # Create the new site
        site = Site(
            name=data['site_name'].upper(),
            slug=slugify(data['site_name']),
            tags=["colo", "test"]
        )
        site.save()
        self.log_success("Created new site: {}".format(site))

I have even tried by pre-creating the tags and referencing the name(s) as well as referencing the tag id.

Expected Behavior

Create the site and populate tags.

Observed Behavior

Create the site without tags.

Originally created by @ryanmerolle on GitHub (Mar 26, 2020). ### Environment * Python version: 3.6.8 * NetBox version: 2.7.10 ### Steps to Reproduce Using the below script in the scripts directory for netbox & entering a new site name, creates the site, but without tags. ```python from django.utils.text import slugify from dcim.models import Site from extras.scripts import * class NewColoScript(Script): class Meta: name = "New Colo" description = "Provision a new colo site" field_order = ['site_name'] site_name = StringVar( label="Site Name", description="Site Code Per the Colo Provider", required=True ) def run(self, data, commit): # Create the new site site = Site( name=data['site_name'].upper(), slug=slugify(data['site_name']), tags=["colo", "test"] ) site.save() self.log_success("Created new site: {}".format(site)) ``` I have even tried by pre-creating the tags and referencing the name(s) as well as referencing the tag id. ### Expected Behavior Create the site and populate tags. ### Observed Behavior Create the site without tags.

adam closed this issue

2025-12-29 18:29:34 +01:00

adam commented

2025-12-29 18:29:34 +01:00

@jeremystretch commented on GitHub (Mar 26, 2020):

Please see the django-taggit documentation for direction on assigning tags to objects in Python. The native mechanism works differently than the REST API.

@jeremystretch commented on GitHub (Mar 26, 2020): Please see the [django-taggit documentation](https://github.com/jazzband/django-taggit) for direction on assigning tags to objects in Python. The native mechanism works differently than the REST API.

adam commented

2025-12-29 18:29:34 +01:00

@ryanmerolle commented on GitHub (Mar 26, 2020):

Thanks @jeremystretch apologies for bothering you on this, but it was not clear from the docs.

I will submit a PR to add this to the scripts section of the docs.

For anyone who stumbles upon this the fix is by implementing:

from django.utils.text import slugify
from dcim.models import Site
from extras.scripts import *

class NewColoScript(Script):

    class Meta:
        name = "New Colo"
        description = "Provision a new colo site"
        field_order = ['site_name']

    site_name = StringVar(
        label="Site Name",
        description="Site Code Per the Colo Provider",
        required=True
    )

    def run(self, data, commit):

        # Create the new site
        site = Site(
            name=data['site_name'].upper(),
            slug=slugify(data['site_name'])
            # Removed tags line
        )
        site.save()
        site.tags.add("colo", "test") # taggit add set here, after the site is saved, because a primary key needs to be set for the site before tags can be added.
        self.log_success("Created new site: {}".format(site))

@ryanmerolle commented on GitHub (Mar 26, 2020): Thanks @jeremystretch apologies for bothering you on this, but it was not clear from the docs. I will submit a PR to add this to the scripts section of the docs. For anyone who stumbles upon this the fix is by implementing: ```python from django.utils.text import slugify from dcim.models import Site from extras.scripts import * class NewColoScript(Script): class Meta: name = "New Colo" description = "Provision a new colo site" field_order = ['site_name'] site_name = StringVar( label="Site Name", description="Site Code Per the Colo Provider", required=True ) def run(self, data, commit): # Create the new site site = Site( name=data['site_name'].upper(), slug=slugify(data['site_name']) # Removed tags line ) site.save() site.tags.add("colo", "test") # taggit add set here, after the site is saved, because a primary key needs to be set for the site before tags can be added. self.log_success("Created new site: {}".format(site)) ```

adam commented

2025-12-29 18:29:35 +01:00

@jeremystretch commented on GitHub (Mar 26, 2020):

This is out of scope for the documentation on custom scripts, which deals only with the creation of a script itself. Script authors are responsible for researching and implementing all logic within the run() method.

@jeremystretch commented on GitHub (Mar 26, 2020): This is out of scope for the documentation on custom scripts, which deals only with the creation of a script itself. Script authors are responsible for researching and implementing all logic within the `run()` method.

adam referenced this issue

2025-12-29 22:22:22 +01:00

[PR #3508] [MERGED] Adding a reference to deploying NetBox via Kubernetes manifests #12568

Sign in to join this conversation.

Branches Tags

main

21050-device-oob-ip-may-become-orphaned

21102-fix-graphiql-explorer

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#3508