tag_info

lucasheld.uptime_kuma.tag_info module -- Retrieves facts about tags.

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

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values

Synopsis

• Retrieves facts about tags.

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 tag to inspect. Only required if no name specified.
name string	The name of the tag to inspect. Only required if no id specified.

Examples

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

Return Values

Key	Description
tags complex	The tags as list Returned: always
color string	The color of the tag. Returned: always
id integer	The id of the tag. Returned: always Sample: 1
name string	The name of the tag. Returned: always Sample: "tag 1"

Authors

• Lucas Held (@lucasheld)

Collection links

Issue Tracker Repository (Sources)