This module is part of the community.docker collection (version 3.6.0-b2).
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.
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_stack_info.
Retrieve information on docker stacks using the docker stack command on the target node (see examples).
The below requirements are needed on the host that executes this module.
+Docker CLI tool docker
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 |
+
| + | The Docker CLI context to use. + |
+
| + | 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 |
+
| + | Path to the Docker CLI. If not provided, will search for Docker CLI on the |
+
| + | 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: |
+
| + | 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 |
+
| + | 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: +
|
+
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_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 directly calls the Docker CLI program.
See also
- name: Shows stack info
community.docker.docker_stack_info:
register: result
@@ -244,7 +407,7 @@ Examples
-Return Values
+Return Values
Common return values are documented here, the following are the fields unique to this module:
+
+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_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 directly calls the Docker CLI program.
+
+
-Examples
+Examples
- name: Deploy stack from a compose file
community.docker.docker_stack:
state: present
@@ -353,7 +492,7 @@ Examples
-Return Values
+Return Values
Common return values are documented here, the following are the fields unique to this module: