devopsarr.whisparr.whisparr_remote_path_mapping module – Manages Whisparr remote path mapping.

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

New in devopsarr.whisparr 0.0.1

Synopsis

  • Manages Whisparr remote path mapping.

Parameters

Parameter

Comments

host

string / required

Download Client host.

local_path

string / required

Local path.

remote_path

string / required

Download Client remote path.

state

string

Create or delete a remote_path_mapping.

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


# Delete a remote path mapping
- name: Delete a remote_path_mapping
  devopsarr.whisparr.remote_path_mapping:
    host: 'transmission-host'
    remote_path: '/download/complete/'
    local_path: '/series-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: "/series-download/"

remote_path

string

Download Client remote path.

Returned: always

Sample: "/download/complete/"

Authors

  • Fuochi (@Fuochi)