devopsarr.sonarr.sonarr_notification module – Manages Sonarr notification.
Note
This module is part of the devopsarr.sonarr collection (version 1.3.1).
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install devopsarr.sonarr.
To use it in a playbook, specify: devopsarr.sonarr.sonarr_notification.
New in devopsarr.sonarr 1.0.0
Synopsis
Manages Sonarr notification.
Parameters
Parameter |
Comments |
|---|---|
Config contract. |
|
Configuration field list. |
|
Field name. |
|
Field value. |
|
Implementation. |
|
Name. |
|
On application update flag. Choices:
|
|
On download flag. Choices:
|
|
On episode file delete flag. Choices:
|
|
On episode file delete for upgrade flag. Choices:
|
|
On grab flag. Choices:
|
|
On health issue flag. Choices:
|
|
On health restored flag. Choices:
|
|
On import complete flag. Choices:
|
|
On manual interaction required flag. Choices:
|
|
On rename flag. Choices:
|
|
On series add flag. Choices:
|
|
On series delete flag. Choices:
|
|
On upgrade flag. Choices:
|
|
API key for Sonarr authentication. |
|
Full Sonarr URL with protocol and port (e.g. `https://test.sonarr.tv:8989`) |
|
Create or delete resource. Choices:
|
|
Tag list. Default: |
|
Flag to force update of secret fields. Choices:
|
Notes
Note
for authentication, you can set service_account_file using the c(SONARR_URL) env variable.
for authentication, you can set service_account_contents using the c(SONARR_API_KEY) env variable.
Examples
---
# 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]
# Delete a notification
- name: Delete a notification
devopsarr.sonarr.sonarr_notification:
name: Example
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Config contract. Returned: always Sample: |
|
field list. Returned: always |
|
notification ID. Returned: always Sample: |
|
Implementation. Returned: always Sample: |
|
Name. Returned: always Sample: |
|
On application update flag. Returned: always Sample: |
|
On download flag. Returned: always Sample: |
|
On episode file delete flag. Returned: always Sample: |
|
On episode file delete for upgrade flag. Returned: always Sample: |
|
On grab flag. Returned: always Sample: |
|
On health issue flag. Returned: always Sample: |
|
On health restored flag. Returned: always Sample: |
|
On import complete flag. Returned: always Sample: |
|
On manual interaction required flag. Returned: always Sample: |
|
On rename flag. Returned: always Sample: |
|
On series add flag. Returned: always Sample: |
|
On series delete flag. Returned: always Sample: |
|
On upgrade flag. Returned: always Sample: |
|
Tag list. Returned: always Sample: |