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 4.8.1).
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 |
|---|---|
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 Default: |
|
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 This option was called |
|
Path to the client’s TLS certificate file. If the value is not specified in the task and the environment variable |
|
Path to the client’s TLS key file. If the value is not specified in the task and the environment variable |
|
Whether to list containers. Choices:
|
|
By default, only running containers are returned. This corresponds to the Choices:
|
|
A dictionary of filter values used for selecting containers to list. For example,
See the docker documentation for more information on possible filters. |
|
Debug mode Choices:
|
|
Summary information on used disk space by all Docker layers. The output is a sum of images, volumes, containers and build cache. Choices:
|
|
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, If the value is not specified in the task, the value of environment variable Default: |
|
Whether to list images. Choices:
|
|
A dictionary of filter values used for selecting images to list. For example,
See the docker documentation for more information on possible filters. |
|
Whether to list networks. Choices:
|
|
A dictionary of filter values used for selecting networks to list.
See the docker documentation for more information on possible filters. |
|
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 Default: |
|
Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. Note that if If the value is not specified in the task, the value of environment variable Choices:
|
|
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 Note that this option had a default value |
|
For SSH transports, use the Choices:
|
|
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 Choices:
|
|
When set to The verbose output in this module contains only subset of information returned by this module for each type of the objects. Choices:
|
|
Whether to list volumes. Choices:
|
|
A dictionary of filter values used for selecting volumes to list.
See the docker documentation for more information on possible filters. |
Attributes
Attribute |
Support |
Description |
|---|---|---|
Action groups: community.docker.docker, docker |
Use |
|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
|
Support: full This action does not modify state. |
When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change. This assumes that the system controlled/queried by the module has not changed in a relevant way. |
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_TLS,DOCKER_TLS_VERIFYandDOCKER_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 |
|---|---|
Will be Returned: both on success and on error |
|
List of dict objects containing the basic information about each container. Keys matches the Returned: When |
|
Information on summary disk usage by images, containers and volumes on docker host unless Returned: When |
|
Facts representing the basic state of the docker host. Matches the Returned: always |
|
List of dict objects containing the basic information about each image. Keys matches the Returned: When |
|
List of dict objects containing the basic information about each network. Keys matches the Returned: When |
|
List of dict objects containing the basic information about each volume. Keys matches the Returned: When |