settings

lucasheld.uptime_kuma.settings module -- Manages settings.

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

• Synopsis
• Requirements
• Parameters
• Examples

Synopsis

• Manages settings.

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
checkBeta boolean	True if update check for beta versions should be enabled. Choices: no yes
checkUpdate boolean	True if update check should be enabled. Choices: no yes
chromeExecutable string	Chrome/Chromium Executable
disableAuth boolean	True if authentication should be disabled. Choices: no yes
dnsCache boolean	True if dns cache should be enabled. Choices: no yes
entryPage string	The entry page. The value requires the prefix "statusPage-". For example, if the slug is "1uhosting", then the entryPage is "statusPage-1uhosting".
keepDataPeriodDays integer	Keep monitor history data for this number of days.
nscd boolean	Enable NSCD (Name Service Cache Daemon) for caching all DNS requests Choices: no yes
password string	The Uptime Kuma password. Only required if disableAuth is true.
primaryBaseURL string	The primary base URL.
searchEngineIndex boolean	True if Uptime Kuma should be indexed by search engines. Choices: no yes
serverTimezone string	The server timezone.
steamAPIKey string	The Steam API key for monitoring a Steam game server.
tlsExpiryNotifyDays list / elements=integer	HTTPS monitors trigger notification when the TLS certificate expires in the specified days.
trustProxy boolean	True to trust 'X-Forwarded-*' headers. If you want to get the correct client IP and your Uptime Kuma is behind such as Nginx or Apache, you should enable this. Choices: no yes

Examples

- name: Enable beta version update check
  lucasheld.uptime_kuma.settings:
    api_url: http://127.0.0.1:3001
    api_username: admin
    api_password: secret123
    checkBeta: true

Authors

• Lucas Held (@lucasheld)

Collection links

Issue Tracker Repository (Sources)