devopsarr.lidarr.lidarr_naming module – Manages Lidarr naming.

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

New in devopsarr.lidarr 1.0.0

Synopsis

  • Manages Lidarr naming.

Parameters

Parameter

Comments

artist_folder_format

string / required

Artist folder format.

colon_replacement_format

integer / required

Colon replacement format. 0 `delete`, 1 `dash`, 2 `spaceDash`, 3 `spaceDashSpace`, 4 `smart`.

Choices:

  • 0

  • 1

  • 2

  • 3

  • 4

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

multi_disc_track_format

string / required

Multi disc track format.

rename_tracks

boolean / required

Rename tracks.

Choices:

  • false

  • true

replace_illegal_characters

boolean / required

Replace illegal characters.

Choices:

  • false

  • true

standard_track_format

string / required

Standard track format.

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

---
# update naming
- name: Update naming
  devopsarr.lidarr.lidarr_naming:
    rename_tracks: true
    replace_illegal_characters: true
    colon_replacement_format: 1
    artist_folder_format: '{Artist Name}'
    multi_disc_track_format: '{Album Title} ({Release Year})/{Medium Format} {medium:00}/{Artist Name} - {Album Title} - {track:00} - {Track Title}'
    standard_track_format: '{Album Title} ({Release Year})/{Artist Name} - {Album Title} - {track:00} - {Track Title}'

Return Values

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

Key

Description

artist_folder_format

string

Artist folder format.

Returned: always

Sample: "{Artist Name}"

colon_replacement_format

integer

Colon replacement format.

Returned: always

Sample: 1

id

integer

Naming ID.

Returned: always

Sample: 1

multi_disc_track_format

string

Standard track format.

Returned: always

Sample: "{Album Title} ({Release Year})/{Medium Format} {medium:00}/{Artist Name} - {Album Title} - {track:00} - {Track Title}"

rename_tracks

boolean

Rename tracks.

Returned: always

Sample: true

replace_illegal_characters

boolean

Replace illegal characters.

Returned: always

Sample: true

standard_track_format

string

Standard track format.

Returned: always

Sample: "{Album Title} ({Release Year})/{Artist Name} - {Album Title} - {track:00} - {Track Title}"

Authors

  • Fuochi (@Fuochi)