devopsarr.sonarr.sonarr_remote_path_mapping (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

Manages Sonarr remote path mapping.

Usage examples

Scanned by Steampunk Spotter

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

---
# Create a remote path mapping
- name: Create a remote path mapping
  devopsarr.sonarr.sonarr_remote_path_mapping:
    host: 'transmission-host'
    remote_path: '/download/complete/'
    local_path: '/series-download/'

Scanned by Steampunk Spotter

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

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

Inputs

    
host:
    description: Download Client host.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description: Create or delete resource.
    required: false
    type: str

local_path:
    description: Local path.
    required: true
    type: str

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

remote_path:
    description: Download Client remote path.
    required: true
    type: str

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

Outputs

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