devopsarr.lidarr.lidarr_artist_info module – Get information about 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_info.

New in devopsarr.lidarr 1.0.0

Synopsis

  • Get information about Lidarr artist.

Parameters

Parameter

Comments

foreign_artist_id

string

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

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

---
# Gather information about all artist.
- name: Gather information about all artist
  devopsarr.lidarr.lidarr_artist_info:

# Gather information about a single artist.
- name: Gather information about a single artist
  devopsarr.lidarr.lidarr_artist_info:
    foreign_artist_id: "0383dadf-2a4e-4d10-a46a-e9e041da8eb3"

Return Values

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

Key

Description

artist_list

list / elements=dictionary

A list of artist.

Returned: always

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)