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 string	Config contract.
enable_auto boolean	Enable automatic add flag. Choices: `false` `true`
enabled boolean	Enabled flag. Choices: `false` `true`
fields list / elements=dictionary	Configuration field list.
name string	Field name.
value any	Field value.
implementation string	Implementation.
list_order integer	List order.
list_type string	List type.
minimum_availability string	Minimum availability.
monitor string	Should monitor.
name string / required	Name.
quality_profile_id integer	Quality profile ID.
radarr_api_key string / required	API key for Radarr authentication.
radarr_url string / required	Full Radarr URL with protocol and port (e.g. `https://test.radarr.tv:7878`)
root_folder_path string	Root folder path.
search_on_add boolean	Search on add flag. Choices: `false` `true`
state string	Create or delete resource. Choices: `"present"` ← (default) `"absent"`
tags list / elements=integer	Tag list. Default: `[]`
update_secrets boolean	Flag to force update of secret fields. Choices: `false` ← (default) `true`

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 string	Config contract. Returned: always Sample: `"CustomSettings"`
enable_auto boolean	Enable automatic add flag. Returned: always Sample: `false`
enabled boolean	Enabled flag. Returned: always Sample: `false`
fields list / elements=string	field list. Returned: always
id integer	import listID. Returned: always Sample: `1`
implementation string	Implementation. Returned: always Sample: `"CustomImport"`
list_order integer	List order. Returned: always Sample: `1`
list_type string	List type. Returned: always Sample: `"standard"`
minimum_availability string	Minimum availability. Returned: always Sample: `"tba"`
monitor string	Should monitor. Returned: always Sample: `"unknown"`
name string	Name. Returned: always Sample: `"Example"`
protocol string	Protocol. Returned: always Sample: `"torrent"`
quality_profile_id integer	Quality profile ID. Returned: always Sample: `1`
root_folder_path string	Root folder path. Returned: always Sample: `"/path"`
search_on_add boolean	Search on add flag. Returned: always Sample: `false`
tags list / elements=integer	Tag list. Returned: always Sample: `[1, 2]`

Authors

Fuochi (@Fuochi)

devopsarr.radarr.radarr_import_list module – Manages Radarr import list.

Synopsis

Parameters

Notes

Examples

Return Values