community.docker.docker_container_exec module – Execute command in a docker container
Note
This module is part of the community.docker collection (version 3.13.1).
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.25
backports.ssl_match_hostname (when using TLS on Python 2)
paramiko (when using SSH with
use_ssh_client=false
)pyOpenSSL (when using TLS)
pywin32 (when using named pipes on Windows 32)
requests
Parameters
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 This option was called |
|
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 name of the container to execute the command in. |
|
Debug mode Choices:
|
|
Whether to run the command synchronously ( 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 Python 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 |
|
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 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 Note that this option had a default value |
|
Whether to allocate a TTY. Choices:
|
|
For SSH transports, use the 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:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Action groups: community.docker.docker, docker |
Use |
|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
Does not work with TCP TLS sockets when using
stdin
. This is caused by the inability to sendclose_notify
without closing the connection with Python’sSSLSocket
s. See https://github.com/ansible-collections/community.docker/issues/605 for more information.If you need to evaluate environment variables of the container in
command
orargv
, you need to pass the command through a shell, likecommand=/bin/sh -c "echo $ENV_VARIABLE"
.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.This module does not use the Docker SDK for Python to communicate with the Docker daemon. It uses code derived from the Docker SDK or Python that is included in this collection.
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
ansible.builtin.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
ansible.builtin.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 Sample: |
|
The standard error output of the container command. Returned: success and |
|
The standard output of the container command. Returned: success and |