community.docker.docker_image_remove 模块 – 删除 Docker 镜像

注意

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

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

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

要在 Playbook 中使用它，请指定：community.docker.docker_image_remove。

community.docker 3.6.0 中的新增功能

概要 

从 Docker 守护程序中删除 Docker 镜像。

要求 

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

Docker API >= 1.25
backports.ssl_match_hostname（在 Python 2 上使用 TLS 时）
paramiko（当使用 SSH 且 use_ssh_client=false 时）
pyOpenSSL（当使用 TLS 时）
pywin32（当在 Windows 32 上使用命名管道时）
请求

参数 

参数	注释
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 boolean	调试模式选项 `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"`
force boolean	取消标记并删除所有与指定名称匹配的镜像。选项 `false` ← (默认) `true`
name 字符串 / 必需	镜像名称。名称格式可以是：`name`、`repository/name`、`registry_server:port/name`。在推送或拉取镜像时，名称可以选择性地包含标签，方法是附加 `:tag_name`。请注意，也可以使用镜像 ID（哈希值）。
prune boolean	删除未标记的父镜像。选项 `false` `true` ← (默认)
tag 字符串	要标记的镜像名称 `name` 的标签。如果 `name` 的格式为 `name:tag`，则 `name` 中的标签值将优先。默认值: `"latest"`
timeout integer	等待 API 响应的最大时间（以秒为单位）。如果任务中未指定该值，则将使用环境变量 `DOCKER_TIMEOUT` 的值。如果未设置该环境变量，则将使用默认值。默认值: `60`
tls boolean	使用 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 boolean 在 community.docker 1.5.0 中添加	对于 SSH 传输，使用 `ssh` CLI 工具而不是 paramiko。选项 `false` ← (默认) `true`
validate_certs 别名: tls_verify boolean	使用 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` 中更改的内容）的详细信息。

说明 

注意

通过在每个任务中提供参数或定义环境变量来连接 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 的代码，这些代码包含在此集合中。

另请参阅 

另请参阅

community.docker.docker_image_load: 从归档加载 Docker 镜像。
community.docker.docker_image_pull: 从注册表拉取 Docker 镜像。
community.docker.docker_image_tag: 使用新名称和/或标签标记 Docker 镜像。

示例 

- name: Remove an image
  community.docker.docker_image_remove:
    name: pacur/centos-7

返回值 

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

键	描述
deleted 列表 / 元素=字符串	已删除的镜像的摘要。返回: 成功示例: `[]`
image 字典	删除前受影响镜像的镜像检查结果。如果未找到镜像，则为空。返回: 成功示例: `{}`
untagged 列表 / 元素=字符串	已取消标记的镜像的摘要。返回: 成功示例: `[]`

作者

Felix Fontein (@felixfontein)

community.docker.docker_image_remove 模块 – 删除 Docker 镜像

作者

集合链接