-
Notifications
You must be signed in to change notification settings - Fork 19
monitor_tag
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.monitor_tag
.
- Manages monitor tags.
The below requirements are needed on the host that executes this module.
- uptime-kuma-api
Parameter |
Comments |
---|---|
Headers that are passed to the socketio connection. |
|
The Uptime Kuma password. Only required if no api_token specified and authentication is enabled. |
|
true to verify SSL certificates, or false to skip SSL certificate verification, allowing connections to servers with self signed certificates. Choices:
|
|
How many seconds the client should wait for the connection, an expected event or a server response. Default: 10 |
|
The Uptime Kuma login token. Only required if no api_username and api_password specified and authentication is enabled. |
|
The Uptime Kuma URL. Default: "http://127.0.0.1:3001" |
|
The Uptime Kuma username. Only required if no api_token specified and authentication is enabled. |
|
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 |
|
The id of the monitor to which the tag should be assigned. Only required if no monitor_name specified. |
|
The name of the monitor to which the tag should be assigned. Only required if no monitor_id specified. |
|
Set to Set to Choices:
|
|
The id of the tag that should be assigned. Only required if no tag_name specified. |
|
The name of the tag that should be assigned. Only required if no tag_id specified. |
|
The value that should be assigned. |
- name: Add a monitor tag
lucasheld.uptime_kuma.monitor_tag:
api_url: http://127.0.0.1:3001
api_username: admin
api_password: secret123
monitor_name: Monitor 1
tag_name: Tag 1
value: Tag value
state: present
- name: Remove a monitor tag
lucasheld.uptime_kuma.monitor_tag:
api_url: http://127.0.0.1:3001
api_username: admin
api_password: secret123
monitor_name: Monitor 1
tag_name: Tag 1
value: Tag Value
state: absent
- Lucas Held (@lucasheld)