proxy_info

lucasheld.uptime_kuma.proxy_info module -- Retrieves facts about 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_info.

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values

Synopsis

• Retrieves facts about proxies.

Requirements

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

• uptime-kuma-api

Parameters

Parameter	Comments
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
host string	The host of the proxy to inspect. Only required if no id specified. Only valid in combination with port.
id integer	The id of the proxy to inspect. Only required if no host and port specified.
port integer	The port of the proxy to inspect. Only required if no id specified. Only valid in combination with host.

Examples

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

Return Values

Key	Description
proxies complex	The proxies as list Returned: always
active boolean	True if the proxy is active. Returned: always Sample: true
auth boolean	True if authentication is enabled. Returned: always Sample: false
createdDate string	The creation date of the proxy. Returned: always Sample: "2022-08-03T12:43:21"
default boolean	True if the proxy is the default. Returned: always Sample: false
host string	The host of the proxy. Returned: always Sample: "127.0.0.1"
id integer	The id of the proxy. Returned: always Sample: 4
password string	The authentication password of the proxy. Returned: always Sample: "None"
port integer	The port of the proxy. Returned: always Sample: 8080
protocol string	The protocol of the proxy. Returned: always Sample: "http"
userId integer	The user id of the proxy. Returned: always Sample: 1
username string	The authentication username of the proxy. Returned: always Sample: "None"

Authors

• Lucas Held (@lucasheld)

Collection links

Issue Tracker Repository (Sources)