community / community.docker / 3.5.0 / module / docker_host_info Retrieves facts about docker host and lists of objects of the services. Authors: Piotr Wojciechowski (@WojciechowskiPiotr)community.docker.docker_host_info (3.5.0) — module
Install with ansible-galaxy collection install community.docker:==3.5.0
collections: - name: community.docker version: 3.5.0
Retrieves facts about a docker host.
Essentially returns the output of C(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.
- name: Get info on docker host community.docker.docker_host_info: register: result
- name: Get info on docker host and list images community.docker.docker_host_info: images: true register: result
- name: Get info on docker host and list images matching the filter community.docker.docker_host_info: images: true images_filters: label: "mylabel" register: result
- name: Get info on docker host and verbose list images community.docker.docker_host_info: images: true verbose_output: true register: result
- name: Get info on docker host and used disk space community.docker.docker_host_info: disk_usage: true register: result
- name: Get info on docker host and list containers matching the filter community.docker.docker_host_info: containers: true containers_filters: label: - key1=value1 - key2=value2 register: result
- name: Show host information ansible.builtin.debug: var: result.host_info
tls: default: false description: - Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. Note that if O(validate_certs) is set to V(true) as well, it will take precedence. - If the value is not specified in the task, the value of environment variable E(DOCKER_TLS) will be used instead. If the environment variable is not set, the default value will be used. type: bool debug: default: false description: - Debug mode type: bool images: default: false description: - Whether to list images. type: bool ca_cert: aliases: - tls_ca_cert - cacert_path description: - 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 E(DOCKER_CERT_PATH) is set, the file C(ca.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used. type: path timeout: default: 60 description: - 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 E(DOCKER_TIMEOUT) will be used instead. If the environment variable is not set, the default value will be used. type: int volumes: default: false description: - Whether to list volumes. type: bool networks: default: false description: - Whether to list networks. type: bool client_key: aliases: - tls_client_key - key_path description: - Path to the client's TLS key file. - If the value is not specified in the task and the environment variable E(DOCKER_CERT_PATH) is set, the file C(key.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used. type: path containers: default: false description: - Whether to list containers. type: bool disk_usage: default: false description: - Summary information on used disk space by all Docker layers. - The output is a sum of images, volumes, containers and build cache. type: bool api_version: aliases: - docker_api_version default: auto description: - The version of the Docker API running on the Docker Host. - Defaults to the latest version of the API supported by this collection and the docker daemon. - If the value is not specified in the task, the value of environment variable E(DOCKER_API_VERSION) will be used instead. If the environment variable is not set, the default value will be used. type: str client_cert: aliases: - tls_client_cert - cert_path description: - Path to the client's TLS certificate file. - If the value is not specified in the task and the environment variable E(DOCKER_CERT_PATH) is set, the file C(cert.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used. type: path docker_host: aliases: - docker_url default: unix://var/run/docker.sock description: - 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, V(tcp://192.0.2.23:2376). If TLS is used to encrypt the connection, the module will automatically replace C(tcp) in the connection URL with C(https). - If the value is not specified in the task, the value of environment variable E(DOCKER_HOST) will be used instead. If the environment variable is not set, the default value will be used. type: str ssl_version: description: - Provide a valid SSL version number. Default value determined by L(SSL Python module, https://docs.python.org/3/library/ssl.html). - If the value is not specified in the task, the value of environment variable E(DOCKER_SSL_VERSION) will be used instead. type: str tls_hostname: description: - 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 E(DOCKER_TLS_HOSTNAME) will be used instead. If the environment variable is not set, the default value will be used. - Note that this option had a default value V(localhost) in older versions. It was removed in community.docker 3.0.0. type: str containers_all: default: false description: - By default, only running containers are returned. - This corresponds to the C(--all) option to C(docker container list). type: bool version_added: 3.4.0 version_added_collection: community.docker images_filters: description: - A dictionary of filter values used for selecting images to list. - 'For example, C(dangling: true).' - C(label) is a special case of filter which can be a string C(<key>) matching when a label is present, a string C(<key>=<value>) matching when a label has a particular value, or a list of strings C(<key>)/C(<key>=<value). - See L(the docker documentation,https://docs.docker.com/engine/reference/commandline/image_prune/#filtering) for more information on possible filters. type: dict use_ssh_client: default: false description: - For SSH transports, use the C(ssh) CLI tool instead of paramiko. type: bool version_added: 1.5.0 version_added_collection: community.docker validate_certs: aliases: - tls_verify default: false description: - 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 E(DOCKER_TLS_VERIFY) will be used instead. If the environment variable is not set, the default value will be used. type: bool verbose_output: default: false description: - When set to V(true) and O(networks), O(volumes), O(images), O(containers), or O(disk_usage) is set to V(true) then 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 U(https://docs.docker.com/engine/api/). - The verbose output in this module contains only subset of information returned by this module for each type of the objects. type: bool volumes_filters: description: - A dictionary of filter values used for selecting volumes to list. - C(label) is a special case of filter which can be a string C(<key>) matching when a label is present, a string C(<key>=<value>) matching when a label has a particular value, or a list of strings C(<key>)/C(<key>=<value). - See L(the docker documentation,https://docs.docker.com/engine/reference/commandline/volume_prune/#filtering) for more information on possible filters. type: dict networks_filters: description: - A dictionary of filter values used for selecting networks to list. - C(label) is a special case of filter which can be a string C(<key>) matching when a label is present, a string C(<key>=<value>) matching when a label has a particular value, or a list of strings C(<key>)/C(<key>=<value). - See L(the docker documentation,https://docs.docker.com/engine/reference/commandline/network_prune/#filtering) for more information on possible filters. type: dict containers_filters: description: - A dictionary of filter values used for selecting containers to list. - 'For example, C(until: 24h).' - C(label) is a special case of filter which can be a string C(<key>) matching when a label is present, a string C(<key>=<value>) matching when a label has a particular value, or a list of strings C(<key>)/C(<key>=<value). - See L(the docker documentation,https://docs.docker.com/engine/reference/commandline/container_prune/#filtering) for more information on possible filters. type: dict
can_talk_to_docker: description: - Will be V(true) if the module can talk to the docker daemon. returned: both on success and on error type: bool containers: description: - List of dict objects containing the basic information about each container. Keys matches the C(docker container ls) output unless O(verbose_output=true). See description for O(verbose_output). elements: dict returned: When O(containers=true) type: list disk_usage: description: - Information on summary disk usage by images, containers and volumes on docker host unless O(verbose_output=true). See description for O(verbose_output). returned: When O(disk_usage=true) type: dict host_info: description: - Facts representing the basic state of the docker host. Matches the C(docker system info) output. returned: always type: dict images: description: - List of dict objects containing the basic information about each image. Keys matches the C(docker image ls) output unless O(verbose_output=true). See description for O(verbose_output). elements: dict returned: When O(images=true) type: list networks: description: - List of dict objects containing the basic information about each network. Keys matches the C(docker network ls) output unless O(verbose_output=true). See description for O(verbose_output). elements: dict returned: When O(networks=true) type: list volumes: description: - List of dict objects containing the basic information about each volume. Keys matches the C(docker volume ls) output unless O(verbose_output=true). See description for O(verbose_output). elements: dict returned: When O(volumes=true) type: list