devopsarr.sonarr.sonarr_indexer_config_info module – Get information about 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_info
.
New in devopsarr.sonarr 0.5.0
Synopsis
Get information about Sonarr indexer config.
Parameters
Parameter |
Comments |
---|---|
API key for Sonarr authentication. |
|
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
---
# fetch indexer config
- name: fetch indexer config
devopsarr.sonarr.sonarr_indexer_config_info:
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Indexer config ID. Returned: always Sample: |
|
Maximum size. Returned: always Sample: |
|
Minimum age. Returned: always Sample: |
|
Retention. Returned: always Sample: |
|
RSS sync interval. Returned: always Sample: |