devopsarr.sonarr.sonarr_download_client_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 download client.

Usage examples

Scanned by Steampunk Spotter

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

---
# Gather information about all download clients.
- name: Gather information about all download clients
  devopsarr.sonarr.sonarr_download_client_info:

Scanned by Steampunk Spotter

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

# Gather information about a single download client.
- name: Gather information about a single download client
  devopsarr.sonarr.sonarr_download_client_info:
    name: Example

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

download_clients:
  contains:
    config_contract:
      description: Config contract.
      returned: always
      sample: BroadcastheNetSettings
      type: str
    enable:
      description: Enable flag.
      returned: always
      sample: true
      type: bool
    fields:
      description: field list.
      returned: always
      type: list
    id:
      description: download clientID.
      returned: always
      sample: 1
      type: int
    implementation:
      description: Implementation.
      returned: always
      sample: BroadcastheNet
      type: str
    name:
      description: Name.
      returned: always
      sample: Example
      type: str
    priority:
      description: Priority.
      returned: always
      sample: 1
      type: int
    protocol:
      description: Protocol.
      returned: always
      sample: torrent
      type: str
    remove_completed_downloads:
      description: Remove completed downloads flag.
      returned: always
      sample: true
      type: bool
    remove_failed_downloads:
      description: Remove failed downloads flag.
      returned: always
      sample: false
      type: bool
    tags:
      description: Tag list.
      elements: int
      returned: always
      sample:
      - 1
      - 2
      type: list
  description: A list of download client.
  elements: dict
  returned: always
  type: list