community.docker.docker_volume_info 模块 – 获取 Docker 卷的相关信息

注意

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

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

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

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

概要 

主要执行与 docker volume inspect CLI 子命令相同的功能。

要求 

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

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`。
调试布尔值	调试模式选项 `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 别名: volume_name 字符串 / 必填	要检查的卷的名称。
超时整数	等待 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	支持: 不适用此操作不会修改状态。	在 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 SDK 或 Python 的代码，该代码包含在此集合中。

示例 

- name: Get infos on volume
  community.docker.docker_volume_info:
    name: mydata
  register: result

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

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

返回值 

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

键	描述
exists 布尔值	返回卷是否存在。已返回: 始终示例: `true`
volume 字典	受影响卷的卷检查结果。如果卷不存在，则为 `none`。已返回: 成功示例: `{"CreatedAt": "2018-12-09T17:43:44+01:00", "Driver": "local", "Labels": null, "Mountpoint": "/var/lib/docker/volumes/ansible-test-bd3f6172/_data", "Name": "ansible-test-bd3f6172", "Options": {}, "Scope": "local"}`

作者

Felix Fontein (@felixfontein)