devopsarr.lidarr.lidarr_media_management (1.0.0) — module

Manages Lidarr media management.

| "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 media management.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
# update media management
- name: Update media management
  devopsarr.lidarr.lidarr_media_management:
    chmod_folder: "755"
    rescan_after_refresh: "always"
    recycle_bin: ""
    file_date: "none"
    extra_file_extensions: "info"
    download_propers_and_repacks: "doNotPrefer"
    allow_fingerprinting: "newFiles"
    chown_group: "arrs"
    minimum_free_space_when_importing: 100
    recycle_bin_cleanup_days: 7
    auto_unmonitor_previously_downloaded_tracks: true
    skip_free_space_check_when_importing: true
    set_permissions_linux: true
    import_extra_files: true
    enable_media_info: true
    delete_empty_folders: true
    create_empty_artist_folders: true
    copy_using_hardlinks: true
    paths_default_static: false
    auto_rename_folders: true

Inputs

    
file_date:
    choices:
    - none
    - albumReleaseDate
    description: File date modification.
    required: true
    type: str

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

chown_group:
    description: Linux group.
    required: true
    type: str

recycle_bin:
    description: Bin path.
    required: true
    type: str

chmod_folder:
    description: Permission in linux format.
    required: true
    type: str

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

enable_media_info:
    description: Enable media info flag.
    required: true
    type: bool

import_extra_files:
    description: Import extra files flag.
    required: true
    type: bool

auto_rename_folders:
    description: Auto rename folders.
    required: true
    type: bool

allow_fingerprinting:
    choices:
    - always
    - newFiles
    - never
    default: always
    description: Allow fingerprinting.
    type: str

copy_using_hardlinks:
    description: Copy using hardlinks.
    required: true
    type: bool

delete_empty_folders:
    description: Delete empty folders.
    required: true
    type: bool

paths_default_static:
    description: Paths default static.
    required: true
    type: bool

rescan_after_refresh:
    choices:
    - always
    - afterManual
    - never
    description: Rescan after refresh.
    required: true
    type: str

extra_file_extensions:
    description: Comma separated list of extra files extension to be imported.
    required: true
    type: str

set_permissions_linux:
    description: Set linux permission flag.
    required: true
    type: bool

recycle_bin_cleanup_days:
    description: Recycle bin days.
    required: true
    type: int

watch_library_for_changes:
    default: false
    description: Watch library for changes flag.
    type: bool

create_empty_artist_folders:
    description: create empty artist folder.
    required: true
    type: bool

download_propers_and_repacks:
    choices:
    - preferAndUpgrade
    - doNotUpgrade
    - doNotPrefer
    description: Download propers and repack.
    required: true
    type: str

minimum_free_space_when_importing:
    description: Minimum free space when importing.
    required: true
    type: int

skip_free_space_check_when_importing:
    description: Skip free space check when importing.
    required: true
    type: bool

auto_unmonitor_previously_downloaded_tracks:
    description: Auto unmonitor previously downloaded tracks.
    required: true
    type: bool

Outputs

allow_fingerprinting:
  description: Allow fingerprinting.
  returned: always
  sample: always
  type: str
auto_rename_folders:
  description: Auto rename folders.
  returned: always
  sample: 'true'
  type: bool
auto_unmonitor_previously_downloaded_tracks:
  description: Auto unmonitor previously downloaded tracks.
  returned: always
  sample: 'true'
  type: bool
chmod_folder:
  description: Permission in linux format.
  returned: always
  sample: '755'
  type: str
chown_group:
  description: Linux group.
  returned: always
  sample: arrs
  type: str
copy_using_hardlinks:
  description: Copy using hardlinks.
  returned: always
  sample: 'true'
  type: bool
create_empty_artist_folders:
  description: create empty artist folder.
  returned: always
  sample: 'true'
  type: bool
delete_empty_folders:
  description: Delete empty folders.
  returned: always
  sample: 'true'
  type: bool
download_propers_and_repacks:
  description: Download propers and repack.
  returned: always
  sample: preferAndUpgrade
  type: str
enable_media_info:
  description: Enable media info flag.
  returned: always
  sample: 'true'
  type: bool
extra_file_extensions:
  description: Comma separated list of extra files extension to be imported.
  returned: always
  sample: srt,info
  type: str
file_date:
  description: File date modification.
  returned: always
  sample: localAirDate
  type: str
id:
  description: Media management ID.
  returned: always
  sample: '1'
  type: int
import_extra_files:
  description: Import extra files flag.
  returned: always
  sample: 'true'
  type: bool
minimum_free_space_when_importing:
  description: Minimum free space when importing.
  returned: always
  sample: '100'
  type: int
paths_default_static:
  description: Paths default static.
  returned: always
  sample: 'true'
  type: bool
recycle_bin:
  description: Bin path.
  returned: always
  sample: /tmp
  type: str
recycle_bin_cleanup_days:
  description: Recycle bin days.
  returned: always
  sample: '7'
  type: int
rescan_after_refresh:
  description: Rescan after refresh.
  returned: always
  sample: afterManual
  type: str
set_permissions_linux:
  description: Set linux permission flag.
  returned: always
  sample: 'true'
  type: bool
skip_free_space_check_when_importing:
  description: Skip free space check when importing.
  returned: always
  sample: 'true'
  type: bool
watch_library_for_changes:
  description: Watch library for changes flag.
  returned: always
  sample: false
  type: bool