You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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

Note

This module is part of the community.docker collection (version 3.4.11).

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 community.docker. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.docker.docker_host_info.

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

• backports.ssl_match_hostname (when using TLS on Python 2)

• paramiko (when using SSH with use_ssh_client=false)

• pyOpenSSL (when using TLS)

• pywin32 (when using named pipes on Windows 32)

• requests

Parameters

Parameter	Comments
api_version aliases: docker_api_version string	The version of the Docker API running on the Docker Host. Defaults to the latest version of the API supported by this collection and the docker daemon. If the value is not specified in the task, the value of environment variable DOCKER_API_VERSION will be used instead. If the environment variable is not set, the default value will be used. Default: "auto"
ca_cert aliases: tls_ca_cert, cacert_path path	Use a CA certificate when performing server verification by providing the path to a CA certificate file. If the value is not specified in the task and the environment variable DOCKER_CERT_PATH is set, the file ca.pem from the directory specified in the environment variable DOCKER_CERT_PATH will be used.
client_cert aliases: tls_client_cert, cert_path path	Path to the client’s TLS certificate file. If the value is not specified in the task and the environment variable DOCKER_CERT_PATH is set, the file cert.pem from the directory specified in the environment variable DOCKER_CERT_PATH will be used.
client_key aliases: tls_client_key, key_path path	Path to the client’s TLS key file. If the value is not specified in the task and the environment variable DOCKER_CERT_PATH is set, the file key.pem from the directory specified in the environment variable DOCKER_CERT_PATH will be used.
containers boolean	Whether to list containers. Choices: false ← (default) true
containers_all boolean added in community.docker 3.4.0	By default, only running containers are returned. This corresponds to the --all option to docker container list. Choices: false ← (default) true
containers_filters dictionary	A dictionary of filter values used for selecting containers to list. For example, until: 24h. label is a special case of filter which can be a string <key> matching when a label is present, a string <key>=<value> matching when a label has a particular value, or a list of strings <key>/<key>=<value. See the docker documentation for more information on possible filters.
debug boolean	Debug mode Choices: false ← (default) true
disk_usage boolean	Summary information on used disk space by all Docker layers. The output is a sum of images, volumes, containers and build cache. Choices: false ← (default) true
docker_host aliases: docker_url string	The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the TCP connection string. For example, tcp://192.0.2.23:2376. If TLS is used to encrypt the connection, the module will automatically replace tcp in the connection URL with https. If the value is not specified in the task, the value of environment variable DOCKER_HOST will be used instead. If the environment variable is not set, the default value will be used. Default: "unix://var/run/docker.sock"
images boolean	Whether to list images. Choices: false ← (default) true
images_filters dictionary	A dictionary of filter values used for selecting images to list. For example, dangling: true. label is a special case of filter which can be a string <key> matching when a label is present, a string <key>=<value> matching when a label has a particular value, or a list of strings <key>/<key>=<value. See the docker documentation for more information on possible filters.
networks boolean	Whether to list networks. Choices: false ← (default) true
networks_filters dictionary	A dictionary of filter values used for selecting networks to list. label is a special case of filter which can be a string <key> matching when a label is present, a string <key>=<value> matching when a label has a particular value, or a list of strings <key>/<key>=<value. See the docker documentation for more information on possible filters.
ssl_version string	Provide a valid SSL version number. Default value determined by SSL Python module. If the value is not specified in the task, the value of environment variable DOCKER_SSL_VERSION will be used instead.
timeout integer	The maximum amount of time in seconds to wait on a response from the API. If the value is not specified in the task, the value of environment variable DOCKER_TIMEOUT will be used instead. If the environment variable is not set, the default value will be used. Default: 60
tls boolean	Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. Note that if validate_certs is set to true as well, it will take precedence. If the value is not specified in the task, the value of environment variable DOCKER_TLS will be used instead. If the environment variable is not set, the default value will be used. Choices: false ← (default) true
tls_hostname string	When verifying the authenticity of the Docker Host server, provide the expected name of the server. If the value is not specified in the task, the value of environment variable DOCKER_TLS_HOSTNAME will be used instead. If the environment variable is not set, the default value will be used. Note that this option had a default value localhost in older versions. It was removed in community.docker 3.0.0.
use_ssh_client boolean added in community.docker 1.5.0	For SSH transports, use the ssh CLI tool instead of paramiko. Choices: false ← (default) true
validate_certs aliases: tls_verify boolean	Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server. If the value is not specified in the task, the value of environment variable DOCKER_TLS_VERIFY will be used instead. If the environment variable is not set, the default value will be used. Choices: false ← (default) true
verbose_output boolean	When set to true and networks, volumes, images, containers, or disk_usage is set to true then output will contain verbose information about objects matching the full output of API method. For details see the documentation of your version of Docker API at https://docs.docker.com/engine/api/. The verbose output in this module contains only subset of information returned by this module for each type of the objects. Choices: false ← (default) true
volumes boolean	Whether to list volumes. Choices: false ← (default) true
volumes_filters dictionary	A dictionary of filter values used for selecting volumes to list. label is a special case of filter which can be a string <key> matching when a label is present, a string <key>=<value> matching when a label has a particular value, or a list of strings <key>/<key>=<value. See the docker documentation for more information on possible filters.

Attributes

Attribute	Support	Description
action_group	Action groups: community.docker.docker, docker	Use group/docker or group/community.docker.docker in module_defaults to set defaults for this module.
check_mode	Support: full This action does not modify state.	Can run in check_mode and return changed status prediction without modifying target.
diff_mode	Support: N/A This action does not modify state.	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

• Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_SSL_VERSION, DOCKER_TLS, DOCKER_TLS_VERIFY and DOCKER_TIMEOUT. If you are using docker machine, run the script shipped with the product that sets up the environment. It will set these variables for you. See https://docs.docker.com/machine/reference/env/ for more details.

• This module does not use the Docker SDK for Python to communicate with the Docker daemon. It uses code derived from the Docker SDK or Python that is included in this collection.

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: true
  register: result

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

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

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

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

- name: Show host information
  ansible.builtin.debug:
    var: result.host_info

Return Values

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

Key	Description
can_talk_to_docker boolean	Will be true if the module can talk to the docker daemon. Returned: both on success and on error
containers list / elements=dictionary	List of dict objects containing the basic information about each container. Keys matches the docker container ls output unless verbose_output=true. See description for verbose_output. Returned: When containers=true
disk_usage dictionary	Information on summary disk usage by images, containers and volumes on docker host unless verbose_output=true. See description for verbose_output. Returned: When disk_usage=true
host_info dictionary	Facts representing the basic state of the docker host. Matches the docker system info output. Returned: always
images list / elements=dictionary	List of dict objects containing the basic information about each image. Keys matches the docker image ls output unless verbose_output=true. See description for verbose_output. Returned: When images=true
networks list / elements=dictionary	List of dict objects containing the basic information about each network. Keys matches the docker network ls output unless verbose_output=true. See description for verbose_output. Returned: When networks=true
volumes list / elements=dictionary	List of dict objects containing the basic information about each volume. Keys matches the docker volume ls output unless verbose_output=true. See description for verbose_output. Returned: When volumes=true

Authors

• Piotr Wojciechowski (@WojciechowskiPiotr)

Collection links

• Issue Tracker
• Repository (Sources)
• Submit a bug report
• Request a feature
• Communication