
since ( UTC datetime or int) – Get events from this point. close ( ) ¶Ĭloses all adapters and as such the session df ( ) ¶Ī dictionary representing different resource categoriesĭ – If the server returns an error. volumes ¶Īn object for managing volumes on the server. swarm ¶Īn object for managing a swarm on the server. services ¶Īn object for managing services on the server. secrets ¶Īn object for managing secrets on the server.
plugins ¶Īn object for managing plugins on the server. nodes ¶Īn object for managing nodes on the server. networks ¶Īn object for managing networks on the server. images ¶Īn object for managing images on the server.
#Docker tcp api full#
See theĬontainers documentation for full details. containers ¶Īn object for managing containers on the server. See theĬonfigs documentation for full details. Ensure the ssh client isĪn object for managing configs on the server.
use_ssh_client ( bool) – If set to True, an ssh connection is made. credstore_env ( dict) – Override environment variables when calling the. user_agent ( str) – Set a custom user agent for requests to the server. True to enable it with default options, or pass a Unix:///var/run/docker.sock or tcp://127.0.0.1:1234.Īutomatically detect the server’s version. base_url ( str) – URL to the Docker server. DockerClient ( base_url = 'unix://var/run/docker.sock' ) Parameters: Ensure the sshĬlient is installed and configured on the host. use_ssh_client ( bool) – If set to True, an ssh connection is. credstore_env ( dict) – Override environment variables when calling. environment ( dict) – The environment to read environment variables. assert_hostname ( bool) – Verify the hostname of the server.
ssl_version ( int) – A valid SSL version. max_pool_size ( int) – The maximum number of connections. timeout ( int) – Default timeout for API calls, in seconds. Set to auto toĪutomatically detect the server’s version. version ( str) – The version of the API to use. DOCKER_CERT_PATH ¶Ī path to a directory containing TLS certificates to use whenĬonnecting to the Docker host. Verify the host against a CA certificate. The environment variables used are the same as those used by theĭocker command-line client. Return a client configured from environment variables. It can also be configured manually by instantiating a DockerClient class. The easiest way to do that is by calling the function from_env(). To communicate with the Docker daemon, you first need to instantiate a client.