devopsarr.sonarr.sonarr_download_client_usenet_blackhole (0.6.0) — module

Install collection

Install with ansible-galaxy collection install devopsarr.sonarr:==0.6.0

Add to requirements.yml

  collections:
    - name: devopsarr.sonarr
      version: 0.6.0

Description

Manages Sonarr download client Usenet Blackhole.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
# Create a download client
- name: Create a download client
  devopsarr.sonarr.sonarr_download_client_usenet_blackhole:
    remove_completed_downloads: false
    remove_failed_downloads: false
    enable: false
    priority: 1
    name: "UsenetBlackhole"
    nzb_folder: "/usenetblackhole"
    watch_folder: "/strm"
    tags: [1,2]

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Delete a download client
- name: Delete a download client
  devopsarr.sonarr.sonarr_download_client_usenet_blackhole:
    name: Example
    state: absent

Inputs

    
name:
    description: Name.
    required: true
    type: str

tags:
    default: []
    description: Tag list.
    elements: int
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description: Create or delete a indexer.
    required: false
    type: str

enable:
    description: Enable flag.
    type: bool

priority:
    description: Priority.
    type: int

nzb_folder:
    description: NZB folder.
    type: str

sonarr_url:
    description: Full Sonarr URL with protocol and port (e.g. `https://test.sonarr.tv:8989`)
    required: true
    type: str

watch_folder:
    description: Watch folder.
    type: str

sonarr_api_key:
    description: API key for Sonarr authentication.
    required: true
    type: str

remove_failed_downloads:
    description: remove_failed_downloads flag.
    type: bool

remove_completed_downloads:
    description: remove_completed_downloads flag.
    type: bool

Outputs

config_contract:
  description: Config contract.
  returned: always
  sample: BroadcastheNetSettings
  type: str
enable:
  description: Enable flag.
  returned: always
  sample: true
  type: bool
fields:
  description: field list.
  returned: always
  type: list
id:
  description: download clientID.
  returned: always
  sample: 1
  type: int
implementation:
  description: Implementation.
  returned: always
  sample: BroadcastheNet
  type: str
name:
  description: Name.
  returned: always
  sample: Example
  type: str
priority:
  description: Priority.
  returned: always
  sample: 1
  type: int
protocol:
  description: Protocol.
  returned: always
  sample: usenet
  type: str
remove_completed_downloads:
  description: Remove completed downloads flag.
  returned: always
  sample: true
  type: bool
remove_failed_downloads:
  description: Remove failed downloads flag.
  returned: always
  sample: false
  type: bool
tags:
  description: Tag list.
  elements: int
  returned: always
  sample:
  - 1
  - 2
  type: list