monitor_info

orphan:

lucasheld.uptime_kuma.monitor_info module -- Retrieves facts about a monitor.

Note

This module is part of the lucasheld.uptime_kuma collection.

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

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values

Synopsis

• Retrieves facts about a monitor.

Requirements

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

• uptime_kuma_api

Parameters

Parameter	Comments
api_password string / required	The Uptime Kuma Password.
api_url string	The Uptime Kuma URL. Default: "http://127.0.0.1:3001"
api_username string / required	The Uptime Kuma Username.
id integer	The id of the monitor to inspect.
name string	The name of the monitor to inspect.

Examples

- name: get all monitors
  lucasheld.uptime_kuma.monitor_info:
    api_url: http://192.168.1.10:3001
    api_username: admin
    api_password: secret
  register: result

Return Values

Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

Key	Description
monitors list / elements=dictionary	The monitors as list Returned: always

Authors

• Lucas Held (@lucasheld)