devopsarr.lidarr.lidarr_import_list_exclusion module – Manages Lidarr import list exclusion.

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

New in devopsarr.lidarr 1.0.0

Synopsis

  • Manages Lidarr import list exclusion.

Parameters

Parameter

Comments

artist_name

string / required

Artist name.

foreign_id

string / required

Foreign ID.

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

state

string

Create or delete resource.

Choices:

  • "present" ← (default)

  • "absent"

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 exclusion
- name: Create a import list exclusion
  devopsarr.lidarr.lidarr_import_list_exclusion:
    foreign_id: "b1a9c0e9-d987-4042-ae91-78d6a3267d69"
    artist_name: "test"


# Delete a import list exclusion
- name: Delete a import_list_exclusion
  devopsarr.lidarr.lidarr_import_list_exclusion:
    foreign_id: "b1a9c0e9-d987-4042-ae91-78d6a3267d69"
    artist_name: "test"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

artist_name

string

Foreign ID.

Returned: always

Sample: "Queen"

foreign_id

string

Foreign ID.

Returned: always

Sample: "b1a9c0e9-d987-4042-ae91-78d6a3267d69"

id

integer

import list exclusion ID.

Returned: always

Sample: 1

Authors

  • Fuochi (@Fuochi)