docker_host_info

lucasheld.uptime_kuma.docker_host_info module -- Retrieves facts about docker hosts.

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

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values

Synopsis

• Retrieves facts about docker hosts.

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

Examples

- name: get all docker hosts
  lucasheld.uptime_kuma.docker_host_info:
    api_url: http://127.0.0.1:3001
    api_username: admin
    api_password: secret123
  register: result

Return Values

Key	Description
docker_hosts complex	The docker hosts as list Returned: always
dockerDaemon string	The docker daemon of the docker host. Returned: always Sample: "/var/run/docker.sock"
dockerType string	The docker type of the docker host. Returned: always Sample: "socket"
id integer	The id of the docker host. Returned: always Sample: 1
name string	The name of the docker host. Returned: always Sample: "docker host 1"
userID integer	The user id of the docker host. Returned: always Sample: 1

Authors

• Lucas Held (@lucasheld)

Collection links

Issue Tracker Repository (Sources)