/ home / devopsarr / devopsarr.lidarr / 1.0.0 / module / lidarr_root_folder_info

devopsarr.lidarr.lidarr_root_folder_info (1.0.0) — module

Get information about Lidarr root folder.

| "added in version" 1.0.0 of devopsarr.lidarr"

Authors: Fuochi (@Fuochi)

Install collection

Install with ansible-galaxy collection install devopsarr.lidarr:==1.0.0

Add to requirements.yml

  collections:
    - name: devopsarr.lidarr
      version: 1.0.0

Description

Get information about Lidarr root folder.

Usage examples

Scanned by Steampunk Spotter

---
# Gather information about all root folders.
- name: Gather information about all root folders
  devopsarr.lidarr.lidarr_root_folder_info:

Scanned by Steampunk Spotter

# Gather information about a single root folder.
- name: Gather information about a single root folder
  devopsarr.lidarr.lidarr_root_folder_info:
    name: test

Inputs

    
path:
    description: Actual root folder.
    type: str

lidarr_url:
    description: Full Lidarr URL with protocol and port (e.g. `https://test.lidarr.tv:8686`)
    required: true
    type: str

lidarr_api_key:
    description: API key for Lidarr authentication.
    required: true
    type: str

Outputs

root_folders:
  contains:
    accessible:
      description: Access flag.
      returned: on create/update
      sample: 'true'
      type: str
    default_metadata_profile_id:
      description: Metadata profile ID.
      returned: always
      sample: 1
      type: int
    default_monitor_option:
      description: Monitor option.
      returned: always
      sample: all
      type: str
    default_new_item_monitor_option:
      description: New item monitor option.
      returned: always
      sample: all
      type: str
    default_quality_profile_id:
      description: Metadata profile ID.
      returned: always
      sample: 1
      type: int
    id:
      description: root folder ID.
      returned: always
      sample: '1'
      type: int
    name:
      description: Root folder friendly name.
      returned: always
      sample: Name
      type: str
    path:
      description: The root folder path.
      returned: on create/update
      sample: /music
      type: str
    tags:
      description: Tag list.
      elements: int
      returned: always
      sample:
      - 1
      - 2
      type: list
  description: A list of root folders.
  elements: dict
  returned: always
  type: list