devopsarr.sonarr.sonarr_quality_profile module – Manages 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.

New in devopsarr.sonarr 0.5.0

Synopsis 

Manages Sonarr quality profile.

Parameters 

Parameter	Comments
cutoff integer	Quality ID to which cutoff.
cutoff_format_score integer	Cutoff format score. Default: `0`
formats list / elements=dictionary	Format items list. Define only the used custom formats. Default: `[]`
id integer	Format ID.
name string	Format name.
score integer	Format score.
min_format_score integer	Min format score. Default: `0`
min_upgrade_format_score integer	Min upgrade format score. Default: `1`
name string / required	Name.
quality_groups list / elements=dictionary	Quality groups ordered list. Define only the allowed groups. Default: `[]`
allowed boolean	Quality group allowed flag, if omitted it will default to `true`. Choices: `false` `true`
id integer	Quality group ID.
name string	Quality group name.
qualities list / elements=dictionary	Quality list.
id integer	Quality ID.
name string	Quality name.
resolution string	Quality resolution.
source string	Quality source.
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`)
state string	Create or delete resource. Choices: `"present"` ← (default) `"absent"`
upgrade_allowed boolean	Upgrade allowed flag. Choices: `false` ← (default) `true`

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 

---
# Create a quality profile
- name: Create a quality profile
  devopsarr.sonarr.sonarr_quality_profile:
    name: "Example"
    upgrade_allowed: true
    cutoff: 1
    min_format_score: 0
    min_upgrade_format_score: 1
    cutoff_format_score: 0
    quality_groups:
      - qualities:
        - id: 1
          name: "SDTV"
          source: "television"
          resolution: 480
      - name: "WEB 720p"
        id: 1001
        qualities:
          - id: 14
            name: "WEBRip-720p"
            source: "webRip"
            resolution: 720
          - id: 5
            name: "WEBDL-720p"
            source: "web"
            resolution: 720
    formats: []

# Delete a quality profile
- name: Delete a quality_profile
  devopsarr.sonarr.sonarr_quality_profile:
    name: Example
    state: absent

Return Values 

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

Key	Description
cutoff integer	Quality ID to which cutoff. Returned: always Sample: `1`
cutoff_format_score integer	Cutoff format score. Returned: always Sample: `0`
format_items list / elements=dictionary	Format items list. Returned: always Sample: `[]`
id integer	Quality Profile ID. Returned: always Sample: `1`
items list / elements=dictionary	Quality groups Returned: always Sample: `[]`
min_format_score integer	Min format score. Returned: always Sample: `0`
name string	Name. Returned: always Sample: `"Example"`
upgrade_allowed boolean	Upgrade allowed flag. Returned: always Sample: `false`

Authors

Fuochi (@Fuochi)

devopsarr.sonarr.sonarr_quality_profile module – Manages Sonarr quality profile.

Synopsis

Parameters

Notes

Examples

Return Values