devopsarr.lidarr.lidarr_naming (1.0.0) — module

Manages Lidarr naming.

| "added in version" 1.0.0 of devopsarr.lidarr"

Authors: Fuochi (@Fuochi)

Install collection

Install with ansible-galaxy collection install devopsarr.lidarr:==1.0.0


Add to requirements.yml

  collections:
    - name: devopsarr.lidarr
      version: 1.0.0

Description

Manages Lidarr naming.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
# 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}'

Inputs

    
lidarr_url:
    description: Full Lidarr URL with protocol and port (e.g. `https://test.lidarr.tv:8686`)
    required: true
    type: str

rename_tracks:
    description: Rename tracks.
    required: true
    type: bool

lidarr_api_key:
    description: API key for Lidarr authentication.
    required: true
    type: str

artist_folder_format:
    description: Artist folder format.
    required: true
    type: str

standard_track_format:
    description: Standard track format.
    required: true
    type: str

multi_disc_track_format:
    description: Multi disc track format.
    required: true
    type: str

colon_replacement_format:
    choices:
    - 0
    - 1
    - 2
    - 3
    - 4
    description: Colon replacement format. 0 `delete`, 1 `dash`, 2 `spaceDash`, 3 `spaceDashSpace`,
      4 `smart`.
    required: true
    type: int

replace_illegal_characters:
    description: Replace illegal characters.
    required: true
    type: bool

Outputs

artist_folder_format:
  description: Artist folder format.
  returned: always
  sample: '{Artist Name}'
  type: str
colon_replacement_format:
  description: Colon replacement format.
  returned: always
  sample: 1
  type: int
id:
  description: Naming ID.
  returned: always
  sample: '1'
  type: int
multi_disc_track_format:
  description: Standard track format.
  returned: always
  sample: '{Album Title} ({Release Year})/{Medium Format} {medium:00}/{Artist Name}
    - {Album Title} - {track:00} - {Track Title}'
  type: str
rename_tracks:
  description: Rename tracks.
  returned: always
  sample: true
  type: bool
replace_illegal_characters:
  description: Replace illegal characters.
  returned: always
  sample: true
  type: bool
standard_track_format:
  description: Standard track format.
  returned: always
  sample: '{Album Title} ({Release Year})/{Artist Name} - {Album Title} - {track:00}
    - {Track Title}'
  type: str