devopsarr.sonarr.sonarr_quality_profile (1.1.1) — module

Install collection

Install with ansible-galaxy collection install devopsarr.sonarr:==1.1.1

Add to requirements.yml

  collections:
    - name: devopsarr.sonarr
      version: 1.1.1

Description

Manages Sonarr quality profile.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
# 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
    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: []

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
name:
    description: Name.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description: Create or delete resource.
    required: false
    type: str

cutoff:
    description: Quality ID to which cutoff.
    type: int

formats:
    default: []
    description: Format items list. Define only the used custom formats.
    elements: dict
    suboptions:
      id:
        description: Format ID.
        type: int
      name:
        description: Format name.
        type: str
      score:
        description: Format score.
        type: int
    type: list

sonarr_url:
    description: Full Sonarr URL with protocol and port (e.g. `https://test.sonarr.tv:8989`)
    required: true
    type: str

quality_groups:
    default: []
    description: Quality groups ordered list. Define only the allowed groups.
    elements: dict
    suboptions:
      id:
        description: Quality group ID.
        type: int
      name:
        description: Quality group name.
        type: str
      qualities:
        description: Quality list.
        elements: dict
        suboptions:
          id:
            description: Quality ID.
            type: int
          name:
            description: Quality name.
            type: str
          resolution:
            description: Quality resolution.
            type: str
          source:
            description: Quality source.
            type: str
        type: list
    type: list

sonarr_api_key:
    description: API key for Sonarr authentication.
    required: true
    type: str

upgrade_allowed:
    default: false
    description: Upgrade allowed flag.
    type: bool

min_format_score:
    default: 0
    description: Min format score.
    type: int

cutoff_format_score:
    default: 0
    description: Cutoff format score.
    type: int

Outputs

cutoff:
  description: Quality ID to which cutoff.
  returned: always
  sample: 1
  type: int
cutoff_format_score:
  description: Cutoff format score.
  returned: always
  sample: 0
  type: int
format_items:
  description: Format items list.
  elements: dict
  returned: always
  sample: []
  type: list
id:
  description: Quality Profile ID.
  returned: always
  sample: 1
  type: int
items:
  description: Quality groups
  elements: dict
  returned: always
  sample: []
  type: list
min_format_score:
  description: Min format score.
  returned: always
  sample: 0
  type: int
name:
  description: Name.
  returned: always
  sample: Example
  type: str
upgrade_allowed:
  description: Upgrade allowed flag.
  returned: always
  sample: false
  type: bool