devopsarr.lidarr.lidarr_artist module – Manages lidarr Artist.

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

New in devopsarr.lidarr 1.0.0

Synopsis

  • Manages lidarr Artist.

Parameters

Parameter

Comments

artist_name

string / required

Artist name.

foreign_artist_id

string / required

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

metadata_profile_id

integer

Metadata profile ID.

monitored

boolean

Monitored flag.

Choices:

  • false ← (default)

  • true

path

string / required

Artist path.

quality_profile_id

integer

Quality profile ID.

state

string

Create or delete resource.

Choices:

  • "present" ← (default)

  • "absent"

tags

list / elements=integer

Tag list.

Default: []

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 artist
- name: Create a artist
  devopsarr.lidarr.lidarr_artist:
    artist_name: "Queen"
    foreign_artist_id: "0383dadf-2a4e-4d10-a46a-e9e041da8eb3"
    monitored: true
    path: "/config/queen"
    quality_profile_id: 1
    metadata_profile_id: 1
    tags: [1,2]

# Delete a artist
- name: Delete a artist
  devopsarr.lidarr.lidarr_artist:
    artist_name: "Queen"
    foreign_artist_id: "0383dadf-2a4e-4d10-a46a-e9e041da8eb3"
    path: "/config/queen"
    state: absent

Return Values

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

Key

Description

artist_name

string

Artist name.

Returned: always

Sample: "Artist name"

foreign_artist_id

string

Foreign artist ID.

Returned: always

Sample: "0383dadf-2a4e-4d10-a46a-e9e041da8eb3"

id

integer

artist ID.

Returned: always

Sample: 1

metadata_profile_id

integer

Metadata profile ID.

Returned: always

Sample: 1

monitored

boolean

Monitored flag.

Returned: always

Sample: false

path

string

Artist path.

Returned: always

Sample: "/artist/artist_artist_name"

quality_profile_id

integer

Quality profile ID.

Returned: always

Sample: 1

tags

list / elements=integer

Tag list.

Returned: always

Sample: [1, 2]

Authors

  • Fuochi (@Fuochi)