devopsarr.lidarr.lidarr_root_folder (1.0.0) — module

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

Manages Lidarr 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.lidarr.root_folder:
    name: 'Music'
    path: '/music'
    new_item_monitor_option: 'all'
    monitor_option: 'all'
    metadata_profile_id: 1
    quality_profile_id: 1

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.lidarr.root_folder:
    name: 'Music'
    path: '/music'
    new_item_monitor_option: 'all'
    monitor_option: 'all'
    metadata_profile_id: 1
    quality_profile_id: 1
    state: absent

Inputs

    
name:
    description: Root folder friendly name.
    required: true
    type: str

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

tags:
    default: []
    description: Tag list.
    elements: int
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description: Create or delete resource.
    required: false
    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

monitor_option:
    choices:
    - all
    - future
    - missing
    - existing
    - latest
    - first
    - none
    - unknown
    description: Monitor option.
    required: true
    type: str

quality_profile_id:
    description: Metadata profile ID.
    required: true
    type: int

metadata_profile_id:
    description: Metadata profile ID.
    required: true
    type: int

new_item_monitor_option:
    choices:
    - all
    - none
    - new
    description: New item monitor option.
    required: true
    type: str

Outputs

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