devopsarr.lidarr.lidarr_import_list (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 import list.

Usage examples

Scanned by Steampunk Spotter

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

---
# Create a import list
- name: Create a import list
  devopsarr.lidarr.lidarr_import_list:
    enable_automatic_add: false
    should_monitor_existing: true
    should_monitor: "entireArtist"
    quality_profile_id: 1
    metadata_profile_id: 1
    list_order: 1
    monitor_new_items: "all"
    should_search: false
    fields:
    - name: "apiKey"
      value: "Key"
    - name: "baseUrl"
      value: "localhost"
    - name: "profileIds"
      value: [1]
    - name: "rootFolderPaths"
      value: ["/tmp"]
    name: "LidarrImport"
    list_type: "standard"
    root_folder_path: "/tmp"
    config_contract: "LidarrSettings"
    implementation: "LidarrImport"
    tags: []

Scanned by Steampunk Spotter

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

# Delete a import list
- name: Delete a import list
  devopsarr.lidarr.lidarr_import_list:
    name: Example
    state: absent

Inputs

    
name:
    description: Name.
    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

fields:
    description: Configuration field list.
    elements: dict
    suboptions:
      name:
        description: Field name.
        type: str
      value:
        description: Field value.
        type: raw
    type: list

list_type:
    description: List type.
    type: str

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

list_order:
    description: List order.
    type: int

should_search:
    description: Search on add flag.
    type: bool

implementation:
    description: Implementation.
    type: str

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

should_monitor:
    choices:
    - none
    - specificAlbum
    - entireArtist
    description: Should monitor.
    type: str

update_secrets:
    default: false
    description: Flag to force update of secret fields.
    type: bool

config_contract:
    description: Config contract.
    type: str

root_folder_path:
    description: Root folder.
    type: str

monitor_new_items:
    choices:
    - none
    - new
    - all
    description: Monitor new items.
    type: str

quality_profile_id:
    description: Quality profile ID.
    type: int

metadata_profile_id:
    description: Metadata profile ID.
    type: int

enable_automatic_add:
    description: Enable automatic add flag.
    type: bool

should_monitor_existing:
    description: Should monitor existing flag.
    type: bool

Outputs

config_contract:
  description: Config contract.
  returned: always
  sample: CustomSettings
  type: str
enable_automatic_add:
  description: Enable automatic add flag.
  returned: always
  sample: false
  type: bool
fields:
  description: field list.
  returned: always
  type: list
id:
  description: import listID.
  returned: always
  sample: 1
  type: int
implementation:
  description: Implementation.
  returned: always
  sample: CustomImport
  type: str
list_order:
  description: List order.
  returned: always
  sample: 1
  type: int
list_type:
  description: List type.
  returned: always
  sample: standard
  type: str
metadata_profile_id:
  description: Metadata profile ID.
  returned: always
  sample: 1
  type: int
monitor_new_items:
  description: Monitor new items.
  returned: always
  sample: all
  type: str
name:
  description: Name.
  returned: always
  sample: Example
  type: str
protocol:
  description: Protocol.
  returned: always
  sample: torrent
  type: str
quality_profile_id:
  description: Quality profile ID.
  returned: always
  sample: 1
  type: int
root_folder_path:
  description: Root folder.
  returned: always
  sample: /tmp
  type: str
should_monitor:
  description: Should monitor.
  returned: always
  sample: none
  type: str
should_monitor_existing:
  description: Should monitor existing flag.
  returned: always
  sample: false
  type: bool
should_search:
  description: Search on add flag.
  returned: always
  sample: false
  type: bool
tags:
  description: Tag list.
  elements: int
  returned: always
  sample:
  - 1
  - 2
  type: list