devopsarr.lidarr.lidarr_import_list_info (1.0.0) — module

Get information about Lidarr import list.

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

Authors: Fuochi (@Fuochi)

Install collection

Install with ansible-galaxy collection install devopsarr.lidarr:==1.0.0


Add to requirements.yml

  collections:
    - name: devopsarr.lidarr
      version: 1.0.0

Description

Get information about Lidarr import list.

Usage examples

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

Inputs

    
name:
    description: Name.
    type: str

lidarr_url:
    description: Full Lidarr URL with protocol and port (e.g. `https://test.lidarr.tv:8686`)
    required: true
    type: str

lidarr_api_key:
    description: API key for Lidarr 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
    list_order:
      description: List order.
      returned: always
      sample: 1
      type: int
    list_type:
      description: List type.
      returned: always
      sample: standard
      type: str
    metadata_profile_id:
      description: Metadata profile ID.
      returned: always
      sample: 1
      type: int
    monitor_new_items:
      description: Monitor new items.
      returned: always
      sample: all
      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.
      returned: always
      sample: /tmp
      type: str
    should_monitor:
      description: Should monitor.
      returned: always
      sample: none
      type: str
    should_monitor_existing:
      description: Should monitor existing flag.
      returned: always
      sample: false
      type: bool
    should_search:
      description: Search on add flag.
      returned: always
      sample: false
      type: bool
    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