devopsarr.lidarr.lidarr_indexer module – Manages Lidarr indexer.

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

New in devopsarr.lidarr 1.0.0

Synopsis

  • Manages Lidarr indexer.

Parameters

Parameter

Comments

config_contract

string

Config contract.

download_client_id

integer

Download client ID.

Default: 0

boolean

Enable automatic search flag.

Choices:

  • false

  • true

boolean

Enable interactive search flag.

Choices:

  • false

  • true

enable_rss

boolean

Enable RSS flag.

Choices:

  • false

  • true

fields

list / elements=dictionary

Configuration field list.

name

string

Field name.

value

any

Field value.

implementation

string

Implementation.

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.

priority

integer

Priority.

protocol

string

Protocol.

Choices:

  • "torrent"

  • "usenet"

state

string

Create or delete resource.

Choices:

  • "present" ← (default)

  • "absent"

tags

list / elements=integer

Tag list.

Default: []

update_secrets

boolean

Flag to force update of secret fields.

Choices:

  • false ← (default)

  • true

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 indexer
- name: Create a indexer
  devopsarr.lidarr.lidarr_indexer:
    name: "Example"
    enable_automatic_search: false
    enable_interactive_search: false
    enable_rss: false
    priority: 10
    config_contract: "NewznabSettings"
    implementation: "Newznab"
    protocol: "usenet"
    fields:
    - name: "baseUrl"
      value: "https://lolo.sickbeard.com"
    - name: "apiPath"
      value: "/api"
    - name: "categories"
      value: [8000, 5000]
    tags: [1,2]

# Delete a indexer
- name: Delete a indexer
  devopsarr.lidarr.lidarr_indexer:
    name: Example
    state: absent

Return Values

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

Key

Description

config_contract

string

Config contract.

Returned: always

Sample: "NewznabSettings"

download_client_id

integer

Download client ID.

Returned: always

Sample: 0

boolean

Enable automatic search flag.

Returned: always

Sample: true

boolean

Enable interactive search flag.

Returned: always

Sample: false

enable_rss

boolean

Enable RSS flag.

Returned: always

Sample: true

fields

list / elements=string

field list.

Returned: always

id

integer

indexer ID.

Returned: always

Sample: 1

implementation

string

Implementation.

Returned: always

Sample: "Newznab"

name

string

Name.

Returned: always

Sample: "Example"

priority

integer

Priority.

Returned: always

Sample: 1

protocol

string

Protocol.

Returned: always

Sample: "torrent"

tags

list / elements=integer

Tag list.

Returned: always

Sample: [1, 2]

Authors

  • Fuochi (@Fuochi)