devopsarr.lidarr.lidarr_artist (1.0.0) — module

Manages lidarr Artist.

| "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

Manages lidarr Artist.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
# Create a artist
- name: Create a artist
  devopsarr.lidarr.lidarr_artist:
    artist_name: "Queen"
    foreign_artist_id: "0383dadf-2a4e-4d10-a46a-e9e041da8eb3"
    monitored: true
    path: "/config/queen"
    quality_profile_id: 1
    metadata_profile_id: 1
    tags: [1,2]
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Delete a artist
- name: Delete a artist
  devopsarr.lidarr.lidarr_artist:
    artist_name: "Queen"
    foreign_artist_id: "0383dadf-2a4e-4d10-a46a-e9e041da8eb3"
    path: "/config/queen"
    state: absent

Inputs

    
path:
    description: Artist path.
    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

monitored:
    default: false
    description: Monitored flag.
    type: bool

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

artist_name:
    description: Artist name.
    required: true
    type: str

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

foreign_artist_id:
    description: Foreign artist ID.
    required: true
    type: str

quality_profile_id:
    description: Quality profile ID.
    type: int

metadata_profile_id:
    description: Metadata profile ID.
    type: int

Outputs

artist_name:
  description: Artist name.
  returned: always
  sample: Artist name
  type: str
foreign_artist_id:
  description: Foreign artist ID.
  returned: always
  sample: 0383dadf-2a4e-4d10-a46a-e9e041da8eb3
  type: str
id:
  description: artist ID.
  returned: always
  sample: 1
  type: int
metadata_profile_id:
  description: Metadata profile ID.
  returned: always
  sample: 1
  type: int
monitored:
  description: Monitored flag.
  returned: always
  sample: false
  type: bool
path:
  description: Artist path.
  returned: always
  sample: /artist/artist_artist_name
  type: str
quality_profile_id:
  description: Quality profile ID.
  returned: always
  sample: 1
  type: int
tags:
  description: Tag list.
  elements: int
  returned: always
  sample:
  - 1
  - 2
  type: list