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

api_version

псевдонимы: docker_api_version

string

Версия Docker API, работающая на хосте Docker.

По умолчанию используется последняя версия API, поддерживаемая этой коллекцией и демоном Docker.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды DOCKER_API_VERSION. Если переменная среды не задана, будет использовано значение по умолчанию.

По умолчанию: "auto"

ca_path

псевдонимы: ca_cert, tls_ca_cert, cacert_path

path

Используйте сертификат CA для проверки сервера, указав путь к файлу сертификата CA.

Если значение не указано в задаче, а переменная среды DOCKER_CERT_PATH задана, будет использован файл ca.pem из каталога, указанного в переменной среды DOCKER_CERT_PATH.

Ранее этот параметр назывался ca_cert; в community.docker 3.6.0 его переименовали в ca_path. Старое имя добавлено как псевдоним, и его по-прежнему можно использовать.

client_cert

псевдонимы: tls_client_cert, cert_path

path

Путь к файлу клиентского сертификата TLS.

Если значение не указано в задаче, а переменная среды DOCKER_CERT_PATH задана, будет использован файл cert.pem из каталога, указанного в переменной среды DOCKER_CERT_PATH.

client_key

псевдонимы: tls_client_key, key_path

path

Путь к файлу клиентского ключа TLS.

Если значение не указано в задаче, а переменная среды DOCKER_CERT_PATH задана, будет использован файл key.pem из каталога, указанного в переменной среды DOCKER_CERT_PATH.

debug

boolean

Режим отладки

Варианты:

• false ← (по умолчанию)
• true

docker_host

псевдонимы: docker_url

string

URL или путь к сокету Unix, используемый для подключения к Docker API. Чтобы подключиться к удалённому хосту, укажите строку TCP-подключения. Например, tcp://192.0.2.23:2376. Если для шифрования подключения используется TLS, модуль автоматически заменит tcp в URL подключения на https.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды DOCKER_HOST. Если переменная среды не задана, будет использовано значение по умолчанию.

По умолчанию: "unix:///var/run/docker.sock"

force

boolean

Снять теги и удалить все образы, соответствующие указанному имени.

Варианты:

• false ← (по умолчанию)
• true

name

string / обязательный

Имя образа. Формат имени может быть одним из следующих: name, repository/name, registry_server:port/name. При отправке или загрузке образа в имя можно дополнительно включить тег, добавив :tag_name.

Обратите внимание: также можно использовать идентификаторы (хеши) образов.

prune

boolean

Удалять родительские образы без тегов.

Варианты:

• false
• true ← (по умолчанию)

tag

string

Тег для имени образа name, которому требуется назначить тег.

Если формат name — name:tag, значение тега из name будет иметь приоритет.

По умолчанию: "latest"

timeout

integer

Максимальное время ожидания ответа от 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 вместо paramiko.

Варианты:

• false ← (по умолчанию)
• true

validate_certs

псевдонимы: 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

Поддержка: полная

В режиме diff будут возвращены сведения об изменениях (или возможных изменениях в check_mode).

idempotent

Поддержка: полная

При повторном запуске с теми же аргументами вне режима проверки второй запуск не сообщает об изменениях.

Предполагается, что система, контролируемая или запрашиваемая модулем, не изменилась существенным образом.

deleted

list / elements=string

Дайджесты удалённых образов.

Возвращается: при успехе

Пример: []

image

dictionary

Результаты проверки образа до удаления затронутого образа.

Пусто, если образ не найден.

Возвращается: при успехе

Пример: {}

untagged

list / elements=string

Дайджесты образов, с которых были сняты теги.

Возвращается: при успехе

Пример: []