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-pymust be used. Otherwise, it is recommended to install thedockerPython 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_VERSIONwill 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_PATHis set, the fileca.pemfrom the directory specified in the environment variableDOCKER_CERT_PATHwill 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_PATHis set, the filecert.pemfrom the directory specified in the environment variableDOCKER_CERT_PATHwill 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_PATHis set, the filekey.pemfrom the directory specified in the environment variableDOCKER_CERT_PATHwill be used.aliases: tls_client_key, key_path | |
| containers 
                    boolean
                                                                 | 
 | 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
                                                                 | 
 | Debug mode | 
| disk_usage 
                    boolean
                                                                 | 
 | 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 replacetcpin the connection URL withhttps.If the value is not specified in the task, the value of environment variable  DOCKER_HOSTwill be used instead. If the environment variable is not set, the default value will be used.aliases: docker_url | 
| images 
                    boolean
                                                                 | 
 | 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
                                                                 | 
 | 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_VERSIONwill be used instead. | |
| timeout 
                    integer
                                                                 | Default: 60 | 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  DOCKER_TIMEOUTwill be used instead. If the environment variable is not set, the default value will be used. | 
| tls 
                    boolean
                                                                 | 
 | Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. Note that if validate_certs is set to  yesas well, it will take precedence.If the value is not specified in the task, the value of environment variable  DOCKER_TLSwill be used instead. If the environment variable is not set, the default value will be used. | 
| tls_hostname 
                    string
                                                                 | Default: "localhost" | 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  DOCKER_TLS_HOSTNAMEwill be used instead. If the environment variable is not set, the default value will be used. | 
| validate_certs 
                    boolean
                                                                 | 
 | 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  DOCKER_TLS_VERIFYwill be used instead. If the environment variable is not set, the default value will be used.aliases: tls_verify | 
| verbose_output 
                    boolean
                                                                 | 
 | When set to  yesand networks, volumes, images, containers or disk_usage is set toyesthen output will contain verbose information about objects matching the full output of API method. For details see the documentation of your version of Docker API at L(https://docs.docker.com/engine/api/).The verbose output in this module contains only subset of information returned by _info module for each type of the objects. | 
| volumes 
                    boolean
                                                                 | 
 | Whether to list volumes. | 
| volumes_filters 
                    dictionary
                                                                 | A dictionary of filter values used for selecting volumes to list. See the docker documentation for more information on possible filters. | 
Notes¶
Note
- 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_VERIFYandDOCKER_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.
- When connecting to Docker daemon with TLS, you might need to install additional Python packages. For the Docker SDK for Python, version 2.4 or newer, this can be done by installing docker[tls]with pip.
- Note that the Docker SDK for Python only allows to specify the path to the Docker configuration for very few functions. In general, it will use $HOME/.docker/config.jsonif theDOCKER_CONFIGenvironment variable is not specified, and use$DOCKER_CONFIG/config.jsonotherwise.
Examples¶
- name: Get info on docker host
  docker_host_info:
  register: result
- name: Get info on docker host and list images
  docker_host_info:
    images: yes
  register: result
- name: Get info on docker host and list images matching the filter
  docker_host_info:
    images: yes
    images_filters:
      label: "mylabel"
  register: result
- name: Get info on docker host and verbose list images
  docker_host_info:
    images: yes
    verbose_output: yes
  register: result
- name: Get info on docker host and used disk space
  docker_host_info:
    disk_usage: yes
  register: result
- debug:
    var: result.host_info
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Piotr Wojciechowski (@WojciechowskiPiotr)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
