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。您需要其他要求才能使用此模块，有关详细信息，请参阅 Requirements。

要在剧本中使用它，请指定：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"

name

列表 / 元素=字符串

要检查的节点名称。

要检查的节点名称列表。

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

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

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

self

布尔值

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

如果true，则忽略name。

如果false，则查询取决于name是否存在及其值。

选项

  • false ← (默认值)

  • true

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中已移除。

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

use_ssh_client

布尔值

在community.docker 1.5.0中添加

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

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

选项

  • 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

支持： N/A

此操作不会修改状态。

处于diff模式时，将返回有关已更改内容（或可能需要在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

返回值

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

键

描述

nodes

列表 / 元素=字典

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

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

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

返回：始终返回

作者

  • Piotr Wojciechowski (@WojciechowskiPiotr)