community.docker.docker_stack_task_info 模块 – 返回 Docker 堆栈上任务的信息

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.docker。您需要进一步的要求才能使用此模块，请参阅要求以了解详细信息。

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

概要 

使用目标节点上的 docker stack 命令检索有关 docker 堆栈任务的信息（请参阅示例）。

要求 

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

Docker CLI 工具 docker

参数 

参数	注释
api_version 别名：docker_api_version 字符串在 community.docker 3.6.0 中添加	在 Docker 主机上运行的 Docker API 的版本。默认为此集合和 docker 守护程序支持的最新版本的 API。如果未在任务中指定该值，则将使用环境变量 `DOCKER_API_VERSION` 的值。如果未设置环境变量，则将使用默认值。默认值： `"auto"`
ca_path 别名：ca_cert、tls_ca_cert、cacert_path 路径在 community.docker 3.6.0 中添加	通过提供 CA 证书文件的路径，在执行服务器验证时使用 CA 证书。如果未在任务中指定该值，并且设置了环境变量 `DOCKER_CERT_PATH`，则将使用环境变量 `DOCKER_CERT_PATH` 中指定的目录中的文件 `ca.pem`。
cli_context 字符串在 community.docker 3.6.0 中添加	要使用的 Docker CLI 上下文。与 `docker_host` 互斥。
client_cert 别名：tls_client_cert、cert_path 路径在 community.docker 3.6.0 中添加	客户端 TLS 证书文件的路径。如果未在任务中指定该值，并且设置了环境变量 `DOCKER_CERT_PATH`，则将使用环境变量 `DOCKER_CERT_PATH` 中指定的目录中的文件 `cert.pem`。
client_key 别名：tls_client_key、key_path 路径在 community.docker 3.6.0 中添加	客户端 TLS 密钥文件的路径。如果未在任务中指定该值，并且设置了环境变量 `DOCKER_CERT_PATH`，则将使用环境变量 `DOCKER_CERT_PATH` 中指定的目录中的文件 `key.pem`。
docker_cli 路径在 community.docker 3.6.0 中添加	Docker CLI 的路径。如果未提供，将在 `PATH` 中搜索 Docker CLI。
docker_host 别名: docker_url 字符串在 community.docker 3.6.0 中添加	用于连接 Docker API 的 URL 或 Unix 套接字路径。要连接到远程主机，请提供 TCP 连接字符串。例如，`tcp://192.0.2.23:2376`。如果使用 TLS 加密连接，模块将自动将连接 URL 中的 `tcp` 替换为 `https`。如果任务中未指定该值，则将使用环境变量 `DOCKER_HOST` 的值。如果未设置环境变量，则将使用默认值。与 `cli_context` 互斥。如果未提供 `docker_host` 和 `cli_context`，则将使用值 `unix:///var/run/docker.sock`。
名称字符串 / 必需	堆栈名称。
tls 布尔值在 community.docker 3.6.0 中添加	通过使用 TLS 来保护与 API 的连接，而不验证 Docker 主机服务器的真实性。请注意，如果 `validate_certs` 也设置为 `true`，则它将优先。如果任务中未指定该值，则将使用环境变量 `DOCKER_TLS` 的值。如果未设置环境变量，则将使用默认值。选择 `false` ← (默认) `true`
tls_hostname 字符串在 community.docker 3.6.0 中添加	在验证 Docker 主机服务器的真实性时，提供服务器的预期名称。如果任务中未指定该值，则将使用环境变量 `DOCKER_TLS_HOSTNAME` 的值。如果未设置环境变量，则将使用默认值。
validate_certs 别名: tls_verify 布尔值在 community.docker 3.6.0 中添加	通过使用 TLS 并验证 Docker 主机服务器的真实性来保护与 API 的连接。如果任务中未指定该值，则将使用环境变量 `DOCKER_TLS_VERIFY` 的值。如果未设置环境变量，则将使用默认值。选择 `false` ← (默认) `true`

属性 

属性	支持	描述
action_group	操作组: community.docker.docker, docker 在 community.docker 3.6.0 中添加	在 `module_defaults` 中使用 `group/docker` 或 `group/community.docker.docker` 来为此模块设置默认值。
check_mode	支持: 完整此操作不会修改状态。	可以在 `check_mode` 中运行，并返回已更改状态的预测，而无需修改目标。
diff_mode	支持: 不适用此操作不会修改状态。	当处于 diff 模式时，将返回有关已更改内容（或可能需要在 `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.docker.net.cn/machine/reference/env/。
此模块不使用 Docker SDK for Python 与 Docker 守护进程通信。它直接调用 Docker CLI 程序。

示例 

- name: Shows stack info
  community.docker.docker_stack_task_info:
    name: test_stack
  register: result

- name: Show results
  ansible.builtin.debug:
    var: result.results

返回值 

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

键	描述
results 列表 / 元素=字典	包含与堆栈名称关联的任务列表的字典列表。返回: 总是示例: `[{"CurrentState": "Running", "DesiredState": "Running", "Error": "", "ID": "7wqv6m02ugkw", "Image": "busybox", "Name": "test_stack.1", "Node": "swarm", "Ports": ""}]`

作者

Jose Angel Munoz (@imjoseangel)