community.docker.docker_plugin – Manage Docker plugins
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:
New in version 1.3.0: of community.docker
This module allows to install, delete, enable and disable Docker plugins.
Performs largely the same function as the
docker pluginCLI subcommand.
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
This module uses the Docker SDK for Python to communicate with the Docker daemon.
- name: Install a plugin community.docker.docker_plugin: plugin_name: plugin_one state: present - name: Remove a plugin community.docker.docker_plugin: plugin_name: plugin_one state: absent - name: Enable the plugin community.docker.docker_plugin: plugin_name: plugin_one state: enable - name: Disable the plugin community.docker.docker_plugin: plugin_name: plugin_one state: disable - name: Install a plugin with options community.docker.docker_plugin: plugin_name: weaveworks/net-plugin:latest_release plugin_options: IPALLOC_RANGE: "10.32.0.0/12" WEAVE_PASSWORD: "PASSWORD"
Common return values are documented here, the following are the fields unique to this module:
list / elements=string
List of actions performed during task execution.
Plugin inspection results for the affected plugin.