devopsarr.lidarr.lidarr_auto_tag module – Manages Lidarr auto tag.

Note

This module is part of the devopsarr.lidarr collection (version 1.0.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.lidarr.

To use it in a playbook, specify: devopsarr.lidarr.lidarr_auto_tag.

New in devopsarr.lidarr 1.0.0

Synopsis

  • Manages Lidarr auto tag.

Parameters

Parameter

Comments

lidarr_api_key

string / required

API key for Lidarr authentication.

lidarr_url

string / required

Full Lidarr URL with protocol and port (e.g. `https://test.lidarr.tv:8686`)

name

string / required

Name.

remove_tags_automatically

boolean

Remove tags automatically flag.

Choices:

  • false

  • true

specifications

list / elements=dictionary

Specification list.

fields

list / elements=dictionary

Configuration field list.

name

string

Field name.

value

any

Field value.

implementation

string

Implementation.

name

string

Specification name.

negate

boolean

Negate flag.

Choices:

  • false

  • true

required

boolean

Required flag.

Choices:

  • false

  • true

state

string

Create or delete resource.

Choices:

  • "present" ← (default)

  • "absent"

tags

list / elements=integer

Tag list.

Default: []

Notes

Note

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

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

Examples

---
# Create a auto tag
- name: Create a auto tag
  devopsarr.lidarr.lidarr_auto_tag:
    remove_tags_automatically: false
    name: "Type"
    tags: [1]
    specifications:
    - name: "anime"
      implementation: "MusicTypeSpecification"
      negate: false
      required: true
      fields:
      - name: "value"
        value: 2

# Delete a auto tag
- name: Delete a auto tag
  devopsarr.lidarr.lidarr_auto_tag:
    name: Example
    state: absent

Return Values

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

Key

Description

id

integer

auto tagID.

Returned: always

Sample: 1

name

string

Name.

Returned: always

Sample: "Example"

remove_tags_automatically

boolean

Remove tags automatically flag.

Returned: always

Sample: false

specifications

list / elements=string

specification list.

Returned: always

tags

list / elements=integer

Tag list.

Returned: always

Sample: [1, 2]

Authors

  • Fuochi (@Fuochi)