devopsarr.lidarr.lidarr_custom_format_info module – Get information about Lidarr custom format.

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

New in devopsarr.lidarr 1.0.0

Synopsis

  • Get information about Lidarr custom format.

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

name

string

Name.

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 custom formats
- name: Gather information about all custom formats
  devopsarr.lidarr.lidarr_custom_format_info:

# Gather information about a single custom format
- name: Gather information about a single custom format
  devopsarr.lidarr.lidarr_custom_format_info:
    name: Example

Return Values

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

Key

Description

custom_formats

list / elements=dictionary

A list of custom format.

Returned: always

id

integer

custom formatID.

Returned: always

Sample: 1

include_custom_format_when_renaming

boolean

Include custom format when renaming flag.

Returned: always

Sample: false

name

string

Name.

Returned: always

Sample: "Example"

specifications

list / elements=string

specification list.

Returned: always

Authors

  • Fuochi (@Fuochi)