devopsarr.lidarr.lidarr_notification_schema_info (1.0.0) — module

Get information about Lidarr notification schema.

| "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 notification schema.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
# Gather information about all notifications schema.
- name: Gather information about all notifications schema
  devopsarr.lidarr.lidarr_notification_schema_info:
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Gather information about a single notification schema.
- name: Gather information about a single notification schema
  devopsarr.lidarr.lidarr_notification_schema_info:
    name: BroadcastheNet

Inputs

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

notifications:
  contains:
    config_contract:
      description: Config contract.
      returned: always
      sample: WebhookSettings
      type: str
    fields:
      description: field list.
      returned: always
      type: list
    id:
      description: notification ID.
      returned: always
      sample: 1
      type: int
    implementation:
      description: Implementation.
      returned: always
      sample: Webhook
      type: str
    name:
      description: Name.
      returned: always
      sample: Example
      type: str
    on_album_delete:
      description: On album delete flag.
      returned: always
      sample: true
      type: bool
    on_application_update:
      description: On application update flag.
      returned: always
      sample: true
      type: bool
    on_artist_delete:
      description: On artist delete flag.
      returned: always
      sample: true
      type: bool
    on_download_failure:
      description: On download failure flag.
      returned: always
      sample: false
      type: bool
    on_grab:
      description: On grab flag.
      returned: always
      sample: true
      type: bool
    on_health_issue:
      description: On health issue flag.
      returned: always
      sample: true
      type: bool
    on_health_restored:
      description: On health restored flag.
      returned: always
      sample: true
      type: bool
    on_import_failure:
      description: On import failure flag.
      returned: always
      sample: true
      type: bool
    on_release_import:
      description: On release import flag.
      returned: always
      sample: true
      type: bool
    on_rename:
      description: On rename flag.
      returned: always
      sample: true
      type: bool
    on_track_retag:
      description: On track retag flag.
      returned: always
      sample: true
      type: bool
    on_upgrade:
      description: On upgrade flag.
      returned: always
      sample: true
      type: bool
    tags:
      description: Tag list.
      elements: int
      returned: always
      sample:
      - 1
      - 2
      type: list
  description: A list of notifications schema.
  elements: dict
  returned: always
  type: list