Wiki menu Wiki

You can choose to let SABnzbd run a script just before an NZB enters the queue. This script determines whether the NZB should be accepted and can modify a number of job parameters.

Scripts may use any scripting language available on your system; common choices are Python, Unix shell, and Windows batch scripts. All scripts must be located in the Scripts-directory, specified in Config->Folders and must be executable. On Unix-like operating systems (Linux, BSD, etc.) this means the x-bit must be on. On Windows, the requirement is that the script's extension is listed in your system's PATHEXT environment variable. Once everything is in place, the Pre-Queue Script can be set in Config->Switches (enable Advanced Settings).

The script must write results to the console. Exit code 0 will make SABnzbd inspect the returned output. If the script has an exit code other than 0, script failure is assumed and the NZB accepted without changes.

Input parameters

All parameters (except 1) can be empty, meaning a default value. Use %1 in Windows scripts and $1 in Unix scripts. Note that on Windows the input parameters are surrounded by quotes (e.g. "job name").

NOTE Much more information is available to scripts via environment variables, see below!

Return parameters

The script can refuse or accept the NZB and it can also return alternative parameters. These parameters should be written to the console, each parameter on a separate line. SABnzbd uses the first 7 lines of output, so they should be empty (original value will be used) or only contain proper data. Anything after line 7 is ignored.

NOTE To manipulate duplicate detection, you should assemble a new name and return a recognized format.

Environment variables

Your script can get extra information via environment variables (return information should still be sent as plain output):

Example Script 1

Example of a Windows batch file that forces high priority on anything smaller than 2GB.

@echo off
echo 1
echo.
echo.
echo.
echo.
if %6 LSS 2000000000 echo 1

Save it as file size-checker.cmd and put in the scripts folder.

Example Script 2

A python script to set prio to Force on downloads smaller than 50MB:

import sys

try:
    # Parse the input variables for SABnzbd version >= 4.2.0
    (scriptname, nzbname, postprocflags, category, script, prio, downloadsize, grouplist) = sys.argv
except Exception:
    sys.exit(1)  # a non-zero exit status causes SABnzbd to ignore the output of this script

prio = -100  # Default
if int(downloadsize) < 50*1024**2:
    prio = 2

print("1")  # Accept the job
print()
print()
print()
print()
print(prio)
print()

# 0 means OK
sys.exit(0)