community.docker.docker_node_info 模块 – 从 Swarm Manager 获取 Docker Swarm 节点信息

注意

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

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

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

要在剧本中使用它，请指定： community.docker.docker_node_info。

概要

  • 检索有关 Docker 节点的信息。

  • 基本上返回 docker node inspect <name> 的输出。

  • 必须在作为 Swarm Manager 运行的主机上执行，否则模块将失败。

要求

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

  • Docker API >= 1.25

  • Python 的 Docker SDK：请注意，docker-py Python 模块已被 docker 取代（详细信息请参见 此处）。请注意，这两个模块不应同时安装。另请注意，当同时安装这两个模块并卸载其中一个时，另一个可能无法再运行，需要重新安装。

  • Python 的 Docker SDK >= 2.4.0

参数

参数

注释

api_version

别名：docker_api_version

字符串

Docker 主机上运行的 Docker API 的版本。

默认为 Python 的 Docker SDK 和 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"

名称

列表 / 元素=字符串

要检查的节点名称。

要检查的节点名称列表。

如果为空，则返回 Swarm 集群中所有节点的信息。

标识节点时，可以使用节点的主机名（在 Swarm 中注册）或节点 ID。

如果 self=true，则忽略此参数。

自身

布尔值

如果 true，则查询模块与其通信的节点（即 Docker 守护程序）。

如果 true，则忽略 name。

如果 false，则查询取决于 name 的存在和值。

选项

  • false ← (默认)

  • true

超时

整数

等待 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 中删除。

注意：此选项不再支持 Docker SDK for Python 7.0.0+。使用 Docker SDK for Python 7.0.0 或更高版本指定它将导致错误。

use_ssh_client

布尔值

在 community.docker 1.5.0 中添加

对于 SSH 传输，请使用 ssh CLI 工具而不是 paramiko。

需要 Docker SDK for Python 4.4.0 或更高版本。

选项

  • false ← (默认)

  • true

validate_certs

别名：tls_verify

布尔值

通过使用 TLS 并验证 Docker 主机服务器的真实性来保护与 API 的连接。

如果任务中未指定此值，则将使用环境变量 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

支持： N/A

此操作不会修改状态。

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

注释

注意

示例

- name: Get info on all nodes
  community.docker.docker_node_info:
  register: result

- name: Get info on node
  community.docker.docker_node_info:
    name: mynode
  register: result

- name: Get info on list of nodes
  community.docker.docker_node_info:
    name:
      - mynode1
      - mynode2
  register: result

- name: Get info on host if it is Swarm Manager
  community.docker.docker_node_info:
    self: true
  register: result

返回值

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

键

描述

节点

列表 / 元素=字典

表示节点当前状态的事实。与 docker node inspect 输出匹配。

如果 name 中提供了多个节点，或者未提供 name，则可能包含多个条目。

如果 name 包含节点列表，则输出将提供有关在 swarm 中注册的所有节点的信息，包括已离开 swarm 但尚未从 swarm 管理器上的集群中删除的节点以及无法访问的节点。

返回：始终

作者

  • Piotr Wojciechowski (@WojciechowskiPiotr)