devopsarr.sonarr.sonarr_metadata_info (1.1.1) — module

Get information about Sonarr metadata.

| "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 metadata.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
# Gather information about all metadatas.
- name: Gather information about all metadatas
  devopsarr.sonarr.sonarr_metadata_info:
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Gather information about a single metadata.
- name: Gather information about a single metadata
  devopsarr.sonarr.sonarr_metadata_info:
    name: test

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

metadatas:
  contains:
    config_contract:
      description: Config contract.
      returned: always
      sample: WebhookSettings
      type: str
    enable:
      description: On grab flag.
      returned: always
      sample: true
      type: bool
    fields:
      description: field list.
      returned: always
      type: list
    id:
      description: metadata ID.
      returned: always
      sample: 1
      type: int
    implementation:
      description: Implementation.
      returned: always
      sample: Webhook
      type: str
    name:
      description: Name.
      returned: always
      sample: Example
      type: str
    tags:
      description: Tag list.
      elements: int
      returned: always
      sample:
      - 1
      - 2
      type: list
  description: A list of metadatas.
  elements: dict
  returned: always
  type: list