community.docker.docker_container_exec module – Execute command in a docker container
Note
This module is part of the community.docker collection (version 2.7.3).
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_container_exec
.
New in community.docker 1.5.0
Synopsis
Executes a command in a Docker container.
Requirements
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-py
must be used. Otherwise, it is recommended to install thedocker
Python 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.Docker SDK for Python >= 1.8.0 (use docker-py for Python 2.6)
Parameters
Parameter |
Comments |
---|---|
The version of the Docker API running on the Docker Host. Defaults to the latest version of the API supported by Docker SDK for Python and the docker daemon. If the value is not specified in the task, the value of environment variable Default: |
|
The command to execute. Since this is a list of arguments, no quoting is needed. Exactly one of argv and command must be specified. |
|
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 directory to run the command in. |
|
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 |
|
The command to execute. Exactly one of argv and command must be specified. |
|
The name of the container to execute the command in. |
|
Debug mode Choices:
|
|
Whether to run the command synchronously (detach=false, default) or asynchronously (detach=true). If set to 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: |
|
Dictionary of environment variables with their respective values to be passed to the command ran inside the container. Values which might be parsed as numbers, booleans or other types by the YAML parser must be quoted (for example Please note that if you are passing values in with Jinja2 templates, like |
|
Provide a valid SSL version number. Default value determined by ssl.py module. If the value is not specified in the task, the value of environment variable |
|
Set the stdin of the command directly to the specified value. Can only be used if detach=false. |
|
If set to Choices:
|
|
Strip empty lines from the end of stdout/stderr in result. Choices:
|
|
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 validate_certs is set to 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 The current default value is |
|
Whether to allocate a TTY. Choices:
|
|
For SSH transports, use the Requires Docker SDK for Python 4.4.0 or newer. Choices:
|
|
If specified, the user to execute this command with. |
|
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:
|
Notes
Note
Does not support
check_mode
.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_SSL_VERSION
,DOCKER_TLS
,DOCKER_TLS_VERIFY
andDOCKER_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
docker[tls]
with ansible.builtin.pip.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
$HOME/.docker/config.json
if theDOCKER_CONFIG
environment variable is not specified, and use$DOCKER_CONFIG/config.json
otherwise.This module uses the Docker SDK for Python to communicate with the Docker daemon.
Examples
- name: Run a simple command (command)
community.docker.docker_container_exec:
container: foo
command: /bin/bash -c "ls -lah"
chdir: /root
register: result
- name: Print stdout
debug:
var: result.stdout
- name: Run a simple command (argv)
community.docker.docker_container_exec:
container: foo
argv:
- /bin/bash
- "-c"
- "ls -lah > /dev/stderr"
chdir: /root
register: result
- name: Print stderr lines
debug:
var: result.stderr_lines
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The execution ID of the command. Returned: success and detach=true Sample: |
|
The exit code of the command. Returned: success and detach=false Sample: |
|
The standard error output of the container command. Returned: success and detach=false |
|
The standard output of the container command. Returned: success and detach=false |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication