devopsarr.whisparr.whisparr_tag module – Manages Whisparr tag.

Note

This module is part of the devopsarr.whisparr collection (version 0.1.0).

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

To use it in a playbook, specify: devopsarr.whisparr.whisparr_tag.

New in devopsarr.whisparr 0.0.1

Synopsis

  • Manages Whisparr tag.

Parameters

Parameter

Comments

label

string / required

Actual tag.

state

string

Create or delete a tag.

Choices:

  • "present" ← (default)

  • "absent"

whisparr_api_key

string / required

API key for Whisparr authentication.

whisparr_url

string / required

Full Whisparr URL with protocol and port (e.g. `https://test.whisparr.tv:7878`)

Notes

Note

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

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

Examples

# Create a tag
- name: Create a tag
  devopsarr.whisparr.tag:
    label: default

# Delete a tag
- name: Delete a tag
  devopsarr.whisparr.tag:
    label: wrong
    state: absent

Return Values

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

Key

Description

id

integer

Tag ID.

Returned: always

Sample: 1

label

string

The output message that the test module generates.

Returned: on create/update

Sample: "hd"

Authors

  • Fuochi (@Fuochi)