View Source DockerEngineAPI.Api.Exec (docker_engine_api v1.43.0)
API calls for all endpoints tagged Exec
.
Summary
Functions
Create an exec instance Run a command inside a running container.
Inspect an exec instance Return low-level information about an exec instance.
Resize an exec instance Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance.
Start an exec instance Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.
Functions
Create an exec instance Run a command inside a running container.
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- exec_config (ExecConfig): Exec configuration
- id (String.t): ID or name of container
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Inspect an exec instance Return low-level information about an exec instance.
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- id (String.t): Exec instance ID
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Resize an exec instance Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance.
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- id (String.t): Exec instance ID
- opts (KeywordList): [optional] Optional parameters
- :h (integer()): Height of the TTY session in characters
- :w (integer()): Width of the TTY session in characters
Returns
} on success {:error, info} on failure
Start an exec instance Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- id (String.t): Exec instance ID
- opts (KeywordList): [optional] Optional parameters
- :exec_start_config (ExecStartConfig):
Returns
} on success {:error, info} on failure