Script ignores 'scheduling_enabled' if it has no input parameters #8296

New Issue

adam · 2025-12-29T20:35:01+01:00

adam commented

2025-12-29 20:35:01 +01:00

Originally created by @candlerb on GitHub (Jul 5, 2023).

Originally assigned to: @abhi1693 on GitHub.

NetBox version

v3.5.4

Python version

3.8

Steps to Reproduce

Upload the following script and run it:

from extras.scripts import Script

class TestScript(Script):
    class Meta:
        name = "Test Script"
        scheduling_enabled = False

    def run(self, data, commit):
        self.log_success("Run OK")
        return "OK\n"

Expected Behavior

Since scheduling_enabled is False, Netbox should not offer to run the script at scheduled times.

Observed Behavior

Note however that commit_default = False is honoured if provided.

Originally created by @candlerb on GitHub (Jul 5, 2023). Originally assigned to: @abhi1693 on GitHub. ### NetBox version v3.5.4 ### Python version 3.8 ### Steps to Reproduce Upload the following script and run it: ``` from extras.scripts import Script class TestScript(Script): class Meta: name = "Test Script" scheduling_enabled = False def run(self, data, commit): self.log_success("Run OK") return "OK\n" ``` ### Expected Behavior Since `scheduling_enabled` is False, Netbox should not offer to run the script at scheduled times. ### Observed Behavior ![image](https://github.com/netbox-community/netbox/assets/44789/c10d6eac-aa7e-4e33-8d98-6077fc757972) Note however that `commit_default = False` *is* honoured if provided.

adam added the type: bug status: accepted severity: medium labels 2025-12-29 20:35:01 +01:00

adam closed this issue

2025-12-29 20:35:02 +01:00

adam commented

2025-12-29 20:35:02 +01:00

@kkthxbye-code commented on GitHub (Jul 5, 2023):

Lots of stuff wrong here. To add to the description, it's important to note that if the script has input, the scheduling fields are removed.

The reason they are not getting removed if there is input is because the logic here is wrong:

07ae7c8a6e/netbox/templates/extras/script.html (L18-L38)

The scheduling fields are removed in the get_fieldsets() method, which is only called if form.requires_input is True (L18). If the form doesn't require input the entire form is just rendered.

Now even if that is fixed, the check to prevent scripts from being scheduled is not working either.

The ScriptForm is never passed the scheduling_enabled parameter:

07ae7c8a6e/netbox/extras/scripts.py (L388)

The ScriptForm init method:

07ae7c8a6e/netbox/extras/forms/scripts.py (L37-L47)

Now if the form is fixed and scheduling_enabled is passed to the form, an exception will be thrown here because the previous code pop'ed them already:

07ae7c8a6e/netbox/extras/views.py (L1087)

Open for volunteers.

@kkthxbye-code commented on GitHub (Jul 5, 2023): Lots of stuff wrong here. To add to the description, it's important to note that if the script has input, the scheduling fields are removed. The reason they are not getting removed if there is input is because the logic here is wrong: https://github.com/netbox-community/netbox/blob/07ae7c8a6e04ecc6e641044330fd4d03e4997252/netbox/templates/extras/script.html#L18-L38 The scheduling fields are removed in the get_fieldsets() method, which is only called if `form.requires_input` is True (L18). If the form doesn't require input the entire form is just rendered. Now even if that is fixed, the check to prevent scripts from being scheduled is not working either. The ScriptForm is never passed the `scheduling_enabled` parameter: https://github.com/netbox-community/netbox/blob/07ae7c8a6e04ecc6e641044330fd4d03e4997252/netbox/extras/scripts.py#L388 The ScriptForm init method: https://github.com/netbox-community/netbox/blob/07ae7c8a6e04ecc6e641044330fd4d03e4997252/netbox/extras/forms/scripts.py#L37-L47 Now if the form is fixed and scheduling_enabled is passed to the form, an exception will be thrown here because the previous code pop'ed them already: https://github.com/netbox-community/netbox/blob/07ae7c8a6e04ecc6e641044330fd4d03e4997252/netbox/extras/views.py#L1087 Open for volunteers.

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