Trying to get custom scripts running

[linuxrrze]

Hi,

I'm trying to get the custom scripts (especially NetBox_DNS_Exporter and AXFR_Importer) running.
I'm running netbox 4.3.0 in a docker container, the only extra plugin is netbox_dns (1.3.1).

After importing the above mentioned scripts via web UI and trying to run them all I get is an "Errored" state, no hint what went wrong.

I also tried to run the scripts from command line using

./manage.py runscript NetBox_DNS_Exporter.ZoneExporter

I hope I got the parameters right, I'm not sure about that however ...

All I get when executing it is:

🧬 loaded config '/etc/netbox/config/configuration.py'
🧬 loaded config '/etc/netbox/config/extra.py'
🧬 loaded config '/etc/netbox/config/logging.py'
🧬 loaded config '/etc/netbox/config/plugins.py'
Traceback (most recent call last):
File "/opt/netbox/netbox/./manage.py", line 10, in
execute_from_command_line(sys.argv)
File "/opt/netbox/venv/lib/python3.12/site-packages/django/core/management/init.py", line 442, in execute_from_command_line
utility.execute()
File "/opt/netbox/venv/lib/python3.12/site-packages/django/core/management/init.py", line 436, in execute
self.fetch_command(subcommand).run_from_argv(self.argv)
File "/opt/netbox/venv/lib/python3.12/site-packages/django/core/management/base.py", line 416, in run_from_argv
self.execute(*args, **cmd_options)
File "/opt/netbox/venv/lib/python3.12/site-packages/django/core/management/base.py", line 460, in execute
output = self.handle(*args, **options)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/opt/netbox/netbox/extras/management/commands/runscript.py", line 41, in handle
script_obj = get_module_and_script(module_name, script_name)[1]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/opt/netbox/netbox/extras/scripts.py", line 649, in get_module_and_script
module = ScriptModule.objects.get(file_path=f'{module_name}.py')
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/opt/netbox/venv/lib/python3.12/site-packages/django/db/models/manager.py", line 87, in manager_method
return getattr(self.get_queryset(), name)(*args, **kwargs)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/opt/netbox/venv/lib/python3.12/site-packages/django/db/models/query.py", line 633, in get
raise self.model.DoesNotExist(
extras.models.scripts.ScriptModule.DoesNotExist: ScriptModule matching query does not exist.

I hope it's just something I got wrong, but I currently have no clue what ... any help is highly appreciated!

Marcel

[peteeckel]

Hi @linuxrrze, first a disclaimer: I'm not using Docker, so if there might be any Docker-specific issue I can't help you with that. In my (second-hand) experience Docker creates more problems than it solves.

In this case, however, I see the same problem. The root cause appears to be that manage.py runscript is trying to import the script from extras.models.scripts instead of the configured SCRIPTS_PATH, which smells like a NetBox issue. I can't go into detail right now, but it works from the GUI and not from the command line.

Will look into it later on, unless you find out more.

[linuxrrze]

Hi @peteeckel.

Thanks for looking into it.
If I got you right, at least the manage.py options should be fine.

I had "SCRIPTS_ROOT" (should it be SCRIPTS_PATH"?) set both in /etc/netbox/config/configuration.py and (just to be sure) in /etc/netbox/config/plugins.py (as I found the wrong/missing path as cause for similar errors). Unfortunately the error occured with these changes already applied.

As (in my case, may be docker related) the GUI only gives me "Errored" an nothing else I'd hoped the CLI would be a little more verbose ... which it was, but it didn't help anyway :-/

And yes: docker can be challenging sometimes :-)

[peteeckel]

Hi @linuxrrze, so I don't leave that unanswered, here's a short summary:

1. If you have a working NetBox instance with properly configured SCRIPTS_ROOT, the GUI part is what should always work, and in fact it does if the configuration is correct. See the NetBox issue I created today. It definitely does, both with my example script from the NetBox DNS repo and with my minimal example from the NetBox issue. If that doesn't work, there is a problem with your setup, Docker-related or not. GUI should work, otherwise there's no point in trying CLI.
2. As it turned out, CLI used to work in the documented way in 4.2.9, but no longer does so in 4.3.1 (didn't check 4.3.0). It does so if you add the module path to the invocation of runscript, but that's pretty awkward, to say the least.

And as you said yourself: While the problem itself isn't Docker-related, debugging it under Docker adds at least one dimension of difficulties. From what you wrote above I take it that GUI invocation doesn't work either - and it definitely should do so, even with the NetBox bug.

[linuxrrze]

I did a little more strace-ing, but the only mentioning in the log is something like "NetBox_DNS_Exporter.py" that's send somewhere ...

So as you mentioned that the problem is path related, I gave it a try with its full path (that didn't work either, but at least the error changed):

# ./manage.py runscript /opt/netbox/netbox/scripts/NetBox_DNS_Exporter.ZoneExporter
🧬 loaded config '/etc/netbox/config/configuration.py'
🧬 loaded config '/etc/netbox/config/extra.py'
🧬 loaded config '/etc/netbox/config/logging.py'
🧬 loaded config '/etc/netbox/config/plugins.py'
Traceback (most recent call last):
  File "/opt/netbox/netbox/./manage.py", line 10, in <module>
    execute_from_command_line(sys.argv)
  File "/opt/netbox/venv/lib/python3.12/site-packages/django/core/management/__init__.py", line 442, in execute_from_command_line
    utility.execute()
  File "/opt/netbox/venv/lib/python3.12/site-packages/django/core/management/__init__.py", line 436, in execute
    self.fetch_command(subcommand).run_from_argv(self.argv)
  File "/opt/netbox/venv/lib/python3.12/site-packages/django/core/management/base.py", line 416, in run_from_argv
    self.execute(*args, **cmd_options)
  File "/opt/netbox/venv/lib/python3.12/site-packages/django/core/management/base.py", line 460, in execute
    output = self.handle(*args, **options)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/netbox/extras/management/commands/runscript.py", line 59, in handle
    logger = logging.getLogger(f"netbox.scripts.{script.full_name}")
                                                 ^^^^^^^^^^^^^^^^
AttributeError: 'NoneType' object has no attribute 'full_name'

[linuxrrze]

Ok, that one was on me (I had changed some import statements for testing). After reverting these changes, I can do:

./manage.py runscript /opt/netbox/netbox/scripts/NetBox_DNS_Exporter.ZoneExporter --data '{"export_path": "/export/"}'
🧬 loaded config '/etc/netbox/config/configuration.py'
🧬 loaded config '/etc/netbox/config/extra.py'
🧬 loaded config '/etc/netbox/config/logging.py'
🧬 loaded config '/etc/netbox/config/plugins.py'
[2025-05-17 16:24:35,851][INFO] - Running script (commit=False)
[2025-05-17 16:24:35,864][INFO] - Exporting zones for view 'extern'
[2025-05-17 16:24:35,865][INFO] - Exporting zone [extern] linux-ng.de
[2025-05-17 16:24:35,874][INFO] - Exporting zones for view 'intern'
[2025-05-17 16:24:35,875][INFO] - Exporting zone [intern] _msdcs.linux-ng.de
[2025-05-17 16:24:35,879][INFO] - Exporting zone [intern] 1.168.192.in-addr.arpa
[2025-05-17 16:24:35,882][INFO] - Exporting zone [intern] 2.101.10.in-addr.arpa
[2025-05-17 16:24:35,885][INFO] - Exporting zone [intern] 2.168.192.in-addr.arpa
[2025-05-17 16:24:35,887][INFO] - Database changes have been reverted automatically.
[2025-05-17 16:24:35,890][INFO] - Script completed in 0 minutes, 0.04 seconds

That'll do for now, but I'll check out the GUI version later.

[peteeckel]

I just had a look at the data model, and this

/opt/netbox/netbox/manage.py runscript --loglevel debug /opt/netbox/netbox/scripts/NetBox_DNS_Exporter.ZoneExporter

works. So it's start to smell very strongly of a NetBox bug.

>>> ScriptModule.objects.first().file_path
'/opt/netbox/netbox/scripts/NetBox_DNS_Exporter.py'

(and yes, of course you're right and the path variable in the config is SCRIPTS_ROOT)

That makes

module = ScriptModule.objects.get(file_path=f'{module_name}.py')

work and now the complaint is about missing data.

[peteeckel]

I just opened netbox-community/netbox#19529 for it. It's apparently a NetBox 4.3 bug, as I suspected.

[linuxrrze]

Thank you so much!

[peteeckel]

NetBox PR is on its way: netbox-community/netbox#19568