devopsarr.sonarr.sonarr_notification_schema_info module – Get information about Sonarr notification schema.

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_schema_info.

New in devopsarr.sonarr 1.0.0

Synopsis

  • Get information about Sonarr notification schema.

Parameters

Parameter

Comments

name

string

Name.

sonarr_api_key

string / required

API key for Sonarr authentication.

sonarr_url

string / required

Full Sonarr URL with protocol and port (e.g. `https://test.sonarr.tv:8989`)

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

---
# Gather information about all notifications schema.
- name: Gather information about all notifications schema
  devopsarr.sonarr.sonarr_notification_schema_info:

# Gather information about a single notification schema.
- name: Gather information about a single notification schema
  devopsarr.sonarr.sonarr_notification_schema_info:
    name: BroadcastheNet

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

notifications

list / elements=dictionary

A list of notifications schema.

Returned: always

config_contract

string

Config contract.

Returned: always

Sample: "WebhookSettings"

fields

list / elements=string

field list.

Returned: always

id

integer

notification ID.

Returned: always

Sample: 1

implementation

string

Implementation.

Returned: always

Sample: "Webhook"

name

string

Name.

Returned: always

Sample: "Example"

on_application_update

boolean

On application update flag.

Returned: always

Sample: true

on_download

boolean

On download flag.

Returned: always

Sample: false

on_episode_file_delete

boolean

On episode file delete flag.

Returned: always

Sample: true

on_episode_file_delete_for_upgrade

boolean

On episode file delete for upgrade flag.

Returned: always

Sample: true

on_grab

boolean

On grab flag.

Returned: always

Sample: true

on_health_issue

boolean

On health issue flag.

Returned: always

Sample: true

on_health_restored

boolean

On health restored flag.

Returned: always

Sample: true

on_import_complete

boolean

On import complete flag.

Returned: always

Sample: false

on_manual_interaction_required

boolean

On manual interaction required flag.

Returned: always

Sample: true

on_rename

boolean

On rename flag.

Returned: always

Sample: true

on_series_add

boolean

On series add flag.

Returned: always

Sample: true

on_series_delete

boolean

On series delete flag.

Returned: always

Sample: true

tags

list / elements=integer

Tag list.

Returned: always

Sample: [1, 2]

Authors

  • Fuochi (@Fuochi)