A Powershell module for working with your SABNZBD instance.
This module allows you to pull queue information into Powershell objects and manipulate the queue/slots.
Basically, this is a PS Module frontend to the REST API provided by SABNZBD.
To use this item you will need to generate an API key in your SABNZBD instance:
Settings --> General --> Security --> API Key
Copy the module to you $env:PSModulePath and load with:
Import-Module SABNZBD
Manipulate the status of the whole queue. Use this function to pause or resume all slots in the queue. Use the syntax:
Set-SABQueueStatus -Hostname xxx.com.au:8080 -apikey 33697778f6821f9895d99bf599e5d04a -status Paused -Minutes 60
-Hostname - Provide the hostname and port of your servers web interface
-apikey - Provide the API key generated from the SAB configuration menu
-status - Provide the status action, either Pause or Resume
-minutes - If pausing the queue you can provide a number of minutes to pause. If not provided the queue is paused indefinitely (unless manually resumed)
Return statistics about the whole queue. Use the syntax:
Get-SABQueueTotals -Hostname xxx.com.au:8080 -apikey 33697778f6821f9895d99bf599e5d04a
-Hostname - Provide the hostname and port of your servers web interface
-apikey - Provide the API key generated from the SAB configuration menu
No. Downloads : 7
Speed (KB/s) : 5724
Total (MB) : 13325
Total Remaining (MB) : 12374
Completed (%) : 7
Gets a list of the queued items in your SAB installation. Use the syntax:
Get-SABQueueList -Hostname xxx.com.au:8080 -apikey 33697778f6821f9895d99bf599e5d04a -ExcludeCompleted
-Hostname - Provide the hostname and port of your servers web interface
-apikey - Provide the API key generated from the SAB configuration menu
-ExcludeCompleted - $True or $False this option will exclude downloads that are at 100%
Remaining (MB) Size (MB) Completed (%) FileName
-------------- --------- ------------- --------
860 1563 55 xxxxxxxxxxxxxxxx.S06E09.720p.HDTV.x264-AVS
98 1392 7 xxxxxxxxxxxxxxxx.S04E04.720p.HDTV.x264-SKGTV
74 1435 5 xxxxxxxxxxxxxxxx.S04E03.720p.HDTV.x264-SKGTV
38 3045 1 xxxxxxxxxxxxxxxx-s01E01-hddvd-720p
346 7715 4 xxxxxxxxxxxxxxxx.2015.DOCU.1080p.BluRay.x264-AN0NYM0US.cp
176 2496 7 xxxxxxxxxxxxxxxx-s01E11-hddvd-720p
21 2453 1 xxxxxxxxxxxxxxxx-s01E23-hddvd-720p
2358 2496 94 xxxxxxxxxxxxxxxx-s01E10-hddvd-720p
176 2293 8 xxxxxxxxxxxxxxxx.S02E10.1080p.WEB-DL.DD5.1.H.264
65 2234 3 xxxxxxxxxxxxxxxx.2014.S02E09.1080p.WEB-DL.DD5.1.H.264
Set the current queue speed limit either by percentage or value (M or K). To use this function you must set a global speed limit in the SABNZBD config under:
Settings --> General --> Tuning --> Maximum Line Speed
Once this is set, the percentage is based off this number. Setting by the 'value' will apply this new limit to the current queue. It will not change the default setting in the configuration file.
This function is used to temporarily adjust speed for the current queue.
Use the syntax:
Set-SABSpeedLimit -Hostname xxx.com.au:8080 -apikey 33697778f6821f9895d99bf599e5d04a -Percentage 50 (-value 100M)
-Hostname - Provide the hostname and port of your servers web interface
-apikey - Provide the API key generated from the SAB configuration menu
-Percentage - Set current speed as percentage of global line speed setting
-value - Set the current speed to a direct value, either M (megabyte) or K (Kilobyte)
Returns the raw queue data from SABNZBD. This function can be called directly, but is generally used by other functions internally. Use the syntax:
Get-SABRawQueue -Hostname xxx.com.au:8080 -apikey 33697778f6821f9895d99bf599e5d04a -ExcludeCompleted
-Hostname - Provide the hostname and port of your servers web interface
-apikey - Provide the API key generated from the SAB configuration menu