Set speed

The NZBGet: Set speed action sets the download speed limit for the NZBGet queue, in kilobytes per second. Set it to 0 to remove the limit and let downloads run at full speed.

This is handy for throttling downloads automatically, for example, capping the speed during the day and lifting the limit at night.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To set the download speed limit from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. From the search box, search for and select NZBGet: Set speed.
6. Enter the Speed limit you want to apply.
7. Select Save.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required. For how an automation or a script is built in YAML, refer to Automations in YAML and Scripts.

In YAML, refer to this action as nzbget.set_speed. A basic example looks like this:

action: nzbget.set_speed
data:
  speed: 500

This limits the download queue to 500 kilobytes per second.

Options in YAML

Try it yourself

Ready to test this? Open Settings > Tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup. In the visual editor, select the UI options listed in the example or paste the YAML code.

Automation: throttle downloads during the day

Cap the download speed during the day and lift the limit again overnight.

• Trigger: Time, 08:00
• Action: NZBGet: Set speed

alias: "Throttle downloads during the day"
triggers:
  - trigger: time
    at: "08:00:00"
actions:
  - action: nzbget.set_speed
    data:
      speed: 500

Still stuck?

To test the action on its own, run it in the automation editor with Run action, and check the message that it shows. To see what the action did when the automation ran, open the trace of that run. For details, refer to Testing automations. For common problems and their solutions, refer to Troubleshooting automations.

If that doesn’t help, the Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

Explore related actions:

• Pause: Pauses the NZBGet download queue.

• Resume: Resumes the NZBGet download queue.