devopsarr.sonarr.sonarr_quality_profile_info module – Get information about Sonarr quality profile.

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

New in devopsarr.sonarr 0.5.0

Synopsis

  • Get information about Sonarr quality profile.

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

---
# Gather information about all quality profiles.
- name: Gather information about all quality profiles
  devopsarr.sonarr.sonarr_quality_profile_info:

# Gather information about a single quality profile.
- name: Gather information about a single quality profile
  devopsarr.sonarr.sonarr_quality_profile_info:
    name: test

Return Values

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

Key

Description

quality_profiles

list / elements=dictionary

A list of quality profiles.

Returned: always

cutoff

integer

Quality ID to which cutoff.

Returned: always

Sample: 1

cutoff_format_score

integer

Cutoff format score.

Returned: always

Sample: 0

formats

list / elements=dictionary

Format items list.

Returned: always

Sample: []

id

integer

Quality Profile ID.

Returned: always

Sample: 1

min_format_score

integer

Min format score.

Returned: always

Sample: 0

name

string

Name.

Returned: always

Sample: "Example"

quality_groups

list / elements=dictionary

Quality groups

Returned: always

Sample: []

upgrade_allowed

boolean

Upgrade allowed flag.

Returned: always

Sample: false

Authors

  • Fuochi (@Fuochi)