proxy

lucasheld.uptime_kuma.proxy module -- Manages proxies.

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

• Synopsis
• Requirements
• Parameters
• Examples

Synopsis

• Manages proxies.

Requirements

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

• uptime-kuma-api

Parameters

Parameter	Comments
active boolean	True if the proxy is active. Choices: no yes
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 proxy is applied to existing monitors. Choices: no yes
auth boolean	True if the authentication is enabled. Choices: no yes
default boolean	True if the proxy is the default. Choices: no yes
host string / required	The host of the proxy. Only required if no id specified.
id integer	The id of the proxy. Only required if no host, port and protocol specified.
password string	The password of the proxy.
port integer / required	The port of the proxy. Only required if no id specified.
protocol string	The protocol of the proxy. Choices: https http socks socks5 socks5h socks4
state string	Set to present to create/update a proxy. Set to absent to delete a proxy. Choices: present ← (default) absent
username string	The username of the proxy.

Examples

- name: Add proxy
  lucasheld.uptime_kuma.proxy:
    api_url: http://127.0.0.1:3001
    api_username: admin
    api_password: secret123
    protocol: http
    host: 127.0.0.1
    port: 8080
    state: present

- name: Edit proxy
  lucasheld.uptime_kuma.proxy:
    api_url: http://127.0.0.1:3001
    api_username: admin
    api_password: secret123
    host: 127.0.0.1
    port: 8080
    active: false
    state: present

- name: Remove proxy
  lucasheld.uptime_kuma.proxy:
    api_url: http://127.0.0.1:3001
    api_username: admin
    api_password: secret123
    host: 127.0.0.1
    port: 8080
    state: absent

Authors

• Lucas Held (@lucasheld)

Collection links

Issue Tracker Repository (Sources)