community.docker.docker_host_info 模块 – 获取 Docker 主机信息和服务对象列表。

注意

此模块是 community.docker 集合 (版本 4.1.0) 的一部分。

如果您使用的是 ansible 软件包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.docker。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：community.docker.docker_host_info。

概要 

检索有关 Docker 主机的信息。
基本上返回 docker system info 的输出。
此模块还允许列出容器、镜像、网络和卷的对象名称。它还允许查询磁盘使用情况信息。
输出根据 Docker 守护程序的 API 版本而有所不同。
如果无法联系 Docker 守护程序或不满足 API 版本要求，则模块将失败。

要求 

执行此模块的主机需要以下要求。

Docker API >= 1.25
backports.ssl_match_hostname（在 Python 2 上使用 TLS 时）
paramiko（在使用 SSH 和 use_ssh_client=false 时）
pyOpenSSL（在使用 TLS 时）
pywin32（在 Windows 32 上使用命名管道时）
requests

参数 

参数	注释
api_version 别名：docker_api_version 字符串	Docker 主机上运行的 Docker API 版本。默认为此集合和 Docker 守护程序支持的最新 API 版本。如果任务中未指定该值，则将改用环境变量 `DOCKER_API_VERSION` 的值。如果未设置环境变量，则将使用默认值。默认值： `"auto"`
ca_path 别名：ca_cert, tls_ca_cert, cacert_path 路径	通过提供 CA 证书文件的路径来执行服务器验证时使用 CA 证书。如果任务中未指定该值并且设置了环境变量 `DOCKER_CERT_PATH`，则将使用环境变量 `DOCKER_CERT_PATH` 中指定的目录中的 `ca.pem` 文件。此选项以前称为 `ca_cert`，并在 community.docker 3.6.0 中重命名为 `ca_path`。旧名称已添加为别名，仍然可以使用。
client_cert 别名：tls_client_cert, cert_path 路径	客户端 TLS 证书文件的路径。如果任务中未指定该值并且设置了环境变量 `DOCKER_CERT_PATH`，则将使用环境变量 `DOCKER_CERT_PATH` 中指定的目录中的 `cert.pem` 文件。
client_key 别名：tls_client_key, key_path 路径	客户端 TLS 密钥文件的路径。如果任务中未指定值且环境变量`DOCKER_CERT_PATH`已设置，则将使用环境变量`DOCKER_CERT_PATH` 指定目录中的`key.pem`文件。
容器布尔值	是否列出容器。选项 `false` ← (默认) `true`
containers_all 布尔值在 community.docker 3.4.0 中添加	默认情况下，只返回正在运行的容器。这对应于`docker container list`的`--all`选项。选项 `false` ← (默认) `true`
containers_filters 字典	用于选择要列出的容器的过滤器值字典。例如，`until: 24h`。 `label`是过滤器的特例，可以是字符串`<key>`（存在标签时匹配），字符串`<key>=<value>`（标签具有特定值时匹配），或字符串列表`<key>`/`<key>=<value`。有关可能的过滤器的更多信息，请参阅Docker 文档。
debug 布尔值	调试模式选项 `false` ← (默认) `true`
disk_usage 布尔值	所有 Docker 层使用的磁盘空间的摘要信息。输出是镜像、卷、容器和构建缓存的总和。选项 `false` ← (默认) `true`
docker_host 别名：docker_url 字符串	用于连接到 Docker API 的 URL 或 Unix 套接字路径。要连接到远程主机，请提供 TCP 连接字符串。例如，`tcp://192.0.2.23:2376`。如果使用 TLS 加密连接，模块将自动将连接 URL 中的`tcp`替换为`https`。如果任务中未指定值，则将使用环境变量`DOCKER_HOST`的值。如果未设置环境变量，则将使用默认值。默认值： `"unix:///var/run/docker.sock"`
镜像布尔值	是否列出镜像。选项 `false` ← (默认) `true`
images_filters 字典	用于选择要列出的镜像的过滤器值字典。例如，`dangling: true`。 `label`是过滤器的特例，可以是字符串`<key>`（存在标签时匹配），字符串`<key>=<value>`（标签具有特定值时匹配），或字符串列表`<key>`/`<key>=<value`。有关可能的过滤器的更多信息，请参阅Docker 文档。
网络布尔值	是否列出网络。选项 `false` ← (默认) `true`
networks_filters 字典	用于选择要列出的网络的过滤器值字典。 `label`是过滤器的特例，可以是字符串`<key>`（存在标签时匹配），字符串`<key>=<value>`（标签具有特定值时匹配），或字符串列表`<key>`/`<key>=<value`。有关可能的过滤器的更多信息，请参阅Docker 文档。
超时整数	等待 API 响应的最大时间（秒）。如果任务中未指定值，则将使用环境变量`DOCKER_TIMEOUT`的值。如果未设置环境变量，则将使用默认值。默认值： `60`
tls 布尔值	通过使用 TLS 安全地连接到 API，而无需验证 Docker 主机服务器的身份。请注意，如果`validate_certs`也设置为`true`，则它将优先。如果任务中未指定值，则将使用环境变量`DOCKER_TLS`的值。如果未设置环境变量，则将使用默认值。选项 `false` ← (默认) `true`
tls_hostname 字符串	验证 Docker 主机服务器的身份时，请提供服务器的预期名称。如果任务中未指定值，则将使用环境变量`DOCKER_TLS_HOSTNAME`的值。如果未设置环境变量，则将使用默认值。请注意，此选项在较旧版本中具有默认值`localhost`。它已在 community.docker 3.0.0 中删除。
use_ssh_client 布尔值在 community.docker 1.5.0 中添加	对于 SSH 传输，使用`ssh` CLI 工具而不是 paramiko。选项 `false` ← (默认) `true`
validate_certs 别名：tls_verify 布尔值	通过使用 TLS 并验证 Docker 主机服务器的身份来保护与 API 的连接。如果任务中未指定值，则将使用环境变量`DOCKER_TLS_VERIFY`的值。如果未设置环境变量，则将使用默认值。选项 `false` ← (默认) `true`
verbose_output 布尔值	设置为`true`且`networks`、`volumes`、`images`、`containers`或`disk_usage`设置为`true`时，输出将包含有关与 API 方法完整输出匹配的对象的详细信息。有关详细信息，请参阅 https://docs.dockerd.com.cn/engine/api/ 上的 Docker API 版本文档。此模块中的详细输出仅包含此模块为每种类型的对象返回的信息的子集。选项 `false` ← (默认) `true`
卷布尔值	是否列出卷。选项 `false` ← (默认) `true`
volumes_filters 字典	用于选择要列出的卷的过滤器值字典。 `label`是过滤器的特例，可以是字符串`<key>`（存在标签时匹配），字符串`<key>=<value>`（标签具有特定值时匹配），或字符串列表`<key>`/`<key>=<value`。有关可能的过滤器的更多信息，请参阅Docker 文档。

属性 

属性	支持	描述
action_group	动作组： community.docker.docker, docker	在`module_defaults`中使用`group/docker`或`group/community.docker.docker`为该模块设置默认值。
check_mode	支持：完全支持此操作不会修改状态。	可以在`check_mode`下运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持： N/A 此操作不会修改状态。	在差异模式下，将返回有关已更改内容（或可能需要在`check_mode`中更改的内容）的详细信息。

备注 

注意

通过为每个任务提供参数或定义环境变量来连接到 Docker 守护程序。您可以定义DOCKER_HOST、DOCKER_TLS_HOSTNAME、DOCKER_API_VERSION、DOCKER_CERT_PATH、DOCKER_TLS、DOCKER_TLS_VERIFY和DOCKER_TIMEOUT。如果您使用的是 Docker Machine，请运行产品附带的设置环境的脚本。它将为您设置这些变量。有关更多详细信息，请参阅https://docs.dockerd.com.cn/machine/reference/env/。
此模块**不**使用Docker SDK for Python与 Docker 守护程序进行通信。它使用来自 Docker SDK 或 Python 的代码（包含在此集合中）。

示例 

- 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

返回值 

常见返回值已在此处记录，以下是此模块特有的字段

键	描述
can_talk_to_docker 布尔值	如果模块可以与 Docker 守护程序通信，则为`true`。返回：成功和错误时都返回
容器列表 / 元素=字典	包含每个容器基本信息的字典对象列表。除非`verbose_output=true`，否则键与`docker container ls`的输出匹配。请参阅`verbose_output`的说明。返回：当`containers=true`时
disk_usage 字典	关于Docker主机上镜像、容器和卷的磁盘使用情况摘要信息，除非`verbose_output=true`。请参阅`verbose_output`的说明。返回：当`disk_usage=true`时
host_info 字典	表示Docker主机基本状态的事实信息。与`docker system info`的输出匹配。返回：始终返回
镜像列表 / 元素=字典	包含每个镜像基本信息的字典对象列表。除非`verbose_output=true`，否则键与`docker image ls`的输出匹配。请参阅`verbose_output`的说明。返回：当`images=true`时
网络列表 / 元素=字典	包含每个网络基本信息的字典对象列表。除非`verbose_output=true`，否则键与`docker network ls`的输出匹配。请参阅`verbose_output`的说明。返回：当`networks=true`时
卷列表 / 元素=字典	包含每个卷基本信息的字典对象列表。除非`verbose_output=true`，否则键与`docker volume ls`的输出匹配。请参阅`verbose_output`的说明。返回：当`volumes=true`时

作者

Piotr Wojciechowski (@WojciechowskiPiotr)

参数	注释
api_version 别名：docker_api_version 字符串	Docker 主机上运行的 Docker API 版本。默认为此集合和 Docker 守护程序支持的最新 API 版本。如果任务中未指定该值，则将改用环境变量 `DOCKER_API_VERSION` 的值。如果未设置环境变量，则将使用默认值。默认值： `"auto"`
ca_path 别名：ca_cert, tls_ca_cert, cacert_path 路径	通过提供 CA 证书文件的路径来执行服务器验证时使用 CA 证书。如果任务中未指定该值并且设置了环境变量 `DOCKER_CERT_PATH`，则将使用环境变量 `DOCKER_CERT_PATH` 中指定的目录中的 `ca.pem` 文件。此选项以前称为 `ca_cert`，并在 community.docker 3.6.0 中重命名为 `ca_path`。旧名称已添加为别名，仍然可以使用。
client_cert 别名：tls_client_cert, cert_path 路径	客户端 TLS 证书文件的路径。如果任务中未指定该值并且设置了环境变量 `DOCKER_CERT_PATH`，则将使用环境变量 `DOCKER_CERT_PATH` 中指定的目录中的 `cert.pem` 文件。
client_key 别名：tls_client_key, key_path 路径	客户端 TLS 密钥文件的路径。如果任务中未指定值且环境变量`DOCKER_CERT_PATH`已设置，则将使用环境变量`DOCKER_CERT_PATH` 指定目录中的`key.pem`文件。
容器布尔值	是否列出容器。选项 `false` ← (默认) `true`
containers_all 布尔值在 community.docker 3.4.0 中添加	默认情况下，只返回正在运行的容器。这对应于`docker container list`的`--all`选项。选项 `false` ← (默认) `true`
containers_filters 字典	用于选择要列出的容器的过滤器值字典。例如，`until: 24h`。 `label`是过滤器的特例，可以是字符串`<key>`（存在标签时匹配），字符串`<key>=<value>`（标签具有特定值时匹配），或字符串列表`<key>`/`<key>=<value`。有关可能的过滤器的更多信息，请参阅Docker 文档。
debug 布尔值	调试模式选项 `false` ← (默认) `true`
disk_usage 布尔值	所有 Docker 层使用的磁盘空间的摘要信息。输出是镜像、卷、容器和构建缓存的总和。选项 `false` ← (默认) `true`
docker_host 别名：docker_url 字符串	用于连接到 Docker API 的 URL 或 Unix 套接字路径。要连接到远程主机，请提供 TCP 连接字符串。例如，`tcp://192.0.2.23:2376`。如果使用 TLS 加密连接，模块将自动将连接 URL 中的`tcp`替换为`https`。如果任务中未指定值，则将使用环境变量`DOCKER_HOST`的值。如果未设置环境变量，则将使用默认值。默认值： `"unix:///var/run/docker.sock"`
镜像布尔值	是否列出镜像。选项 `false` ← (默认) `true`
images_filters 字典	用于选择要列出的镜像的过滤器值字典。例如，`dangling: true`。 `label`是过滤器的特例，可以是字符串`<key>`（存在标签时匹配），字符串`<key>=<value>`（标签具有特定值时匹配），或字符串列表`<key>`/`<key>=<value`。有关可能的过滤器的更多信息，请参阅Docker 文档。
网络布尔值	是否列出网络。选项 `false` ← (默认) `true`
networks_filters 字典	用于选择要列出的网络的过滤器值字典。 `label`是过滤器的特例，可以是字符串`<key>`（存在标签时匹配），字符串`<key>=<value>`（标签具有特定值时匹配），或字符串列表`<key>`/`<key>=<value`。有关可能的过滤器的更多信息，请参阅Docker 文档。
超时整数	等待 API 响应的最大时间（秒）。如果任务中未指定值，则将使用环境变量`DOCKER_TIMEOUT`的值。如果未设置环境变量，则将使用默认值。默认值： `60`
tls 布尔值	通过使用 TLS 安全地连接到 API，而无需验证 Docker 主机服务器的身份。请注意，如果`validate_certs`也设置为`true`，则它将优先。如果任务中未指定值，则将使用环境变量`DOCKER_TLS`的值。如果未设置环境变量，则将使用默认值。选项 `false` ← (默认) `true`
tls_hostname 字符串	验证 Docker 主机服务器的身份时，请提供服务器的预期名称。如果任务中未指定值，则将使用环境变量`DOCKER_TLS_HOSTNAME`的值。如果未设置环境变量，则将使用默认值。请注意，此选项在较旧版本中具有默认值`localhost`。它已在 community.docker 3.0.0 中删除。
use_ssh_client 布尔值在 community.docker 1.5.0 中添加	对于 SSH 传输，使用`ssh` CLI 工具而不是 paramiko。选项 `false` ← (默认) `true`
validate_certs 别名：tls_verify 布尔值	通过使用 TLS 并验证 Docker 主机服务器的身份来保护与 API 的连接。如果任务中未指定值，则将使用环境变量`DOCKER_TLS_VERIFY`的值。如果未设置环境变量，则将使用默认值。选项 `false` ← (默认) `true`
verbose_output 布尔值	设置为`true`且`networks`、`volumes`、`images`、`containers`或`disk_usage`设置为`true`时，输出将包含有关与 API 方法完整输出匹配的对象的详细信息。有关详细信息，请参阅 https://docs.dockerd.com.cn/engine/api/ 上的 Docker API 版本文档。此模块中的详细输出仅包含此模块为每种类型的对象返回的信息的子集。选项 `false` ← (默认) `true`
卷布尔值	是否列出卷。选项 `false` ← (默认) `true`
volumes_filters 字典	用于选择要列出的卷的过滤器值字典。 `label`是过滤器的特例，可以是字符串`<key>`（存在标签时匹配），字符串`<key>=<value>`（标签具有特定值时匹配），或字符串列表`<key>`/`<key>=<value`。有关可能的过滤器的更多信息，请参阅Docker 文档。