community.docker.docker_host_info – Retrieves facts about docker host and lists of objects of the services.

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• Retrieves facts about a docker host.
• Essentially returns the output of docker system info.
• The module also allows to list object names for containers, images, networks and volumes. It also allows to query information on disk usage.
• The output differs depending on API version of the docker daemon.
• If the docker daemon cannot be contacted or does not meet the API version requirements, the module will fail.

Requirements

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

• Docker API >= 1.21
• Docker SDK for Python: Please note that the docker-py Python module has been superseded by docker (see here for details). For Python 2.6, docker-py must be used. Otherwise, it is recommended to install the docker Python module. Note that both modules should not be installed at the same time. Also note that when both modules are installed and one of them is uninstalled, the other might no longer function and a reinstall of it is required.
• Docker SDK for Python >= 1.10.0 (use docker-py for Python 2.6)

Parameters

Notes

Examples

- name: Get info on docker host
  community.docker.docker_host_info:
  register: result

- name: Get info on docker host and list images
  community.docker.docker_host_info:
    images: yes
  register: result

- name: Get info on docker host and list images matching the filter
  community.docker.docker_host_info:
    images: yes
    images_filters:
      label: "mylabel"
  register: result

- name: Get info on docker host and verbose list images
  community.docker.docker_host_info:
    images: yes
    verbose_output: yes
  register: result

- name: Get info on docker host and used disk space
  community.docker.docker_host_info:
    disk_usage: yes
  register: result

- name: Get info on docker host and list containers matching the filter
  community.docker.docker_host_info:
    containers: yes
    containers_filters:
      label:
        - key1=value1
        - key2=value2
  register: result

- ansible.builtin.debug:
    var: result.host_info

Return Values

Common return values are documented here, the following are the fields unique to this module:

Authors

• Piotr Wojciechowski (@WojciechowskiPiotr)