Data is not passed when using runscript #10842

New Issue

adam · 2025-12-29T21:36:37+01:00

adam commented

2025-12-29 21:36:37 +01:00

Originally created by @krox2 on GitHub (Mar 4, 2025).

Deployment Type

Self-hosted

NetBox Version

v4.2.4

Python Version

3.12

Steps to Reproduce

create a test custom script

$ cat data_source/test.py 
from extras.scripts import Script

class test(Script):

    def run(self, data, commit):
        print(f"data: {data}")

run the custom script and pass data to it using runscript --data ...

$ ./venv/bin/python3 ./netbox/manage.py runscript -v 3 --data '{"site":1}' test.test

I've reverted the change #18612 to fix it locally

--- netbox/extras/management/commands/runscript.py.org  2025-03-04 13:50:41.594946866 +0000
+++ netbox/extras/management/commands/runscript.py      2025-03-04 14:00:21.957497595 +0000
@@ -91,7 +91,8 @@
             instance=script_obj,
             user=user,
             immediate=True,
-            data=form.cleaned_data,
+            #data=form.cleaned_data, this breaks passing data to the script as from.cleaned_data always returns an empty dict, introduced in netbox 4.2.4
+            data=data,
             request=NetBoxFakeRequest({
                 'META': {},
                 'POST': data,

Expected Behavior

$ ./venv/bin/python3 ./netbox/manage.py runscript -v 3 --data '{"site":1}' test.test
[2025-03-04 14:00:35,804][INFO] - Running script (commit=False)
data: {'site': 1}
[2025-03-04 14:00:35,805][INFO] - Database changes have been reverted automatically.
[2025-03-04 14:00:35,811][INFO] - Script completed in 0 minutes, 0.01 seconds

Observed Behavior

$ ./venv/bin/python3 ./netbox/manage.py runscript -v 3 --data '{"site":1}' test.test
[2025-03-04 13:58:59,889][INFO] - Running script (commit=False)
data: {}
[2025-03-04 13:58:59,890][INFO] - Database changes have been reverted automatically.
[2025-03-04 13:58:59,896][INFO] - Script completed in 0 minutes, 0.01 seconds

Originally created by @krox2 on GitHub (Mar 4, 2025). ### Deployment Type Self-hosted ### NetBox Version v4.2.4 ### Python Version 3.12 ### Steps to Reproduce 1. create a test custom script ``` $ cat data_source/test.py from extras.scripts import Script class test(Script): def run(self, data, commit): print(f"data: {data}") ``` 2. run the custom script and pass data to it using runscript --data ... ``` $ ./venv/bin/python3 ./netbox/manage.py runscript -v 3 --data '{"site":1}' test.test ``` I've reverted the change #18612 to fix it locally ``` --- netbox/extras/management/commands/runscript.py.org 2025-03-04 13:50:41.594946866 +0000 +++ netbox/extras/management/commands/runscript.py 2025-03-04 14:00:21.957497595 +0000 @@ -91,7 +91,8 @@ instance=script_obj, user=user, immediate=True, - data=form.cleaned_data, + #data=form.cleaned_data, this breaks passing data to the script as from.cleaned_data always returns an empty dict, introduced in netbox 4.2.4 + data=data, request=NetBoxFakeRequest({ 'META': {}, 'POST': data, ``` ### Expected Behavior ``` $ ./venv/bin/python3 ./netbox/manage.py runscript -v 3 --data '{"site":1}' test.test [2025-03-04 14:00:35,804][INFO] - Running script (commit=False) data: {'site': 1} [2025-03-04 14:00:35,805][INFO] - Database changes have been reverted automatically. [2025-03-04 14:00:35,811][INFO] - Script completed in 0 minutes, 0.01 seconds ``` ### Observed Behavior ``` $ ./venv/bin/python3 ./netbox/manage.py runscript -v 3 --data '{"site":1}' test.test [2025-03-04 13:58:59,889][INFO] - Running script (commit=False) data: {} [2025-03-04 13:58:59,890][INFO] - Database changes have been reverted automatically. [2025-03-04 13:58:59,896][INFO] - Script completed in 0 minutes, 0.01 seconds ```

adam added the type: bug label 2025-12-29 21:36:37 +01:00

adam closed this issue

2025-12-29 21:36:37 +01:00

adam commented

2025-12-29 21:36:38 +01:00

@arthanson commented on GitHub (Mar 4, 2025):

The change was to access the cleaned data so just the parameters defined in the script are accessible through data, so you will need to define Site as a param in the script as follows:

    site = ObjectVar(
        model=Site,
        required=True,
    )

to access it. The previous behavior, of including all of the passed in data without cleaning it was an oversight.

@arthanson commented on GitHub (Mar 4, 2025): The change was to access the cleaned data so just the parameters defined in the script are accessible through data, so you will need to define Site as a param in the script as follows: ``` site = ObjectVar( model=Site, required=True, ) ``` to access it. The previous behavior, of including all of the passed in data without cleaning it was an oversight.

adam commented

2025-12-29 21:36:38 +01:00

@krox2 commented on GitHub (Mar 4, 2025):

Thanks for the help.
I can't make it work when passing my own string variable I used in my scripts.

@krox2 commented on GitHub (Mar 4, 2025): Thanks for the help. I can't make it work when passing my own string variable I used in my scripts.

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

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#10842