devopsarr.lidarr.lidarr_remote_path_mapping module – Manages Lidarr remote path mapping.

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

New in devopsarr.lidarr 1.0.0

Synopsis

  • Manages Lidarr remote path mapping.

Parameters

Parameter

Comments

host

string / required

Download Client host.

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

local_path

string / required

Local path.

remote_path

string / required

Download Client remote path.

state

string

Create or delete resource.

Choices:

  • "present" ← (default)

  • "absent"

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 remote path mapping
- name: Create a remote path mapping
  devopsarr.lidarr.remote_path_mapping:
    host: 'transmission-host'
    remote_path: '/download/complete/'
    local_path: '/music-download/'


# Delete a remote path mapping
- name: Delete a remote_path_mapping
  devopsarr.lidarr.remote_path_mapping:
    host: 'transmission-host'
    remote_path: '/download/complete/'
    local_path: '/music-download/'
    state: absent

Return Values

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

Key

Description

host

string

Download Client host.

Returned: always

Sample: "transmission-host"

id

integer

remote path mapping ID.

Returned: always

Sample: 1

local_path

string

Local remote path.

Returned: always

Sample: "/music-download/"

remote_path

string

Download Client remote path.

Returned: always

Sample: "/download/complete/"

Authors

  • Fuochi (@Fuochi)