devopsarr.sonarr.sonarr_notification (1.1.1) — module

Install collection

Install with ansible-galaxy collection install devopsarr.sonarr:==1.1.1

Add to requirements.yml

  collections:
    - name: devopsarr.sonarr
      version: 1.1.1

Description

Manages Sonarr notification.

Usage examples

Scanned by Steampunk Spotter

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

---
# Create a notification
- name: Create a notification
  devopsarr.sonarr.sonarr_notification:
    name: "Example"
    on_grab: true
    config_contract: "WebhookSettings"
    implementation: "Webhook"
    fields:
    - name: "username"
      value: "User"
    - name: "password"
      value: "test"
    - name: "url"
      value: "webhook.lcl"
    - name: "method"
      value: 1
    tags: [1,2]

Scanned by Steampunk Spotter

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

# Delete a notification
- name: Delete a notification
  devopsarr.sonarr.sonarr_notification:
    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

on_grab:
    default: false
    description: On grab flag.
    type: bool

on_rename:
    default: false
    description: On rename flag.
    type: bool

on_upgrade:
    default: false
    description: On upgrade flag.
    type: bool

sonarr_url:
    description: Full Sonarr URL with protocol and port (e.g. `https://test.sonarr.tv:8989`)
    required: true
    type: str

on_download:
    default: false
    description: On download flag.
    type: bool

on_series_add:
    default: false
    description: On series add flag.
    type: bool

implementation:
    description: Implementation.
    type: str

sonarr_api_key:
    description: API key for Sonarr authentication.
    required: true
    type: str

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

config_contract:
    description: Config contract.
    type: str

on_health_issue:
    default: false
    description: On health issue flag.
    type: bool

on_series_delete:
    default: false
    description: On series delete flag.
    type: bool

on_health_restored:
    default: false
    description: On health restored flag.
    type: bool

on_application_update:
    default: false
    description: On application update flag.
    type: bool

on_episode_file_delete:
    default: false
    description: On episode file delete flag.
    type: bool

on_manual_interaction_required:
    default: false
    description: On manual interaction required flag.
    type: bool

on_episode_file_delete_for_upgrade:
    default: false
    description: On episode file delete for upgrade flag.
    type: bool

Outputs

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_application_update:
  description: On application update flag.
  returned: always
  sample: true
  type: bool
on_download:
  description: On download flag.
  returned: always
  sample: false
  type: bool
on_episode_file_delete:
  description: On episode file delete flag.
  returned: always
  sample: true
  type: bool
on_episode_file_delete_for_upgrade:
  description: On episode file delete for upgrade flag.
  returned: always
  sample: true
  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_manual_interaction_required:
  description: On manual interaction required flag.
  returned: always
  sample: true
  type: bool
on_rename:
  description: On rename flag.
  returned: always
  sample: true
  type: bool
on_series_add:
  description: On series add flag.
  returned: always
  sample: true
  type: bool
on_series_delete:
  description: On series delete 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