notification_info

lucasheld.uptime_kuma.notification_info module -- Retrieves facts about a notification.

Note

This module is part of the lucasheld.uptime_kuma collection (version 1.0.0).

You might already have this collection installed if you are using the ansible package. 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 git+https://github.com/lucasheld/ansible-uptime-kuma.git.

To use it in a playbook, specify: lucasheld.uptime_kuma.notification_info.

Synopsis
Requirements
Parameters
Examples
Return Values

Synopsis

Retrieves facts about a notification.

Requirements

The below requirements are needed on the host that executes this module.

uptime-kuma-api

Parameters

Parameter	Comments
api_password string	The Uptime Kuma password. Only required if no api_token specified.
api_token string	The Uptime Kuma login token. Only required if no api_username and api_password specified.
api_url string	The Uptime Kuma URL. Default: "http://127.0.0.1:3001"
api_username string	The Uptime Kuma username. Only required if no api_token specified.
id integer	The id of the notification to inspect.
name string	The name of the notification to inspect.

Examples

- name: get all notifications
  lucasheld.uptime_kuma.notification_info:
    api_url: http://192.168.1.10:3001
    api_username: admin
    api_password: secret
  register: result

Return Values

Key	Description
notifications complex	The notifications as list Returned: always
active boolean	Returned: always Sample: true
alerta_alert_state string	Returned: if type is alerta
alerta_api_endpoint string	Returned: if type is alerta
alerta_api_key string	Returned: if type is alerta
alerta_environment string	Returned: if type is alerta
alerta_recover_state string	Returned: if type is alerta
aliyun_sms_access_key_id string	Returned: if type is aliyun_sms
aliyun_sms_phonenumber string	Returned: if type is aliyun_sms
aliyun_sms_secret_access_key string	Returned: if type is aliyun_sms
aliyun_sms_sign_name string	Returned: if type is aliyun_sms
aliyun_sms_template_code string	Returned: if type is aliyun_sms
apprise_title string	Returned: if type is apprise
apprise_url string	Returned: if type is apprise
bark_endpoint string	Returned: if type is bark
clicksendsms_login string	Returned: if type is clicksendsms
clicksendsms_password string	Returned: if type is clicksendsms
clicksendsms_sender_name string	Returned: if type is clicksendsms
clicksendsms_to_number string	Returned: if type is clicksendsms
default boolean	Returned: always Sample: false
ding_ding_secret_key string	Returned: if type is ding_ding
ding_ding_web_hook_url string	Returned: if type is ding_ding
discord_prefix_message string	Returned: if type is discord
discord_username string	Returned: if type is discord
discord_webhook_url string	Returned: if type is discord
feishu_web_hook_url string	Returned: if type is feishu
google_chat_chat_webhook_url string	Returned: if type is google_chat
gorush_device_token string	Returned: if type is gorush
gorush_platform string	Returned: if type is gorush
gorush_priority string	Returned: if type is gorush
gorush_retry string	Returned: if type is gorush
gorush_server_url string	Returned: if type is gorush
gorush_title string	Returned: if type is gorush
gorush_topic string	Returned: if type is gorush
gotify_application_token string	Returned: if type is gotify
gotify_priority string	Returned: if type is gotify
gotify_serverurl string	Returned: if type is gotify
id integer	The id of the notification. Returned: always Sample: 1
line_channel_access_token string	Returned: if type is line
line_user_id string	Returned: if type is line
lunasea_device string	Returned: if type is lunasea
matrix_access_token string	Returned: if type is matrix
matrix_homeserver_url string	Returned: if type is matrix
matrix_internal_room_id string	Returned: if type is matrix
mattermost_channel string	Returned: if type is mattermost
mattermost_iconemo string	Returned: if type is mattermost
mattermost_iconurl string	Returned: if type is mattermost
mattermost_username string	Returned: if type is mattermost
mattermost_webhook_url string	Returned: if type is mattermost
name string	The id of the notification. Returned: always Sample: "My Telegram Alert (1)"
ntfy_priority string	Returned: if type is ntfy
ntfy_serverurl string	Returned: if type is ntfy
ntfy_topic string	Returned: if type is ntfy
octopush_apikey string	Returned: if type is octopush
octopush_dmapikey string	Returned: if type is octopush
octopush_dmlogin string	Returned: if type is octopush
octopush_dmphone_number string	Returned: if type is octopush
octopush_dmsender_name string	Returned: if type is octopush
octopush_dmsmstype string	Returned: if type is octopush
octopush_login string	Returned: if type is octopush
octopush_phone_number string	Returned: if type is octopush
octopush_sender_name string	Returned: if type is octopush
octopush_smstype string	Returned: if type is octopush
octopush_version string	Returned: if type is octopush
one_bot_access_token string	Returned: if type is one_bot
one_bot_http_addr string	Returned: if type is one_bot
one_bot_msg_type string	Returned: if type is one_bot
one_bot_reciever_id string	Returned: if type is one_bot
pager_duty_duty_auto_resolve string	Returned: if type is pager_duty
pager_duty_duty_integration_key string	Returned: if type is pager_duty
pager_duty_duty_integration_url string	Returned: if type is pager_duty
pager_duty_duty_priority string	Returned: if type is pager_duty
promosms_login string	Returned: if type is promosms
promosms_password string	Returned: if type is promosms
promosms_phone_number string	Returned: if type is promosms
promosms_sender_name string	Returned: if type is promosms
promosms_smstype string	Returned: if type is promosms
push_by_techulus_apikey string	Returned: if type is push_by_techulus
push_deer_deer_key string	Returned: if type is push_deer
pushbullet_access_token string	Returned: if type is pushbullet
pushover_apptoken string	Returned: if type is pushover
pushover_device string	Returned: if type is pushover
pushover_priority string	Returned: if type is pushover
pushover_sounds string	Returned: if type is pushover
pushover_title string	Returned: if type is pushover
pushover_userkey string	Returned: if type is pushover
pushy_apikey string	Returned: if type is pushy
pushy_token string	Returned: if type is pushy
rocket_chat_button string	Returned: if type is rocket_chat
rocket_chat_channel string	Returned: if type is rocket_chat
rocket_chat_iconemo string	Returned: if type is rocket_chat
rocket_chat_username string	Returned: if type is rocket_chat
rocket_chat_webhook_url string	Returned: if type is rocket_chat
serwersms_password string	Returned: if type is serwersms
serwersms_phone_number string	Returned: if type is serwersms
serwersms_sender_name string	Returned: if type is serwersms
serwersms_username string	Returned: if type is serwersms
signal_number string	Returned: if type is signal
signal_recipients string	Returned: if type is signal
signal_url string	Returned: if type is signal
slack_button string	Returned: if type is slack
slack_channel string	Returned: if type is slack
slack_iconemo string	Returned: if type is slack
slack_username string	Returned: if type is slack
slack_webhook_url string	Returned: if type is slack
smtp_bcc string	Returned: if type is smtp
smtp_cc string	Returned: if type is smtp
smtp_custom_subject string	Returned: if type is smtp
smtp_dkim_domain string	Returned: if type is smtp
smtp_dkim_hash_algo string	Returned: if type is smtp
smtp_dkim_key_selector string	Returned: if type is smtp
smtp_dkim_private_key string	Returned: if type is smtp
smtp_dkimheader_field_names string	Returned: if type is smtp
smtp_dkimskip_fields string	Returned: if type is smtp
smtp_from string	Returned: if type is smtp
smtp_host string	Returned: if type is smtp
smtp_ignore_tlserror string	Returned: if type is smtp
smtp_password string	Returned: if type is smtp
smtp_port string	Returned: if type is smtp
smtp_secure string	Returned: if type is smtp
smtp_to string	Returned: if type is smtp
smtp_username string	Returned: if type is smtp
stackfield_webhook_url string	Returned: if type is stackfield
teams_webhook_url string	Returned: if type is teams
telegram_bot_token string	Returned: if type is telegram
telegram_chat_id string	Returned: if type is telegram
type string	Returned: always Sample: "telegram"
user_id string	Returned: always Sample: 1
we_com_com_bot_key string	Returned: if type is we_com
webhook_content_type string	Returned: if type is webhook
webhook_url string	Returned: if type is webhook

Authors

Lucas Held (@lucasheld)

Collection links

Issue Tracker Repository (Sources)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly