containers.podman.podman_prune 模块 – 允许清理各种 Podman 对象

注意

此模块是 containers.podman 集合 (版本 1.16.2) 的一部分。

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

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

要在剧本中使用它，请指定：containers.podman.podman_prune。

containers.podman 1.10.0 中的新增功能

概要 

允许运行 podman container prune、podman image prune、podman network prune、podman volume prune 和 podman system prune

要求 

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

主机上安装了 Podman

参数 

参数	注释
container 布尔值	是否清理容器。选项 `false` ← (默认) `true`
container_filters 字典	用于选择要删除的容器的过滤器值字典。例如，`until: 24h`。有关可能的过滤器的更多信息，请参见 podman 文档。
executable 字符串	Podman 二进制文件。默认值： `"podman"`
image 布尔值	是否清理镜像。选项 `false` ← (默认) `true`
image_filters 字典	用于选择要删除的镜像的过滤器值字典。您还可以使用 `dangling_only: false` 删除悬空和非悬空镜像，或使用 `external: true` 即使外部容器正在使用镜像也能删除镜像。有关可能的过滤器的更多信息，请参见 podman 文档。
network 布尔值	是否清理网络。选项 `false` ← (默认) `true`
network_filters 字典	用于选择要删除的网络的过滤器值字典。有关可能的过滤器的更多信息，请参见 podman 文档。
system 布尔值	是否清理未使用的 Pod、容器、镜像、网络和卷数据选项 `false` ← (默认) `true`
system_all 布尔值	是否清理所有未使用的镜像，而不仅仅是悬空镜像。选项 `false` ← (默认) `true`
system_volumes 布尔值	是否清理当前任何容器都未使用的卷。选项 `false` ← (默认) `true`
volume 布尔值	是否清理卷。选项 `false` ← (默认) `true`
volume_filters 字典	用于选择要删除的卷的过滤器值字典。有关可能的过滤器的更多信息，请参见 podman 文档。

示例 

- name: Prune containers older than 24h
  containers.podman.podman_prune:
      containers: true
      containers_filters:
          # only consider containers created more than 24 hours ago
          until: 24h

- name: Prune everything
  containers.podman.podman_prune:
      system: true

- name: Prune everything (including non-dangling images)
  containers.podman.podman_prune:
      system: true
      system_all: true
      system_volumes: true

返回值 

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

键	描述
containers 列表 / 元素=字符串	已删除容器的 ID 列表。返回：containers 为 `true` 示例： `[]`
images 列表 / 元素=字符串	已删除镜像的 ID 列表。返回：images 为 `true` 示例： `[]`
networks 列表 / 元素=字符串	已删除网络的 ID 列表。返回：networks 为 `true` 示例： `[]`
system 列表 / 元素=字符串	已删除容器、卷、镜像、网络的 ID 列表和已回收的总空间返回：system 为 `true` 示例： `[]`
volumes 列表 / 元素=字符串	已删除卷的 ID 列表。返回： volumes 为 `true` 示例： `[]`

作者

Roberto Alfieri (@rebtoor)