docker_host_info – Retrieves facts about docker host and lists of objects of the services

New in version 2.8.

Synopsis

  • Retrieves facts about a docker host.

  • Essentially returns the output of docker system info.

  • The module also allows to list object names for containers, images, networks and volumes. It also allows to query information on disk usage.

  • The output differs depending on API version of the docker daemon.

  • If the docker daemon cannot be contacted or does not meet the API version requirements, the module will fail.

Requirements

The below requirements are needed on the host that executes this module.

  • Docker API >= 1.21

  • 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 the docker 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.10.0 (use docker-py for Python 2.6)

Parameters

Parameter Choices/Defaults Comments
api_version
string
Default:
"auto"
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 DOCKER_API_VERSION will be used instead. If the environment variable is not set, the default value will be used.

aliases: docker_api_version
ca_cert
path
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 DOCKER_CERT_PATH is set, the file ca.pem from the directory specified in the environment variable DOCKER_CERT_PATH will be used.

aliases: tls_ca_cert, cacert_path
client_cert
path
Path to the client's TLS certificate file.
If the value is not specified in the task and the environment variable DOCKER_CERT_PATH is set, the file cert.pem from the directory specified in the environment variable DOCKER_CERT_PATH will be used.

aliases: tls_client_cert, cert_path
client_key
path
Path to the client's TLS key file.
If the value is not specified in the task and the environment variable DOCKER_CERT_PATH is set, the file key.pem from the directory specified in the environment variable DOCKER_CERT_PATH will be used.

aliases: tls_client_key, key_path
containers
boolean
    Choices:
  • no ←
  • yes
Whether to list containers.
containers_filters
dictionary
A dictionary of filter values used for selecting containers to list.
For example, until: 24h.
See the docker documentation for more information on possible filters.
debug
boolean
    Choices:
  • no ←
  • yes
Debug mode
disk_usage
boolean
    Choices:
  • no ←
  • yes
Summary information on used disk space by all Docker layers.
The output is a sum of images, volumes, containers and build cache.
docker_host
string
Default:
"unix://var/run/docker.sock"
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, tcp://192.0.2.23:2376. If TLS is used to encrypt the connection, the module will automatically replace tcp in the connection URL with https.
If the value is not specified in the task, the value of environment variable DOCKER_HOST will be used instead. If the environment variable is not set, the default value will be used.

aliases: docker_url
images
boolean
    Choices:
  • no ←
  • yes
Whether to list images.
images_filters
dictionary
A dictionary of filter values used for selecting images to list.
For example, dangling: true.
See the docker documentation for more information on possible filters.
networks
boolean
    Choices:
  • no ←
  • yes
Whether to list networks.
networks_filters
dictionary
A dictionary of filter values used for selecting networks to list.
See the docker documentation for more information on possible filters.
ssl_version
string
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 DOCKER_SSL_VERSION will be used instead.
timeout