Error using script netbox.

[lasag-2511]

Hi all,

I have the below when i try to load the script (https://github.com/nwiecz/Netbox-ipscanner/blob/master/netbox_ipscanner.py) on the netbox. could you please assist.
Script file at: /opt/netbox/netbox/scripts/ipscanner.py could not be loaded.

I tried copying the below on the top of the script but still no luck

#!/opt/netbox/venv/bin/python
import django, os, sys
sys.path.append('/opt/netbox/netbox')
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'netbox.settings')
django.setup()

[candlerb]

Script file at: /opt/netbox/netbox/scripts/ipscanner.py could not be loaded.

That presumably is an error shown from within the Netbox GUI. It means there is an error in the script (e.g. a syntax error or inability to load a library). Unfortunately, it doesn't say what the error is. This makes debugging such scripts awkward, which is an issue already raised in #12766.

Now, if you add the extra lines at the top of the script as you showed, it won't make any difference in the GUI, but it should let you run the script from the command line to see the error. Therefore, you now need to type this in the Linux shell:

/opt/netbox/venv/bin/python /opt/netbox/netbox/scripts/ipscanner.py

Hopefully you will get a more useful error message back.

Note that Netbox Custom Scripts cannot normally be run like this: they only define classes, and they don't actually execute anything, so if this were a valid script it would just terminate silently. But running it this way will show if there's an error while those classes are being defined.

[candlerb]

Something is broken with your system, because the error you show occurs when running django.setup() (line 5 of the script), which reads netbox.settings, which tries to import extras.plugins, which should be available under /opt/netbox/netbox, but apparently isn't. (You should have a file /opt/netbox/netbox/extras/plugins/__init__.py)

You should be able to make it work with just those 5 lines by themselves. Here's what happens on my system:

root@netbox3:~# cat /tmp/foo.py
#!/opt/netbox/venv/bin/python
import django, os, sys
sys.path.append('/opt/netbox/netbox')
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'netbox.settings')
django.setup()
root@netbox3:~# /opt/netbox/venv/bin/python /tmp/foo.py
root@netbox3:~#

All good, no errors. What happens if you try this on yours?

Check that echo ${DJANGO_SETTINGS_MODULE:-unset} shows "unset".

Do you have any plugins installed? If so, try disabling them (comment them out from the PLUGINS setting in configuration.py)

I do notice this in your backtrace:

 File "/usr/lib/python3.8/importlib/__init__.py", line 127, in import_module

This shows that importlib is being fetched from outside your virtualenv, but I do have that file on my system and it's not causing a problem:

root@netbox3:~# dpkg-query -S /usr/lib/python3.8/importlib/__init__.py
libpython3.8-minimal:amd64: /usr/lib/python3.8/importlib/__init__.py

The only other thing I can think of is that you have a partial install of Netbox, or a mixture of different Netbox versions installed simultaneously (e.g. you upgraded from one version to another by untarring the new release on top of the old one, which is not permitted). In that case, backing up your database and making a completely clean install would be the way to solve it.

[lasag-2511]

Thank you very much for the reply.

I did check the path /opt/netbox/netbox/extras/plugins/ --> there is a file

-rw-r--r-- 1 root root 5547 May 24 13:32 __init__.py

echo ${DJANGO_SETTINGS_MODULE:-unset} --> this shows unset

dpkg-query as below same i see

libpython3.8-minimal:amd64: /usr/lib/python3.8/importlib/__init__.py 

I have a problem here..

Traceback (most recent call last):
  File "/tmp/foo.py", line 5, in <module>
    django.setup()
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/__init__.py", line 19, in setup
    configure_logging(settings.LOGGING_CONFIG, settings.LOGGING)
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/conf/__init__.py", line 92, in __getattr__
    self._setup(name)
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/conf/__init__.py", line 79, in _setup
    self._wrapped = Settings(settings_module)
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/conf/__init__.py", line 190, in __init__
    mod = importlib.import_module(self.SETTINGS_MODULE)
  File "/usr/lib/python3.8/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1014, in _gcd_import
  File "<frozen importlib._bootstrap>", line 991, in _find_and_load
  File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 671, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 848, in exec_module
  File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
  File "/opt/netbox/netbox/netbox/settings.py", line 17, in <module>
    from extras.plugins import PluginConfig
ModuleNotFoundError: No module named 'extras.plugins' 

I did upgrade recently using git clone and i didnot see any issues during upgradation.
I think re -installation is little difficult, is there any other way to fix this.. what if i do one more upgrade to 3.6.0 ? i have one netbox test sytsem how can i import all the configurations from old to new one. if its working then i can think of doing fresh installation.

[candlerb]

how can i import all the configurations from old to new one

https://docs.netbox.dev/en/stable/administration/replicating-netbox/

[lasag-2511]

changed from from extras.scripts import Script to
from extras.scripts import *

[candlerb]

@candlerb I have the below with the new netbox versions . can you please assist
Traceback (most recent call last):
File "/opt/netbox/netbox/scripts/netbox_ipscanner_tag.py", line 14, in
class IpScan(Script):
File "/opt/netbox/netbox/scripts/netbox_ipscanner_tag.py", line 16, in IpScan
TagBasedScanning = BooleanVar(
NameError: name 'BooleanVar' is not defined

Sigh. This means simply that you didn't import BooleanVar, e.g. from extras.scripts import BooleanVar

If you're writing your own Python code, you'll need to start debugging these errors yourself. There's also a repository of sample custom scripts and reports here that you can refer to.

If you've found this problem with some third-party Python code, then please raise it with the author of that code.