Custom Link to Custom Script

[wz4]

I'm trying to figure out a way to create a custom link to a custom script in a programmatic way. Something like this.

{{ baseurl }}/extras/scripts/{{ script_id }}

It looks like only the reference object is available, so this may not be possible. Any help is appreciated.

[wz4]

I figured out that the base url can be derived from {{ object.base_url }}. I believe the script ID will still need to be set statically.

[rfdrake]

You don't need to specify the base (probably, might depend on the proxy in front of netbox). You can just use the URL fragment like this as the URL:

/extras/scripts/3/?device={{ object.id }}

As for the script ID needing to be set statically, it appears this is the case. In the API they mention referring to the script by name (https://netboxlabs.com/docs/netbox/en/stable/customization/custom-scripts/#via-the-api) which uses filename_without_dotpy.ClassNameFromScript as the identifier. But I tried that with the web GUI and this doesn't work.

Hopefully your scripts don't move around too much so you can use whatever the ID number is as a permanent reference. It does make it harder if you want to setup the same scripts and custom links in multiple environments though. This might be something to request as a feature in the future.

[ross-cello]

I've actually been going through that now. Since I store custom link templates in GH, I've gone through and done this

---
# Updated: 2025-02-26
# Dependencies: device_rq
weight: '102'
name: 'Device_DeviceRQ2Received'
object_types: 'dcim.device'
group_name: 'Device RQ'
button_class: 'yellow'
new_window: 'False'
enabled: 'True'
link_text: |
  {#- Scripts: device_rq | Updated: 2025-02-20 #}
  2 - Device Received
link_url: |
  {%- set script_id = 0 %}
  {%- set script_name = 'device_rq/DeviceRQReceived' %}
  {%- set script_path = script_name %}
  /extras/scripts/{{ script_path }}/?device={{ object.id }}

I have a supplemental function(s) I run in nbshell that retrieves all the script ID' and just updates the defined custom link objects in NetBox, when it matches a pattern.

Something like this. Note that I had to modify it a bit to simplify since my functions were doing other things. So this version is not tested.

def script_update_customlinks() -> None:
    for s in Script.objects.all():
        id = s.id
        mpath = s.module.path  # e.g. 'connectionchecks'
        name = s.name          # e.g. 'deviceValidationChecks'
        url_by_id = f"/extras/scripts/{id}"
        url_by_nameslash = f"/extras/scripts/{mpath}/{name}"
        url_by_namedot = f"/extras/scripts/{mpath}.{name}"
        custom_links = CustomLink.objects.filter(link_url__contains=url_by_nameslash)
        if not custom_links.exists():
            continue
        for cl in custom_links:
            cl.snapshot()
            cl.link_url = cl.link_url.replace(url_by_nameslash, url_by_id)
            cl.full_clean()
            cl.save()