devopsarr.sonarr.sonarr_import_list_exclusion module – Manages Sonarr import list exclusion.

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

New in devopsarr.sonarr 0.7.0

Synopsis

  • Manages Sonarr import list exclusion.

Parameters

Parameter

Comments

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`)

state

string

Create or delete resource.

Choices:

  • "present" ← (default)

  • "absent"

title

string / required

Title.

tvdb_id

integer / required

TVDB ID.

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

---
# Create a import list exclusion
- name: Create a import list exclusion
  devopsarr.sonarr.sonarr_import_list_exclusion:
    tvdb_id: 123
    title: 'example'


# Delete a import list exclusion
- name: Delete a import_list_exclusion
  devopsarr.sonarr.sonarr_import_list_exclusion:
    tvdb_id: 123
    title: 'example'
    state: absent

Return Values

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

Key

Description

id

integer

import list exclusion ID.

Returned: always

Sample: 1

title

string

Title.

Returned: always

Sample: "Breaking Bad"

tvdb_id

integer

TVDB ID.

Returned: always

Sample: 12345

Authors

  • Fuochi (@Fuochi)