Second custom script does not show in GUI after having deleted first custom script

[jesper-munk2]

I upload and execute Custom script new_site_r10.py in the GUI, everythings work. I then in the GUI delete new_site_r10.py and hereafter attempt to upload a new version of this script new_site_r12.py. The upload succeeds according to message at the bottom right corner, but no custom script is shown in the GUI. When I attempt to upload new_site_r12.py again I get the error message, that this script is already in the Netbox (and as just described, no custom script is shown in the GUI).
I am working a fresh Ubuntu 24.04 VM, 4 vCPU, 4 GB RAM. Nothing but Netbox is installed on this server. I have installed Netbox 4.8.5-docker 4.0.2 docker container according to the guide in https://www.packetswitch.co.uk/how-to-install-netbox-on-docker/. I have 4 device role definitions and nothihg else on the Netbox. I have done the installation of above twice with the same result.
I have uploaded screenshot of the error,

I have attempted to use Github git synchronization, but could not make that work. For now I go with the manual upload of new Custom scripts, and leave the git synchronization for a separate discsssion.

netbox_custom_script_upload_fails_screenshot.pdf

[lucagubler]

That's a bit weird. Usually this just works for me (deleting and uploading a script). Maybe somehow the script is still on the NetBox VM? Can you SSH into that VM and try to find if that script still exists?

Also, please have a look at this docs here: https://netboxlabs.com/blog/getting-started-with-netbox-custom-scripts/

[jesper-munk2]

The script new_site_r12.py is in the container netbox-docker-netbox-1:
netbox@78a869f43c1d:/opt/netbox/netbox/scripts$ pwd
/opt/netbox/netbox/scripts
netbox@78a869f43c1d:/opt/netbox/netbox/scripts$ ls -l
total 4
-rw-rw-r-- 1 netbox root 0 Apr 16 06:19 init.py
-rw-r--r-- 1 netbox root 3503 Apr 28 05:28 new_site_r12.py
netbox@78a869f43c1d:/opt/netbox/netbox/scripts$

I deleted it from that container.

I then checked in container netbox-docker-netbox-worker-1 that the script new_site_r12.py is not there. It is not there.

I then restart the Netbox docker container with docker compose down and docker compose up -d.

I then go into Netbox container netbox-docker-netbox-1 and check if new_site_r12.py is there. It is not. It is also not in container netbox-docker-netbox-worker-1.

I then again on the GUI attempt to upload script new_site_r12.py, and get the same error message:
DETAIL: Key (file_root, file_path)=(scripts, new_site_r12.py) already exists.

This is very strange.

I have read and followed the instructions in https://netboxlabs.com/blog/getting-started-with-netbox-custom-scripts/ and actually my script new_site_r12.py is a copy of the same script there.

The docker containers are:
labadmin@cslab2-netbox:~$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
7a202a022030 netboxcommunity/netbox:v4.5-4.0.2 "/usr/bin/tini -- /o…" 13 hours ago Up 12 hours (healthy) netbox-docker-netbox-worker-1
78a869f43c1d netboxcommunity/netbox:v4.5-4.0.2 "/usr/bin/tini -- /o…" 13 hours ago Up 13 hours (healthy) 0.0.0.0:8000->8080/tcp, [::]:8000->8080/tcp netbox-docker-netbox-1
3d6a88c1fcef postgres:18-alpine "docker-entrypoint.s…" 13 hours ago Up 13 hours (healthy) 5432/tcp netbox-docker-postgres-1
e11ceb85548f valkey/valkey:9.0-alpine "docker-entrypoint.s…" 13 hours ago Up 13 hours (healthy) 6379/tcp netbox-docker-redis-1
9c7c64941222 valkey/valkey:9.0-alpine "docker-entrypoint.s…" 13 hours ago Up 13 hours (healthy) 6379/tcp netbox-docker-redis-cache-1

[jesper-munk2]

Both docker containers netbox-docker-netbox-1 and netbox-docker-netbox-worker-1 say that no custom script exists (besides init.py):
netbox@1217dc93a881:/opt/netbox/netbox/scripts$ ls -l
total 0
-rw-rw-r-- 1 netbox root 0 Apr 16 06:19 init.py
netbox@1217dc93a881:/opt/netbox/netbox/scripts$

netbox@f42ed9e8804c:/opt/netbox/netbox/scripts$ ls -l
total 0
-rw-rw-r-- 1 netbox root 0 Apr 16 06:19 init.py
netbox@f42ed9e8804c:/opt/netbox/netbox/scripts$

I get the same error when I attempt the script upload with CURL:
(netboxvenv) jesper.munk@MCDEN-CQ2L5YGY9Q code % curl -X POST
-H "Authorization: Token $nb_token"
-H "Accept: application/json; indent=4"
-F "file=@new_site_r12.py"
http://172.19.40.57:8000/api/extras/scripts/upload/

[
"A script module with this file name already exists."
]%
(netboxvenv) jesper.munk@MCDEN-CQ2L5YGY9Q code %

[pheus]

Hi,

Sorry you’re running into trouble with the custom script upload.

Based on what you described, this looks very similar to a known issue where a custom script can be registered in the database even though it no longer appears in the UI afterward:

#21737

That issue is currently targeted for v4.5.9, so this behavior should be addressed in that release.

For the affected instance, you will probably need to remove the stale custom script / managed file entry from the database manually before you can upload the corrected script again. Please make sure you have a current database backup before making any manual changes, and only remove the entry that corresponds to the uploaded script.

It may also be worth checking whether the script file still exists in the container or VM storage path used for custom scripts. If it does, removing that stale file after cleaning up the database entry should allow you to upload the script again.

Hope this helps!

[jesper-munk2]

The bug description matches very well what I experience. I think it is this bug, I hit. I will watch for it to be solved in v4.5.9.

Do You have an guess when v4.5.9 will be released?

Do You know if there are older versions, where this bug does not exist, then I may use one of these?

Luckily my Netbox is a lab installation, so I do not have any clean up activities to do. I will install a fresh install of the v4.5.9 (or a previous version without this error) Netbox container.

Thank's for very useful feedback.

[pheus]

NetBox v4.5.9 is expected to be released today. The Docker image usually follows shortly afterward, so it should be available tomorrow.

Without looking into the commit history in more detail, I can’t say for certain when this issue was introduced or which earlier versions are unaffected. Since your NetBox instance is only a lab installation, waiting for v4.5.9 and starting with a fresh container sounds like the safest and simplest approach.

Thanks for confirming the details, and I’m glad the feedback was useful!

[jesper-munk2]

It sounds really good that v4.5.9 is expected to be released today. I assume I can see that in Netbox release notes https://netboxlabs.com/docs/netbox/release-notes/ .
Will I be able to see the version of the docker Netbox in https://github.com/netbox-community/netbox-docker that the Netbox has been upgraded to v4.5.9, or is there some other place I can see it?
As soon as docker Netbox v4.5.9 is available, I will do a fresh install and test and give You feed back.

[pheus]

Yes, that is the right place to look, although there may be a slight delay before the release notes are updated:

https://netboxlabs.com/docs/netbox/release-notes/

If you want to see new NetBox releases as soon as they are published, the GitHub releases page is usually the best place to check:

https://github.com/netbox-community/netbox/releases

As mentioned earlier, netbox-docker is a separate community-maintained project. It checks for new NetBox releases during its nightly run, so the Docker image will usually not be available immediately after the NetBox release itself. In practice, this means the Docker image is typically available the following day.

Also, the netbox-docker containers are published to container registries, so you should not expect to see the NetBox version update under the netbox-docker GitHub releases page:

https://github.com/netbox-community/netbox-docker/releases

For any questions specifically related to netbox-docker, it would be best to use the discussion board in that repository:

https://github.com/netbox-community/netbox-docker/discussions

Thanks again, and I’d be interested to hear whether v4.5.9 resolves the issue for you after your fresh install.

[jesper-munk2]

pheus
For Your information around 16:00 today I was against my expectation able to upload a new custom script with a file name, I had not used before, and run that script. So it seems like something "timed out".
I then deleted it, and attempted upload of a new script with another file name, I had not used before, and now the GUI says the script file was successfully uploaded, but it is not there in the GUI.
I will as said before let You know the result as soon as I have tested with v4.5.9.

[jesper-munk2]

Upgraded to docker netbox 4.5.9. Now I can upload/delete custom script, and I can have two custom scripts active at the same time. So issue solved from my point of view: