community.docker.docker_container_info 模块 – 获取 Docker 容器的信息

注意

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

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

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

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

概要

  • 获取有关 Docker 容器的信息。

  • 本质上返回 docker inspect <name> 的输出，类似于 community.docker.docker_container 为非缺席容器返回的内容。

要求

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

  • 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。

debug

布尔值

调试模式

选项

  • 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"

name

字符串 / 必需

要检查的容器的名称。

在识别现有容器时，名称可以是容器的名称、长 ID 或短 ID。

timeout

整数

等待 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 加密与 API 的连接并验证 Docker 主机服务器的真实性。

如果在任务中未指定该值，则将使用环境变量 DOCKER_TLS_VERIFY 的值。如果未设置环境变量，则将使用默认值。

选项

  • false ←（默认）

  • true

属性

属性

支持

描述

action_group

操作组: community.docker.docker, docker

在 module_defaults 中使用 group/docker 或 group/community.docker.docker 为此模块设置默认值。

check_mode

支持: 完全

此操作不会修改状态。

可以在 check_mode 中运行并返回已更改的状态预测，而无需修改目标。

diff_mode

支持: 不适用

此操作不会修改状态。

当处于差异模式时，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

备注

注意

示例

- name: Get infos on container
  community.docker.docker_container_info:
    name: mydata
  register: result

- name: Does container exist?
  ansible.builtin.debug:
    msg: "The container {{ 'exists' if result.exists else 'does not exist' }}"

- name: Print information about container
  ansible.builtin.debug:
    var: result.container
  when: result.exists

返回值

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

键

描述

container

字典

表示容器当前状态的事实。与 docker inspect 输出匹配。

如果容器不存在，则为 none。

返回: 始终

示例: "{ \"AppArmorProfile\": \"\", \"Args\": [], \"Config\": { \"AttachStderr\": false, \"AttachStdin\": false, \"AttachStdout\": false, \"Cmd\": [ \"/usr/bin/supervisord\" ], \"Domainname\": \"\", \"Entrypoint\": null, \"Env\": [ \"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin\" ], \"ExposedPorts\": { \"443/tcp\": {}, \"80/tcp\": {} }, \"Hostname\": \"8e47bf643eb9\", \"Image\": \"lnmp_nginx:v1\", \"Labels\": {}, \"OnBuild\": null, \"OpenStdin\": false, \"StdinOnce\": false, \"Tty\": false, \"User\": \"\", \"Volumes\": { \"/tmp/lnmp/nginx-sites/logs/\": {} }, ... }"

exists

布尔值

返回容器是否存在。

返回: 始终

示例: true

作者

  • Felix Fontein (@felixfontein)