notification_info

lucasheld.uptime_kuma.notification_info module -- Retrieves facts about notifications.

Note

This module is part of the lucasheld.uptime_kuma collection (version 0.10.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 notifications.

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 and authentication is enabled.
api_token string	The Uptime Kuma login token. Only required if no api_username and api_password specified and authentication is enabled.
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 and authentication is enabled.
id integer	The id of the notification to inspect. Only required if no name specified.
name string	The name of the notification to inspect. Only required if no id specified.

Examples

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

Return Values

Key	Description
notifications complex	The notifications as list Returned: always
accessKeyId string	AliyunSMS provider option. Returned: if type is AliyunSMS
accessToken string	OneBot provider option. Returned: if type is OneBot
active boolean	Returned: always Sample: true
alertaAlertState string	alerta provider option. Returned: if type is alerta
alertaApiEndpoint string	alerta provider option. Returned: if type is alerta
alertaApiKey string	alerta provider option. Returned: if type is alerta
alertaEnvironment string	alerta provider option. Returned: if type is alerta
alertaRecoverState string	alerta provider option. Returned: if type is alerta
alertNowWebhookURL string	AlertNow provider option. Returned: if type is AlertNow
applyExisting boolean	True if the notification is applied to all existing monitors. Returned: always
appriseURL string	apprise provider option. Returned: if type is apprise
barkEndpoint string	Bark provider option. Returned: if type is Bark
barkGroup string	Bark provider option. Returned: if type is Bark
barkSound string	Bark provider option. Returned: if type is Bark
clicksendsmsLogin string	clicksendsms provider option. Returned: if type is clicksendsms
clicksendsmsPassword string	clicksendsms provider option. Returned: if type is clicksendsms
clicksendsmsSenderName string	clicksendsms provider option. Returned: if type is clicksendsms
clicksendsmsToNumber string	clicksendsms provider option. Returned: if type is clicksendsms
customSubject string	smtp provider option. Returned: if type is smtp
discordPrefixMessage string	discord provider option. Returned: if type is discord
discordUsername string	discord provider option. Returned: if type is discord
discordWebhookUrl string	discord provider option. Returned: if type is discord
feishuWebHookUrl string	Feishu provider option. Returned: if type is Feishu
freemobilePass string	FreeMobile provider option. Returned: if type is FreeMobile
freemobileUser string	FreeMobile provider option. Returned: if type is FreeMobile
goAlertBaseURL string	GoAlert provider option. Returned: if type is GoAlert
goAlertToken string	GoAlert provider option. Returned: if type is GoAlert
googleChatWebhookURL string	GoogleChat provider option. Returned: if type is GoogleChat
gorushDeviceToken string	gorush provider option. Returned: if type is gorush
gorushPlatform string	gorush provider option. Returned: if type is gorush
gorushPriority string	gorush provider option. Returned: if type is gorush
gorushRetry string	gorush provider option. Returned: if type is gorush
gorushServerURL string	gorush provider option. Returned: if type is gorush
gorushTitle string	gorush provider option. Returned: if type is gorush
gorushTopic string	gorush provider option. Returned: if type is gorush
gotifyapplicationToken string	gotify provider option. Returned: if type is gotify
gotifyPriority integer	gotify provider option. Returned: if type is gotify
gotifyserverurl string	gotify provider option. Returned: if type is gotify
homeAssistantUrl string	HomeAssistant provider option. Returned: if type is HomeAssistant
homeserverUrl string	matrix provider option. Returned: if type is matrix
httpAddr string	OneBot provider option. Returned: if type is OneBot
id integer	The id of the notification. Returned: always Sample: 1
internalRoomId string	matrix provider option. Returned: if type is matrix
isDefault boolean	True if the notification is the default. Returned: always Sample: false
kookBotToken string	Kook provider option. Returned: if type is Kook
kookGuildID string	Kook provider option. Returned: if type is Kook
lineChannelAccessToken string	line provider option. Returned: if type is line
lineNotifyAccessToken string	LineNotify provider option. Returned: if type is LineNotify
lineUserID string	line provider option. Returned: if type is line
longLivedAccessToken string	HomeAssistant provider option. Returned: if type is HomeAssistant
lunaseaDevice string	lunasea provider option. Returned: if type is lunasea
mattermostchannel string	mattermost provider option. Returned: if type is mattermost
mattermosticonemo string	mattermost provider option. Returned: if type is mattermost
mattermosticonurl string	mattermost provider option. Returned: if type is mattermost
mattermostusername string	mattermost provider option. Returned: if type is mattermost
mattermostWebhookUrl string	mattermost provider option. Returned: if type is mattermost
messageType string	SMSManager provider option. Returned: if type is SMSManager
msgType string	OneBot provider option. Returned: if type is OneBot
name string	The id of the notification. Returned: always Sample: "My Telegram Alert (1)"
ntfyIcon string	ntfy provider option. Returned: if type is ntfy
ntfypassword string	ntfy provider option. Returned: if type is ntfy
ntfyPriority integer	ntfy provider option. Returned: if type is ntfy
ntfyserverurl string	ntfy provider option. Returned: if type is ntfy
ntfytopic string	ntfy provider option. Returned: if type is ntfy
ntfyusername string	ntfy provider option. Returned: if type is ntfy
numbers string	SMSManager provider option. Returned: if type is SMSManager
octopushAPIKey string	octopush provider option. Returned: if type is octopush
octopushDMAPIKey string	octopush provider option. Returned: if type is octopush
octopushDMLogin string	octopush provider option. Returned: if type is octopush
octopushDMPhoneNumber string	octopush provider option. Returned: if type is octopush
octopushDMSenderName string	octopush provider option. Returned: if type is octopush
octopushDMSMSType string	octopush provider option. Returned: if type is octopush
octopushLogin string	octopush provider option. Returned: if type is octopush
octopushPhoneNumber string	octopush provider option. Returned: if type is octopush
octopushSenderName string	octopush provider option. Returned: if type is octopush
octopushSMSType string	octopush provider option. Returned: if type is octopush
octopushVersion string	octopush provider option. Returned: if type is octopush
pagerdutyAutoResolve string	PagerDuty provider option. Returned: if type is PagerDuty
pagerdutyIntegrationKey string	PagerDuty provider option. Returned: if type is PagerDuty
pagerdutyIntegrationUrl string	PagerDuty provider option. Returned: if type is PagerDuty
pagerdutyPriority string	PagerDuty provider option. Returned: if type is PagerDuty
phonenumber string	AliyunSMS provider option. Returned: if type is AliyunSMS
promosmsAllowLongSMS boolean	promosms provider option. Returned: if type is promosms
promosmsLogin string	promosms provider option. Returned: if type is promosms
promosmsPassword string	promosms provider option. Returned: if type is promosms
promosmsPhoneNumber string	promosms provider option. Returned: if type is promosms
promosmsSenderName string	promosms provider option. Returned: if type is promosms
promosmsSMSType string	promosms provider option. Returned: if type is promosms
pushAPIKey string	PushByTechulus provider option. Returned: if type is PushByTechulus
pushbulletAccessToken string	pushbullet provider option. Returned: if type is pushbullet
pushdeerKey string	PushDeer provider option. Returned: if type is PushDeer
pushoverapptoken string	pushover provider option. Returned: if type is pushover
pushoverdevice string	pushover provider option. Returned: if type is pushover
pushoverpriority string	pushover provider option. Returned: if type is pushover
pushoversounds string	pushover provider option. Returned: if type is pushover
pushovertitle string	pushover provider option. Returned: if type is pushover
pushoveruserkey string	pushover provider option. Returned: if type is pushover
pushyAPIKey string	pushy provider option. Returned: if type is pushy
pushyToken string	pushy provider option. Returned: if type is pushy
recieverId string	OneBot provider option. Returned: if type is OneBot
rocketbutton string	rocket.chat provider option. Returned: if type is rocket.chat
rocketchannel string	rocket.chat provider option. Returned: if type is rocket.chat
rocketiconemo string	rocket.chat provider option. Returned: if type is rocket.chat
rocketusername string	rocket.chat provider option. Returned: if type is rocket.chat
rocketwebhookURL string	rocket.chat provider option. Returned: if type is rocket.chat
secretAccessKey string	AliyunSMS provider option. Returned: if type is AliyunSMS
secretKey string	DingDing provider option. Returned: if type is DingDing
serverChanSendKey string	ServerChan provider option. Returned: if type is ServerChan
serwersmsPassword string	serwersms provider option. Returned: if type is serwersms
serwersmsPhoneNumber string	serwersms provider option. Returned: if type is serwersms
serwersmsSenderName string	serwersms provider option. Returned: if type is serwersms
serwersmsUsername string	serwersms provider option. Returned: if type is serwersms
signalNumber string	signal provider option. Returned: if type is signal
signalRecipients string	signal provider option. Returned: if type is signal
signalURL string	signal provider option. Returned: if type is signal
signName string	AliyunSMS provider option. Returned: if type is AliyunSMS
slackbutton string	slack provider option. Returned: if type is slack
slackchannel string	slack provider option. Returned: if type is slack
slackiconemo string	slack provider option. Returned: if type is slack
slackusername string	slack provider option. Returned: if type is slack
slackwebhookURL string	slack provider option. Returned: if type is slack
smseagleEncoding boolean	SMSEagle provider option. Returned: if type is SMSEagle
smseaglePriority integer	SMSEagle provider option. Returned: if type is SMSEagle
smseagleRecipient string	SMSEagle provider option. Returned: if type is SMSEagle
smseagleRecipientType string	SMSEagle provider option. Returned: if type is SMSEagle
smseagleToken string	SMSEagle provider option. Returned: if type is SMSEagle
smseagleUrl string	SMSEagle provider option. Returned: if type is SMSEagle
smsmanagerApiKey string	SMSManager provider option. Returned: if type is SMSManager
smtpBCC string	smtp provider option. Returned: if type is smtp
smtpCC string	smtp provider option. Returned: if type is smtp
smtpDkimDomain string	smtp provider option. Returned: if type is smtp
smtpDkimHashAlgo string	smtp provider option. Returned: if type is smtp
smtpDkimheaderFieldNames string	smtp provider option. Returned: if type is smtp
smtpDkimKeySelector string	smtp provider option. Returned: if type is smtp
smtpDkimPrivateKey string	smtp provider option. Returned: if type is smtp
smtpDkimskipFields string	smtp provider option. Returned: if type is smtp
smtpFrom string	smtp provider option. Returned: if type is smtp
smtpHost string	smtp provider option. Returned: if type is smtp
smtpIgnoreTLSError string	smtp provider option. Returned: if type is smtp
smtpPassword string	smtp provider option. Returned: if type is smtp
smtpPort integer	smtp provider option. Returned: if type is smtp
smtpSecure string	smtp provider option. Returned: if type is smtp
smtpTo string	smtp provider option. Returned: if type is smtp
smtpUsername string	smtp provider option. Returned: if type is smtp
splunkAutoResolve string	Splunk provider option. Returned: if type is Splunk
splunkRestURL string	Splunk provider option. Returned: if type is Splunk
splunkSeverity string	Splunk provider option. Returned: if type is Splunk
squadcastWebhookURL string	squadcast provider option. Returned: if type is squadcast
stackfieldwebhookURL string	stackfield provider option. Returned: if type is stackfield
telegramBotToken string	telegram provider option. Returned: if type is telegram
telegramChatID string	telegram provider option. Returned: if type is telegram
templateCode string	AliyunSMS provider option. Returned: if type is AliyunSMS
title string	apprise provider option. Returned: if type is apprise
type string	Returned: always Sample: "telegram"
userId string	Returned: always Sample: 1
webhookAdditionalHeaders string	webhook provider option. Returned: if type is webhook
webhookContentType string	webhook provider option. Returned: if type is webhook
webHookUrl string	DingDing provider option. Returned: if type is DingDing
webhookURL string	webhook provider option. Returned: if type is webhook
webhookUrl string	ZohoCliq provider option. Returned: if type is ZohoCliq
weComBotKey string	WeCom provider option. Returned: if type is WeCom

Authors

• Lucas Held (@lucasheld)

Collection links

Issue Tracker Repository (Sources)