Skip to content

notification

Jump to bottom
lucasheld edited this page Aug 29, 2023 · 19 revisions

lucasheld.uptime_kuma.notification module -- Manages notifications.

Note

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

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

Synopsis

  • Manages notifications.

Requirements

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

  • uptime-kuma-api

Parameters

Parameter

Comments

api_headers

dictionary

Headers that are passed to the socketio connection.

api_password

string

The Uptime Kuma password.

Only required if no api_token specified and authentication is enabled.

api_ssl_verify

boolean

true to verify SSL certificates, or false to skip SSL certificate verification,

allowing connections to servers with self signed certificates.

Choices:

  • no

  • yes ← (default)

api_timeout

float

How many seconds the client should wait for the connection, an expected event or a server response.

Default: 10

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.

api_wait_events

float

How many seconds the client should wait for the next event of the same type.

There is no way to determine when the last message of a certain type has arrived. Therefore, a timeout is required.

If no further message has arrived within this time, it is assumed that it was the last message.

Default: 0.2

applyExisting

boolean

True if the notification is applied to all existing monitors.

Choices:

  • no

  • yes

id

integer

The id of the notification.

Only required if no name specified.

isDefault

boolean

True if the notification is the default.

Choices:

  • no

  • yes

name

string

The name of the notification.

Only required if no id specified.

state

string

Set to present to create/update a notification.

Set to absent to delete a notification.

Choices:

  • present ← (default)

  • absent

Examples

- name: Add notification
  lucasheld.uptime_kuma.notification:
    api_url: http://127.0.0.1:3001
    api_username: admin
    api_password: secret123
    name: Notification 1
    type: telegram
    isDefault: false
    applyExisting: false
    telegramBotToken: 1111
    telegramChatID: 2222
    state: present

- name: Edit notification
  lucasheld.uptime_kuma.notification:
    api_url: http://127.0.0.1:3001
    api_username: admin
    api_password: secret123
    name: Notification 1
    type: telegram
    isDefault: false
    applyExisting: false
    telegramBotToken: 6666
    telegramChatID: 7777
    state: present

- name: Remove notification
  lucasheld.uptime_kuma.notification:
    api_url: http://127.0.0.1:3001
    api_username: admin
    api_password: secret123
    name: Notification 1
    state: absent

Authors

  • Lucas Held (@lucasheld)

Collection links

Issue Tracker Repository (Sources)

Clone this wiki locally