модуль community.docker.docker_container_info — получение сведений о контейнере Docker
Примечание
Этот модуль входит в коллекцию community.docker (версия 5.2.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install community.docker. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.docker.docker_container_info.
Краткое описание
- Получает сведения о контейнере Docker.
- По сути, возвращает результат команды
docker inspect <name>, аналогично тому, что возвращает community.docker.docker_container для существующего контейнера.
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- Docker API >= 1.25
- paramiko (при использовании SSH с
use_ssh_client=false) - pyOpenSSL (при использовании TLS)
- pywin32 (при использовании именованных каналов в Windows 32)
- requests
Параметры
Параметр | Комментарии |
|---|---|
api_version псевдонимы: docker_api_version строка | Версия Docker API, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая этой коллекцией и службой Docker daemon. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения По умолчанию: |
ca_path псевдонимы: ca_cert, tls_ca_cert, cacert_path путь | Для проверки сервера используйте сертификат центра сертификации, указав путь к файлу сертификата. Если значение не указано в задаче, а переменная окружения Ранее этот параметр назывался |
client_cert псевдонимы: tls_client_cert, cert_path путь | Путь к файлу сертификата TLS клиента. Если значение не указано в задаче, а переменная окружения |
client_key псевдонимы: tls_client_key, key_path путь | Путь к файлу ключа TLS клиента. Если значение не указано в задаче, а переменная окружения |
debug логическое значение | Режим отладки Варианты:
|
docker_host псевдонимы: docker_url строка | URL или путь к сокету Unix для подключения к Docker API. Для подключения к удалённому хосту укажите строку TCP-подключения. Например, Если значение не указано в задаче, вместо него будет использовано значение переменной окружения По умолчанию: |
name строка / обязательный | Имя контейнера для проверки. Для поиска существующего контейнера можно указать его имя или полный либо короткий идентификатор. |
timeout целое число | Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения По умолчанию: |
tls логическое значение | Защитите соединение с API с помощью TLS, не проверяя подлинность сервера хоста Docker. Обратите внимание: если для параметра Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Варианты:
|
tls_hostname строка | При проверке подлинности сервера хоста Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Обратите внимание, что в более ранних версиях для этого параметра использовалось значение по умолчанию |
use_ssh_client логическое значение добавлено в community.docker 1.5.0 | Для SSH-подключений используйте инструмент командной строки Варианты:
|
validate_certs псевдонимы: tls_verify логическое значение | Защитите соединение с API с помощью TLS и проверяйте подлинность сервера хоста Docker. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
action_group | Группы действий: community.docker.docker, docker | Используйте |
check_mode | Поддержка: полная Это действие не изменяет состояние. | Может выполняться в режиме |
diff_mode | Поддержка: не применимо Это действие не изменяет состояние. | В режиме diff будут возвращены сведения об изменениях (или о том, что, возможно, требуется изменить в |
idempotent | Поддержка: полная Это действие не изменяет состояние. | При повторном запуске с теми же аргументами вне режима проверки модуль сообщает об отсутствии изменений. Предполагается, что система, которой управляет модуль или состояние которой он проверяет, не изменилась существенным образом. |
Примечания
Примечание
- Подключайтесь к службе Docker daemon, передавая параметры в каждой задаче или задавая переменные окружения. Можно задать
DOCKER_HOST,DOCKER_TLS_HOSTNAME,DOCKER_API_VERSION,DOCKER_CERT_PATH,DOCKER_TLS,DOCKER_TLS_VERIFYиDOCKER_TIMEOUT. Если вы используете docker machine, запустите поставляемый с продуктом скрипт настройки окружения. Он задаст эти переменные. Подробнее см. на странице https://docs.docker.com/machine/reference/env/. - Этот модуль не использует Docker SDK for Python для взаимодействия со службой Docker daemon. Вместо этого он использует код, основанный на Docker SDK или Python и включённый в эту коллекцию.
Примеры
---
- name: Get infos on container
community.docker.docker_container_info:
name: mydata
register: result
- name: Does container exist?
ansible.builtin.debug:
msg: "The container {{ 'exists' if result.exists else 'does not exist' }}"
- name: Print information about container
ansible.builtin.debug:
var: result.container
when: result.exists
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
container словарь | Сведения о текущем состоянии контейнера. Соответствует результату проверки Docker. Будет иметь значение Возвращается: всегда Пример: |
exists логическое значение | Указывает, существует ли контейнер. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/docker/docker_container_info_module.html
