community.docker.docker_network_info 模块 – 获取关于 docker 网络的事实

注意

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

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

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

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

概要

  • 获取关于 docker 网络的事实。

  • 本质上返回 docker network inspect <name> 的输出，类似于 community.docker.docker_network 返回的非不存在网络。

要求

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

  • 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 network
  community.docker.docker_network_info:
    name: mydata
  register: result

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

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

返回值

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

键

描述

exists

布尔值

返回网络是否存在。

返回: 始终

示例: true

network

字典

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

如果网络不存在，则将为 none。

返回: 始终

示例: {"Attachable": false, "ConfigFrom": {"Network": ""}, "ConfigOnly": false, "Containers": {}, "Created": "2018-12-07T01:47:51.250835114-06:00", "Driver": "bridge", "EnableIPv6": false, "IPAM": {"Config": [{"Gateway": "192.168.96.1", "Subnet": "192.168.96.0/20"}], "Driver": "default", "Options": null}, "Id": "0856968545f22026c41c2c7c3d448319d3b4a6a03a40b148b3ac4031696d1c0a", "Ingress": false, "Internal": false, "Labels": {}, "Name": "ansible-test-f2700bba", "Options": {}, "Scope": "local"}

作者

  • Dave Bendit (@DBendit)