devopsarr.sonarr.sonarr_download_client (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.

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:
    remove_completed_downloads: false
    remove_failed_downloads: false
    enable: false
    priority: 1
    name: "Hadouken"
    host: "hadouken.lcl"
    url_base: "/hadouken/"
    port: 9091
    category: "sonarr-tv"
    username: "username"
    password: "password"
    protocol: "torrent"
    config_contract: "HadoukenSettings"
    implementation: "Hadouken"
    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:
    name: Example
    state: absent

Inputs

    
host:
    description: Host.
    type: str

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

port:
    description: Port.
    type: int

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

api_key:
    description: API key.
    type: str

use_ssl:
    description: Use SSL.
    type: bool

category:
    description: Category.
    type: str

password:
    description: Password.
    type: str

priority:
    description: Priority.
    type: int

protocol:
    choices:
    - torrent
    - usenet
    description: Protocol.
    type: str

rpc_path:
    description: RPC path.
    type: str

url_base:
    description: Base URL.
    type: str

username:
    description: Username.
    type: str

read_only:
    description: Read only.
    type: bool

add_paused:
    description: Add paused.
    type: bool

field_tags:
    description: Field Tags.
    elements: str
    type: list

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

add_stopped:
    description: Add stopped.
    type: bool

destination:
    description: Destination.
    type: str

strm_folder:
    description: Strm folder.
    type: str

tv_category:
    description: TV category.
    type: str

intial_state:
    description: Intial state.
    type: int

secret_token:
    description: Secret token.
    type: str

start_on_add:
    description: Start on add on.
    type: bool

tv_directory:
    description: TV directory.
    type: str

watch_folder:
    description: Watch folder.
    type: str

initial_state:
    description: Initial state.
    type: int

first_and_last:
    description: First and last.
    type: bool

implementation:
    description: Implementation.
    type: str

older_priority:
    description: Older TV priority (Freebox).
    type: int

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

torrent_folder:
    description: Torrent folder.
    type: str

update_secrets:
    default: false
    description: Flag to force update of secret fields.
    type: bool

additional_tags:
    description: Additional Tags.
    elements: int
    type: list

config_contract:
    description: Config contract.
    type: str

recent_priority:
    description: Recent TV priority (Freebox).
    type: int

post_import_tags:
    description: Post import Tags.
    elements: str
    type: list

sequential_order:
    description: Secuential order.
    type: bool

older_tv_priority:
    description: Older TV priority.
    type: int

save_magnet_files:
    description: Save magnet files.
    type: bool

recent_tv_priority:
    description: Recent TV priority.
    type: int

tv_imported_category:
    description: TV imported category.
    type: str

magnet_file_extension:
    description: Magnet file extension.
    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: torrent
  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