devopsarr.sonarr.sonarr_root_folder (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 root folder.

Usage examples

Scanned by Steampunk Spotter

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

---
# Create a root folder
- name: Create a root folder
  devopsarr.sonarr.sonarr_root_folder:
    path: '/series'

Scanned by Steampunk Spotter

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

# Delete a root folder
- name: Delete a root_folder
  devopsarr.sonarr.sonarr_root_folder:
    path: '/series'
    state: absent

Inputs

    
path:
    description: Actual root folder.
    required: true
    type: str

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

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

accessible:
  description: Access flag.
  returned: on create/update
  sample: 'true'
  type: str
id:
  description: root folder ID.
  returned: always
  sample: '1'
  type: int
path:
  description: The root folder path.
  returned: on create/update
  sample: /series
  type: str
unmapped_folders:
  description: List of unmapped folders
  returned: always
  sample: '[]'
  type: dict