Pause

The Pause action pauses the NZBGet download queue. Downloads stop until you resume them again with Resume.

This is handy for freeing up your internet connection automatically, for example, pausing downloads while you are on a video call or streaming a movie.

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 pause the download queue 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: Pause.
6. 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

This action has no additional 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.

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

action: nzbget.pause

This pauses the download queue.

Options in YAML

This action has no additional options in YAML.

Try it yourself

Ready to test this? Open Developer 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.

Automation: pause downloads during a video call

When a video call starts, pause NZBGet so it does not compete for bandwidth.

• Trigger: A “video call” helper turns on
• Action: NZBGet: Pause

alias: "Pause downloads during calls"
triggers:
  - trigger: state
    entity_id: input_boolean.video_call
    to: "on"
actions:
  - action: nzbget.pause

Still stuck?

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

These actions work well alongside this one:

• Resume: Resumes the NZBGet download queue.

• Set speed: Sets the NZBGet download queue speed limit.