community.general.docker_prune – Allows to prune various docker objects¶
This plugin is part of the community.general collection (version 1.3.6).
To install it use:
ansible-galaxy collection install community.general.
To use it in a playbook, specify:
Allows to run
docker container prune,
docker image prune,
docker network pruneand
docker volume prunevia the Docker API.
The below requirements are needed on the host that executes this module.
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
- name: Prune containers older than 24h community.general.docker_prune: containers: yes containers_filters: # only consider containers created more than 24 hours ago until: 24h - name: Prune everything community.general.docker_prune: containers: yes images: yes networks: yes volumes: yes builder_cache: yes - name: Prune everything (including non-dangling images) community.general.docker_prune: containers: yes images: yes images_filters: dangling: false networks: yes volumes: yes builder_cache: yes
Common return values are documented here, the following are the fields unique to this module: