starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-04-26 18:58:54 +02:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Closes #21751: Enable toggling user notifications when executing custom scripts (#21923)

Browse Source
This commit is contained in:
Jeremy Stretch
2026-04-20 12:32:41 -04:00
committed by GitHub
parent 93fdcaf34e
commit b68b0c6d78
12 changed files with 196 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/customization/custom-scripts.md
View File

@@ -115,6 +115,20 @@ commit_default = False
By default, a script can be scheduled for execution at a later time. Setting `scheduling_enabled` to False disables this ability: Only immediate execution will be possible. (This also disables the ability to set a recurring execution interval.)
### `notifications_default`
By default, a notification is generated for the requesting user each time a script finishes running. This attribute sets the initial value for the notifications field when running a script. Valid values are `always` (default), `on_failure`, and `never`.
```python
notifications_default = 'on_failure'
```
| Value | Behavior |
|-------|----------|
| `always` | Notify on every completion (default) |
| `on_failure` | Notify only when the job fails or errors |
| `never` | Never send a notification |
### `job_timeout`
Set the maximum allowed runtime for the script. If not set, `RQ_DEFAULT_TIMEOUT` will be used.