community.docker.docker_image_info – Inspect docker images
This plugin is part of the community.docker collection (version 2.0.2).
You might already have this collection installed if you are using the
It is not included in
To check whether it is installed, run
ansible-galaxy collection list.
To install it, use:
ansible-galaxy collection install community.docker.
To use it in a playbook, specify:
Provide one or more image names, and the module will inspect each, returning an array of inspection results.
If an image does not exist locally, it will not appear in the results. If you want to check whether an image exists locally, you can call the module with the image name, then check whether the result list is empty (image does not exist) or has one element (the image exists locally).
The module will not attempt to pull images from registries. Use community.docker.docker_image with source set to
pullto ensure an image is pulled.
The below requirements are needed on the host that executes this module.
Docker API >= 1.20
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-pymust be used. Otherwise, it is recommended to install the
dockerPython 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.
This module was called
docker_image_factsbefore Ansible 2.8. The usage did not change.
Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define
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.
When connecting to Docker daemon with TLS, you might need to install additional Python packages. For the Docker SDK for Python, version 2.4 or newer, this can be done by installing
Note that the Docker SDK for Python only allows to specify the path to the Docker configuration for very few functions. In general, it will use
DOCKER_CONFIGenvironment variable is not specified, and use
This module uses the Docker SDK for Python to communicate with the Docker daemon.
- name: Inspect a single image community.docker.docker_image_info: name: pacur/centos-7 - name: Inspect multiple images community.docker.docker_image_info: name: - pacur/centos-7 - sinatra register: result - name: Make sure that both images pacur/centos-7 and sinatra exist locally ansible.builtin.assert: that: - result.images | length == 2
Common return values are documented here, the following are the fields unique to this module: