devopsarr.sonarr.sonarr_remote_path_mapping_info module – Get information about Sonarr remote path mapping.

Note

This module is part of the devopsarr.sonarr collection (version 1.3.1).

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

To use it in a playbook, specify: devopsarr.sonarr.sonarr_remote_path_mapping_info.

New in devopsarr.sonarr 0.5.0

Synopsis

  • Get information about Sonarr remote path mapping.

Parameters

Parameter

Comments

id

integer

Remote path mapping id.

sonarr_api_key

string / required

API key for Sonarr authentication.

sonarr_url

string / required

Full Sonarr URL with protocol and port (e.g. `https://test.sonarr.tv:8989`)

Notes

Note

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

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

Examples

---
# Gather information about all remote path mappings.
- name: Gather information about all remote path mappings
  devopsarr.sonarr.sonarr_remote_path_mapping_info:

# Gather information about a single remote path mapping.
- name: Gather information about a single remote path mapping
  devopsarr.sonarr.sonarr_remote_path_mapping_info:
    id: 1

Return Values

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

Key

Description

remote_path_mappings

list / elements=dictionary

A list of remote path mappings.

Returned: always

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)