devopsarr.sonarr.sonarr_download_client_config module – Manages Sonarr download client config.

Note

This module is part of the devopsarr.sonarr collection (version 1.3.1).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install devopsarr.sonarr.

To use it in a playbook, specify: devopsarr.sonarr.sonarr_download_client_config.

New in devopsarr.sonarr 0.5.0

Synopsis

  • Manages Sonarr download client config.

Parameters

Parameter

Comments

auto_redownload_failed

boolean / required

Auto redownload failed.

Choices:

  • false

  • true

boolean / required

Auto redownload failed from interactive search.

Choices:

  • false

  • true

enable_completed_download_handling

boolean / required

Enable completed download handling.

Choices:

  • false

  • true

sonarr_api_key

string / required

API key for Sonarr authentication.

sonarr_url

string / required

Full Sonarr URL with protocol and port (e.g. `https://test.sonarr.tv:8989`)

Notes

Note

  • for authentication, you can set service_account_file using the c(SONARR_URL) env variable.

  • for authentication, you can set service_account_contents using the c(SONARR_API_KEY) env variable.

Examples

---
# update download client config
- name: Update download client config
  devopsarr.sonarr.sonarr_download_client_config:
    auto_redownload_failed_from_interactive_search: false
    auto_redownload_failed: false
    enable_completed_download_handling: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

auto_redownload_failed

boolean

Auto redownload failed.

Returned: always

Sample: true

boolean

Auto redownload failed from interactive search.

Returned: always

Sample: true

download_client_working_folders

string

download client working folders.

Returned: always

Sample: "_UNPACK_|_FAILED_"

enable_completed_download_handling

boolean

Enable completed download handling.

Returned: always

Sample: true

id

integer

Download client config ID.

Returned: always

Sample: 1

Authors

  • Fuochi (@Fuochi)