proxy

lucasheld.uptime_kuma.proxy module -- Manages proxies.

Note

This module is part of the lucasheld.uptime_kuma collection (version 1.0.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_password string	The Uptime Kuma password.
api_token string	The Uptime Kuma login token.
api_url string	The Uptime Kuma URL. Default: "http://127.0.0.1:3001"
api_username string	The Uptime Kuma username.
apply_existing 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.
id integer	The id of the proxy.
password string	The password of the proxy.
port integer / required	The port of the proxy.
protocol string	The protocol of the proxy.
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://192.168.1.10:3001
    api_username: admin
    api_password: secret
    protocol: http
    host: 127.0.0.1
    port: 8080
    state: present

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

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

Authors

• Lucas Held (@lucasheld)

Collection links

Issue Tracker Repository (Sources)