devopsarr.sonarr.sonarr_release_profile_info module – Get information about Sonarr release profile.

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_release_profile_info.

New in devopsarr.sonarr 0.0.3

Synopsis

  • Get information about Sonarr release profile.

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 release profiles.
- name: Gather information about all release profiles
  devopsarr.sonarr.sonarr_release_profile_info:

# Gather information about a single release profile.
- name: Gather information about a single release profile
  devopsarr.sonarr.sonarr_release_profile_info:
    name: test

Return Values

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

Key

Description

release_profiles

list / elements=dictionary

A list of release profiles.

Returned: always

enabled

boolean

Enabled.

Returned: always

Sample: true

id

integer

Release Profile ID.

Returned: always

Sample: 1

ignored

list / elements=string

Ignored terms. At least one of `required` and `ignored` must be set.

Returned: always

Sample: ["proper", "repack"]

indexer_id

integer

Indexer ID. Set `0` for all.”

Returned: always

Sample: 1

required

list / elements=string

Required terms. At least one of `required` and `ignored` must be set.

Returned: always

Sample: ["proper", "repack"]

tags

list / elements=integer

Tag list.

Returned: always

Sample: [1, 2]

Authors

  • Fuochi (@Fuochi)