devopsarr.sonarr.sonarr_indexer_config module – Manages Sonarr indexer 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_indexer_config.

New in devopsarr.sonarr 0.5.0

Synopsis

  • Manages Sonarr indexer config.

Parameters

Parameter

Comments

maximum_size

integer / required

Maximum size.

minimum_age

integer / required

Minimum age.

retention

integer / required

Retention.

rss_sync_interval

integer / required

RSS sync interval.

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 indexer config
- name: Update indexer config
  devopsarr.sonarr.sonarr_indexer_config:
    maximum_size: 0
    minimum_age: 0
    retention: 0
    rss_sync_interval: 50

Return Values

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

Key

Description

id

integer

Indexer config ID.

Returned: always

Sample: 1

maximum_size

integer

Maximum size.

Returned: always

Sample: 0

minimum_age

integer

Minimum age.

Returned: always

Sample: 0

retention

integer

Retention.

Returned: always

Sample: 0

rss_sync_interval

integer

RSS sync interval.

Returned: always

Sample: 100

Authors

  • Fuochi (@Fuochi)