devopsarr.lidarr.lidarr_root_folder module – Manages Lidarr root folder.

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

New in devopsarr.lidarr 1.0.0

Synopsis

  • Manages Lidarr root folder.

Parameters

Parameter

Comments

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 / required

Metadata profile ID.

monitor_option

string / required

Monitor option.

Choices:

  • "all"

  • "future"

  • "missing"

  • "existing"

  • "latest"

  • "first"

  • "none"

  • "unknown"

name

string / required

Root folder friendly name.

new_item_monitor_option

string / required

New item monitor option.

Choices:

  • "all"

  • "none"

  • "new"

path

string / required

Actual root folder.

quality_profile_id

integer / required

Metadata 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 root folder
- name: Create a root folder
  devopsarr.lidarr.root_folder:
    name: 'Music'
    path: '/music'
    new_item_monitor_option: 'all'
    monitor_option: 'all'
    metadata_profile_id: 1
    quality_profile_id: 1

# Delete a root folder
- name: Delete a root_folder
  devopsarr.lidarr.root_folder:
    name: 'Music'
    path: '/music'
    new_item_monitor_option: 'all'
    monitor_option: 'all'
    metadata_profile_id: 1
    quality_profile_id: 1
    state: absent

Return Values

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

Key

Description

accessible

string

Access flag.

Returned: on create/update

Sample: "true"

default_metadata_profile_id

integer

Metadata profile ID.

Returned: always

Sample: 1

default_monitor_option

string

Monitor option.

Returned: always

Sample: "all"

default_new_item_monitor_option

string

New item monitor option.

Returned: always

Sample: "all"

default_quality_profile_id

integer

Metadata profile ID.

Returned: always

Sample: 1

id

integer

root folder ID.

Returned: always

Sample: 1

name

string

Root folder friendly name.

Returned: always

Sample: "Name"

path

string

The root folder path.

Returned: on create/update

Sample: "/music"

tags

list / elements=integer

Tag list.

Returned: always

Sample: [1, 2]

Authors

  • Fuochi (@Fuochi)