api.exec_api

Module Contents

Classes

ExecApiMixin()
class ExecApiMixin
exec_create(container, cmd, stdout=True, stderr=True, stdin=False, tty=False, privileged=False, user="", environment=None, workdir=None, detach_keys=None)

Sets up an exec instance in a running container.

Args:
container (str): Target container where exec instance will be
created

cmd (str or list): Command to be executed stdout (bool): Attach to stdout. Default: True stderr (bool): Attach to stderr. Default: True stdin (bool): Attach to stdin. Default: False tty (bool): Allocate a pseudo-TTY. Default: False privileged (bool): Run as privileged. user (str): User to execute command as. Default: root environment (dict or list): A dictionary or a list of strings in

the following format ["PASSWORD=xxx"] or {"PASSWORD": "xxx"}.

workdir (str): Path to working directory for this exec session detach_keys (str): Override the key sequence for detaching

a container. Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _. ~/.docker/config.json is used by default.
Returns:
(dict): A dictionary with an exec Id key.
Raises:
docker.errors.APIError
If the server returns an error.
exec_inspect(exec_id)

Return low-level information about an exec command.

Args:
exec_id (str): ID of the exec instance
Returns:
(dict): Dictionary of values returned by the endpoint.
Raises:
docker.errors.APIError
If the server returns an error.
exec_resize(exec_id, height=None, width=None)

Resize the tty session used by the specified exec command.

Args:
exec_id (str): ID of the exec instance height (int): Height of tty session width (int): Width of tty session
exec_start(exec_id, detach=False, tty=False, stream=False, socket=False)

Start a previously set up exec instance.

Args:

exec_id (str): ID of the exec instance detach (bool): If true, detach from the exec command.

Default: False

tty (bool): Allocate a pseudo-TTY. Default: False stream (bool): Stream response data. Default: False socket (bool): Return the connection socket to allow custom

read/write operations.
Returns:
(generator or str): If stream=True, a generator yielding response chunks. If socket=True, a socket object for the connection. A string containing response data otherwise.
Raises:
docker.errors.APIError
If the server returns an error.