devopsarr.lidarr.lidarr_import_list module – Manages Lidarr import list.

Note

This module is part of the devopsarr.lidarr collection (version 1.0.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.lidarr.

To use it in a playbook, specify: devopsarr.lidarr.lidarr_import_list.

New in devopsarr.lidarr 1.0.0

Synopsis

  • Manages Lidarr import list.

Parameters

Parameter

Comments

config_contract

string

Config contract.

enable_automatic_add

boolean

Enable automatic add flag.

Choices:

  • false

  • true

fields

list / elements=dictionary

Configuration field list.

name

string

Field name.

value

any

Field value.

implementation

string

Implementation.

lidarr_api_key

string / required

API key for Lidarr authentication.

lidarr_url

string / required

Full Lidarr URL with protocol and port (e.g. `https://test.lidarr.tv:8686`)

list_order

integer

List order.

list_type

string

List type.

metadata_profile_id

integer

Metadata profile ID.

monitor_new_items

string

Monitor new items.

Choices:

  • "none"

  • "new"

  • "all"

name

string / required

Name.

quality_profile_id

integer

Quality profile ID.

root_folder_path

string

Root folder.

should_monitor

string

Should monitor.

Choices:

  • "none"

  • "specificAlbum"

  • "entireArtist"

should_monitor_existing

boolean

Should monitor existing flag.

Choices:

  • false

  • true

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

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

Examples

---
# Create a import list
- name: Create a import list
  devopsarr.lidarr.lidarr_import_list:
    enable_automatic_add: false
    should_monitor_existing: true
    should_monitor: "entireArtist"
    quality_profile_id: 1
    metadata_profile_id: 1
    list_order: 1
    monitor_new_items: "all"
    should_search: false
    fields:
    - name: "apiKey"
      value: "Key"
    - name: "baseUrl"
      value: "localhost"
    - name: "profileIds"
      value: [1]
    - name: "rootFolderPaths"
      value: ["/tmp"]
    name: "LidarrImport"
    list_type: "standard"
    root_folder_path: "/tmp"
    config_contract: "LidarrSettings"
    implementation: "LidarrImport"
    tags: []

# Delete a import list
- name: Delete a import list
  devopsarr.lidarr.lidarr_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"

list_order

integer

List order.

Returned: always

Sample: 1

list_type

string

List type.

Returned: always

Sample: "standard"

metadata_profile_id

integer

Metadata profile ID.

Returned: always

Sample: 1

monitor_new_items

string

Monitor new items.

Returned: always

Sample: "all"

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.

Returned: always

Sample: "/tmp"

should_monitor

string

Should monitor.

Returned: always

Sample: "none"

should_monitor_existing

boolean

Should monitor existing flag.

Returned: always

Sample: false

boolean

Search on add flag.

Returned: always

Sample: false

tags

list / elements=integer

Tag list.

Returned: always

Sample: [1, 2]

Authors

  • Fuochi (@Fuochi)