devopsarr.sonarr.sonarr_series (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 series.

Usage examples

Scanned by Steampunk Spotter

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

---
# Create a series
- name: Create a series
  devopsarr.sonarr.sonarr_series:
    title: "Breaking Bad"
    title_slug: "breaking-bad"
    tvdb_id: 81189
    monitored: false
    season_folder: true
    use_scene_numbering: false
    path: "/config/breaking-bad"
    root_folder_path: "/config"
    quality_profile_id: 1
    tags: [1,2]

Scanned by Steampunk Spotter

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

# Delete a series
- name: Delete a series
  devopsarr.sonarr.sonarr_series:
    title: "Breaking Bad"
    title_slug: "breaking-bad"
    tvdb_id: 81189
    state: absent

Inputs

    
path:
    description: Series path.
    required: true
    type: str

tags:
    default: []
    description: Tag list.
    elements: int
    type: list

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

title:
    description: Series title.
    required: true
    type: str

tvdb_id:
    description: TVDB ID.
    required: true
    type: int

monitored:
    default: false
    description: Monitored flag.
    type: bool

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

title_slug:
    description: Series title in kebab case.
    required: true
    type: str

season_folder:
    default: false
    description: Season folder flag.
    type: bool

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

root_folder_path:
    description: Root folder path.
    type: str

quality_profile_id:
    description: Quality profile ID.
    type: int

use_scene_numbering:
    default: false
    description: Use scene numbering flag.
    type: bool

Outputs

id:
  description: series ID.
  returned: always
  sample: 1
  type: int
monitored:
  description: Monitored flag.
  returned: always
  sample: false
  type: bool
path:
  description: Series path.
  returned: always
  sample: /series/series_title
  type: str
quality_profile_id:
  description: Quality profile ID.
  returned: always
  sample: 1
  type: int
root_folder_path:
  description: Root folder path.
  returned: always
  sample: /series
  type: str
season_folder:
  description: Season folder flag.
  returned: always
  sample: false
  type: bool
tags:
  description: Tag list.
  elements: int
  returned: always
  sample:
  - 1
  - 2
  type: list
title:
  description: Series title.
  returned: always
  sample: Series Title
  type: str
title_slug:
  description: Series title in kebab case.
  returned: always
  sample: series-title
  type: str
tvdb_id:
  description: TVDB ID.
  returned: always
  sample: 12345678
  type: int
use_scene_numbering:
  description: Use scene numbering flag.
  returned: always
  sample: false
  type: bool