devopsarr.sonarr.sonarr_remote_path_mapping_info (1.1.1) — module

Install collection

Install with ansible-galaxy collection install devopsarr.sonarr:==1.1.1

Add to requirements.yml

  collections:
    - name: devopsarr.sonarr
      version: 1.1.1

Description

Get information about Sonarr remote path mapping.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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

Inputs

    
id:
    description: Remote path mapping id.
    type: int

sonarr_url:
    description: Full Sonarr URL with protocol and port (e.g. `https://test.sonarr.tv:8989`)
    required: true
    type: str

sonarr_api_key:
    description: API key for Sonarr authentication.
    required: true
    type: str

Outputs

remote_path_mappings:
  contains:
    host:
      description: Download Client host.
      returned: always
      sample: transmission-host
      type: str
    id:
      description: remote path mapping ID.
      returned: always
      sample: '1'
      type: int
    local_path:
      description: Local remote path.
      returned: always
      sample: /series-download/
      type: str
    remote_path:
      description: Download Client remote path.
      returned: always
      sample: /download/complete/
      type: str
  description: A list of remote path mappings.
  elements: dict
  returned: always
  type: list