devopsarr.sonarr.sonarr_quality_info module – Get information about Sonarr quality.

Note

This module is part of the devopsarr.sonarr collection (version 1.3.1).

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

To use it in a playbook, specify: devopsarr.sonarr.sonarr_quality_info.

New in devopsarr.sonarr 0.6.0

Synopsis

  • Get information about Sonarr quality.

Parameters

Parameter

Comments

name

string

Name.

sonarr_api_key

string / required

API key for Sonarr authentication.

sonarr_url

string / required

Full Sonarr URL with protocol and port (e.g. `https://test.sonarr.tv:8989`)

Notes

Note

  • for authentication, you can set service_account_file using the c(SONARR_URL) env variable.

  • for authentication, you can set service_account_contents using the c(SONARR_API_KEY) env variable.

Examples

---
# fetch all qualities
- name: fetch all qualities
  devopsarr.sonarr.sonarr_quality_info:

# fetch a single quality
- name: fetch a single quality
  devopsarr.sonarr.sonarr_quality_info:
    name: SDTV

Return Values

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

Key

Description

qualities

list / elements=dictionary

A list of quality.

Returned: always

id

integer

Quality ID.

Returned: always

Sample: 1

max_size

float

Maximum size.

Returned: always

Sample: 130.0

min_size

float

Minimum size.

Returned: always

Sample: 1.0

preferred_size

float

Preferred size.

Returned: always

Sample: 95.0

quality

dictionary

Series folder format.

Returned: always

title

string

Title.

Returned: always

Sample: "WEBRip-480p"

Authors

  • Fuochi (@Fuochi)