devopsarr.sonarr.sonarr_import_list_schema_info (1.1.1) — module

Get information about Sonarr import list schema.

| "added in version" 1.0.0 of devopsarr.sonarr"

Authors: Fuochi (@Fuochi)

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 import list schema.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
# Gather information about all import lists schema.
- name: Gather information about all import lists schema
  devopsarr.sonarr.sonarr_import_list_schema_info:
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Gather information about a single import list schema.
- name: Gather information about a single import list schema
  devopsarr.sonarr.sonarr_import_list_schema_info:
    name: PlexImport

Inputs

    
name:
    description: Name.
    type: str

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

import_lists:
  contains:
    config_contract:
      description: Config contract.
      returned: always
      sample: CustomSettings
      type: str
    enable_automatic_add:
      description: Enable automatic add flag.
      returned: always
      sample: false
      type: bool
    fields:
      description: field list.
      returned: always
      type: list
    id:
      description: import listID.
      returned: always
      sample: 1
      type: int
    implementation:
      description: Implementation.
      returned: always
      sample: CustomImport
      type: str
    name:
      description: Name.
      returned: always
      sample: Example
      type: str
    protocol:
      description: Protocol.
      returned: always
      sample: torrent
      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: /path
      type: str
    season_folder:
      description: Season folder flag.
      returned: always
      sample: false
      type: bool
    series_type:
      description: Series type.
      returned: always
      sample: standard
      type: str
    should_monitor:
      description: Should monitor.
      returned: always
      sample: unknown
      type: str
    tags:
      description: Tag list.
      elements: int
      returned: always
      sample:
      - 1
      - 2
      type: list
  description: A list of import list.
  elements: dict
  returned: always
  type: list