devopsarr.lidarr.lidarr_release_profile module – Manages Lidarr release profile.

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

New in devopsarr.lidarr 1.0.0

Synopsis

  • Manages Lidarr release profile.

Parameters

Parameter

Comments

enabled

boolean

Enabled.

Choices:

  • false

  • true

ignored

list / elements=string

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

indexer_id

integer

Indexer ID. Set `0` for all.

Default: 0

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

required

list / elements=string

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

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 release profile
- name: Create a release profile
  devopsarr.lidarr.lidarr_release_profile:
    enabled: true
    required: ["proper"]
    ignored: ["repack"]
    indexer_id: 1
    tags: [1,2]

# Delete a release profile
- name: Delete a release_profile
  devopsarr.lidarr.lidarr_release_profile:
    enabled: true
    required: ["proper"]
    ignored: ["repack"]
    indexer_id: 1
    state: absent

Return Values

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

Key

Description

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)