devopsarr.sonarr.sonarr_import_list module – Manages Sonarr import list.

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_import_list.

New in devopsarr.sonarr 1.0.0

Synopsis

  • Manages Sonarr import list.

Parameters

Parameter

Comments

config_contract

string

Config contract.

enable_automatic_add

boolean

Enable autometic add flag.

Choices:

  • false

  • true

fields

list / elements=dictionary

Configuration field list.

name

string

Field name.

value

any

Field value.

implementation

string

Implementation.

name

string / required

Name.

quality_profile_id

integer

Quality profile ID.

root_folder_path

string

Root folder path.

season_folder

boolean

Season folder flag.

Choices:

  • false

  • true

series_type

string

Series type.

should_monitor

string

Should monitor.

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`)

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(SONARR_URL) env variable.

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

Examples

---
# Create a import list
- name: Create a import list
  devopsarr.sonarr.sonarr_import_list:
    enable_automatic_add: false
    should_monitor: "unknown"
    quality_profile_id: 1
    root_folder_path: "/config"
    season_folder: false
    fields:
    - name: "apiKey"
      value: "Key"
    - name: "baseUrl"
      value: "localhost"
    - name: "languageProfileIds"
      value: [1]
    name: "SonarrImport"
    series_type: "standard"
    config_contract: "SonarrSettings"
    implementation: "SonarrImport"
    tags: []

# Delete a import list
- name: Delete a import list
  devopsarr.sonarr.sonarr_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_automatic_add

boolean

Enable automatic add 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"

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"

season_folder

boolean

Season folder flag.

Returned: always

Sample: false

series_type

string

Series type.

Returned: always

Sample: "standard"

should_monitor

string

Should monitor.

Returned: always

Sample: "unknown"

tags

list / elements=integer

Tag list.

Returned: always

Sample: [1, 2]

Authors

  • Fuochi (@Fuochi)