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

Usage examples

Scanned by Steampunk Spotter

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

---
# Gather information about all root folders.
- name: Gather information about all root folders
  devopsarr.sonarr.sonarr_root_folder_info:

Scanned by Steampunk Spotter

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

# Gather information about a single root folder.
- name: Gather information about a single root folder
  devopsarr.sonarr.sonarr_root_folder_info:
    name: test

Inputs

    
path:
    description: Actual root folder.
    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

root_folders:
  contains:
    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
  description: A list of root folders.
  elements: dict
  returned: always
  type: list