Модуль community.docker.docker_image_remove – Удаление образов Docker

Примечание

Этот модуль является частью коллекции community.docker (версия 3.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.docker. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

Для использования в плейбуке укажите: community.docker.docker_image_remove.

Добавлен в community.docker 3.6.0

Описание
Требования
Параметры
Атрибуты
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Удаление образов Docker из демона Docker.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

API Docker >= 1.25
backports.ssl_match_hostname (при использовании TLS в Python 2)
paramiko (при использовании SSH с use_ssh_client=false)
pyOpenSSL (при использовании TLS)
pywin32 (при использовании именованных каналов на Windows 32)
requests

Параметры

Параметр	Комментарии
api_version псевдонимы: docker_api_version строка	Версия Docker API, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая этим сбором и демоном docker. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_API_VERSION`. Если переменная окружения не задана, будет использовано значение по умолчанию. По умолчанию: `"auto"`
ca_path псевдонимы: ca_cert, tls_ca_cert, cacert_path путь	Используйте сертификат CA при проверке сервера, указав путь к файлу сертификата CA. Если значение не указано в задаче и переменная окружения `DOCKER_CERT_PATH` задана, будет использован файл `ca.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. Этот параметр назывался `ca_cert` и был переименован в `ca_path` в community.docker 3.6.0. Старое имя добавлено в качестве псевдонима и может по-прежнему использоваться.
client_cert псевдонимы: tls_client_cert, cert_path путь	Путь к файлу TLS-сертификата клиента. Если значение не указано в задаче и переменная окружения `DOCKER_CERT_PATH` задана, будет использован файл `cert.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`.
client_key псевдонимы: tls_client_key, key_path путь	Путь к файлу TLS-ключа клиента. Если значение не указано в задаче и переменная окружения `DOCKER_CERT_PATH` задана, будет использован файл `key.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`.
debug логический тип	Режим отладки Варианты: `false` ← (по умолчанию) `true`
docker_host псевдонимы: docker_url строка	URL или путь к Unix-сокету для подключения к Docker API. Для подключения к удалённому хосту укажите строку TCP-соединения. Например, `tcp://192.0.2.23:2376`. Если TLS используется для шифрования соединения, модуль автоматически заменит `tcp` в URL соединения на `https`. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_HOST`. Если переменная окружения не задана, будет использовано значение по умолчанию. По умолчанию: `"unix:///var/run/docker.sock"`
force логический тип	Удалить все изображения, соответствующие указанному имени, и снять теги. Варианты: `false` ← (по умолчанию) `true`
name строка / обязательный	Имя изображения. Формат имени будет одним из: `name`, `repository/name`, `registry_server:port/name`. При отправке или извлечении изображения имя может необязательно включать тег, добавляя `:tag_name`. Обратите внимание, что также можно использовать идентификаторы (хеши) изображений.
prune логический тип	Удалить родительские изображения без тегов. Варианты: `false` `true` ← (по умолчанию)
ssl_version строка	Укажите допустимое значение версии SSL. Значение по умолчанию определяется модулем SSL Python. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_SSL_VERSION`.
tag строка	Тег для имени изображения `name`, который нужно отметить. Если формат `name` — `name:tag`, то значение тега из `name` будет иметь приоритет. По умолчанию: `"latest"`
timeout целое число	Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_TIMEOUT`. Если переменная окружения не задана, будет использовано значение по умолчанию. По умолчанию: `60`

tls boolean	Защитите подключение к API с помощью TLS без проверки подлинности сервера Docker. Обратите внимание, что если `validate_certs` также установлено в `true`, оно будет иметь приоритет. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_TLS`. Если переменная среды не установлена, будет использовано значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`
tls_hostname string	При проверке подлинности сервера 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 aliases: tls_verify boolean	Защитите подключение к API с помощью TLS и проверьте подлинность сервера Docker. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_TLS_VERIFY`. Если переменная среды не установлена, будет использовано значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группы действий: community.docker.docker, docker	Используйте `group/docker` или `group/community.docker.docker` в `module_defaults` для установки значений по умолчанию для этого модуля.
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогнозируемый результат изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: полная	Возвращает подробности о внесённых изменениях (или, возможно, о необходимости внесения изменений в `check_mode`), когда включён режим сравнения.

Примечания

Примечание

Подключайтесь к демону Docker, предоставляя параметры в каждой задаче или определяя переменные среды. Вы можете определить DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_SSL_VERSION, DOCKER_TLS, DOCKER_TLS_VERIFY и DOCKER_TIMEOUT. Если вы используете docker machine, запустите скрипт, поставляемый с продуктом, для настройки среды. Он установит эти переменные за вас. Подробнее см. https://docs.docker.com/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)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/docker/docker_image_remove_module.html