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

New in devopsarr.lidarr 1.0.0

Synopsis

  • Get information about 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`)

path

string

Actual root folder.

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 root folders.
- name: Gather information about all root folders
  devopsarr.lidarr.lidarr_root_folder_info:

# Gather information about a single root folder.
- name: Gather information about a single root folder
  devopsarr.lidarr.lidarr_root_folder_info:
    name: test

Return Values

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

Key

Description

root_folders

list / elements=dictionary

A list of root folders.

Returned: always

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)