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

Get information about Sonarr series.

Usage examples

Scanned by Steampunk Spotter

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

---
# Gather information about all series.
- name: Gather information about all series
  devopsarr.sonarr.sonarr_series_info:

Scanned by Steampunk Spotter

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

# Gather information about a single series.
- name: Gather information about a single series
  devopsarr.sonarr.sonarr_series_info:
    tvdb_id: 12345678

Inputs

    
tvdb_id:
    description: TVDB ID.
    type: int

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

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

Outputs

series_list:
  contains:
    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
  description: A list of series.
  elements: dict
  returned: always
  type: list