community.docker.docker_stack_info 模块 – 返回所有 Docker stack 的信息

注意

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

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

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

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

概要 

使用目标节点上的 docker stack 命令检索 Docker stack 信息（请参阅示例）。

要求 

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

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 安全地连接到 API 并验证 Docker 主机服务器的真实性。如果任务中未指定该值，则改用环境变量`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	支持： 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.docker.net.cn/machine/reference/env/。
此模块**不**使用Docker SDK for Python与 Docker 守护进程通信。它直接调用 Docker CLI 程序。

另请参见 

另请参见

community.docker.docker_stack_task_info: 要检索特定堆栈下服务的详细信息，请使用community.docker.docker_stack_task_info模块。

示例 

- name: Shows stack info
  community.docker.docker_stack_info:
  register: result

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

返回值 

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

键	描述
results 列表 / 元素=字典	包含目标节点上堆栈列表的字典列表返回：始终示例：`[{"name": "grafana", "namespace": "default", "orchestrator": "Kubernetes", "services": "2"}]`

作者

Jose Angel Munoz (@imjoseangel)

community.docker.docker_stack_info 模块 – 返回所有 Docker stack 的信息

作者

集合链接