devopsarr.sonarr.sonarr_metadata_info module – Get information about Sonarr metadata.

Note

This module is part of the devopsarr.sonarr collection (version 1.3.1).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install devopsarr.sonarr.

To use it in a playbook, specify: devopsarr.sonarr.sonarr_metadata_info.

New in devopsarr.sonarr 1.0.0

Synopsis

  • Get information about Sonarr metadata.

Parameters

Parameter

Comments

name

string

Name.

sonarr_api_key

string / required

API key for Sonarr authentication.

sonarr_url

string / required

Full Sonarr URL with protocol and port (e.g. `https://test.sonarr.tv:8989`)

Notes

Note

  • for authentication, you can set service_account_file using the c(SONARR_URL) env variable.

  • for authentication, you can set service_account_contents using the c(SONARR_API_KEY) env variable.

Examples

---
# Gather information about all metadatas.
- name: Gather information about all metadatas
  devopsarr.sonarr.sonarr_metadata_info:

# Gather information about a single metadata.
- name: Gather information about a single metadata
  devopsarr.sonarr.sonarr_metadata_info:
    name: test

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

metadatas

list / elements=dictionary

A list of metadatas.

Returned: always

config_contract

string

Config contract.

Returned: always

Sample: "WebhookSettings"

enable

boolean

On grab flag.

Returned: always

Sample: true

fields

list / elements=string

field list.

Returned: always

id

integer

metadata ID.

Returned: always

Sample: 1

implementation

string

Implementation.

Returned: always

Sample: "Webhook"

name

string

Name.

Returned: always

Sample: "Example"

tags

list / elements=integer

Tag list.

Returned: always

Sample: [1, 2]

Authors

  • Fuochi (@Fuochi)