devopsarr.radarr.radarr_import_list module – Manages Radarr import list.
Note
This module is part of the devopsarr.radarr collection (version 1.2.0).
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.radarr
.
To use it in a playbook, specify: devopsarr.radarr.radarr_import_list
.
New in devopsarr.radarr 1.0.0
Synopsis
Manages Radarr import list.
Parameters
Parameter |
Comments |
---|---|
Config contract. |
|
Enable automatic add flag. Choices:
|
|
Enabled flag. Choices:
|
|
Configuration field list. |
|
Field name. |
|
Field value. |
|
Implementation. |
|
List order. |
|
List type. |
|
Minimum availability. |
|
Should monitor. |
|
Name. |
|
Quality profile ID. |
|
API key for Radarr authentication. |
|
Full Radarr URL with protocol and port (e.g. `https://test.radarr.tv:7878`) |
|
Root folder path. |
|
Search on add flag. Choices:
|
|
Create or delete resource. Choices:
|
|
Tag list. Default: |
|
Flag to force update of secret fields. Choices:
|
Notes
Note
for authentication, you can set service_account_file using the c(RADARR_URL) env variable.
for authentication, you can set service_account_contents using the c(RADARR_API_KEY) env variable.
Examples
---
# Create a import list
- name: Create a import list
devopsarr.radarr.radarr_import_list:
enable_auto: false
enabled: true
monitor: "unknown"
quality_profile_id: 1
list_order: 1
root_folder_path: "/config"
search_on_add: false
fields:
- name: "apiKey"
value: "Key"
- name: "baseUrl"
value: "localhost"
- name: "languageProfileIds"
value: [1]
name: "RadarrImport"
list_type: "standard"
minimum_availability: "tba"
config_contract: "RadarrSettings"
implementation: "RadarrImport"
tags: []
# Delete a import list
- name: Delete a import list
devopsarr.radarr.radarr_import_list:
name: Example
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Config contract. Returned: always Sample: |
|
Enable automatic add flag. Returned: always Sample: |
|
Enabled flag. Returned: always Sample: |
|
field list. Returned: always |
|
import listID. Returned: always Sample: |
|
Implementation. Returned: always Sample: |
|
List order. Returned: always Sample: |
|
List type. Returned: always Sample: |
|
Minimum availability. Returned: always Sample: |
|
Should monitor. Returned: always Sample: |
|
Name. Returned: always Sample: |
|
Protocol. Returned: always Sample: |
|
Quality profile ID. Returned: always Sample: |
|
Root folder path. Returned: always Sample: |
|
Search on add flag. Returned: always Sample: |
|
Tag list. Returned: always Sample: |