Модуль community.docker.docker_host_info – Получение сведений о хосте Docker и списков объектов служб.

Примечание

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

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

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

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

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

Описание

Получает сведения о хосте Docker.
В сущности, возвращает вывод команды docker system info.
Модуль также позволяет перечислить имена объектов для контейнеров, образов, сетей и томов. Также он позволяет запросить информацию об использовании дискового пространства.
Вывод отличается в зависимости от версии API демона Docker.
Если с демоном Docker невозможно связаться или он не соответствует требованиям к версии API, модуль завершится с ошибкой.

Требования

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

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 aliases: docker_api_version строка	Версия API Docker, работающая на Docker хосте. По умолчанию используется последняя версия API, поддерживаемая этим модулем и демоном Docker. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_API_VERSION`. Если переменная среды не задана, будет использовано значение по умолчанию. По умолчанию: `"auto"`
ca_path aliases: 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 aliases: tls_client_cert, cert_path путь	Путь к файлу TLS-сертификата клиента. Если значение не указано в задаче и переменная среды `DOCKER_CERT_PATH` задана, будет использоваться файл `cert.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`.
client_key aliases: tls_client_key, key_path путь	Путь к файлу TLS-ключа клиента. Если значение не указано в задаче и переменная среды `DOCKER_CERT_PATH` задана, будет использоваться файл `key.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`.
containers логическое значение	Указать список контейнеров. Варианты: `false` ← (по умолчанию) `true`
containers_all логическое значение добавлен в community.docker 3.4.0	По умолчанию возвращаются только запущенные контейнеры. Соответствует параметру `--all` для `docker container list`. Варианты: `false` ← (по умолчанию) `true`
containers_filters словарь	Словарь значений фильтров для выбора контейнеров для отображения. Например, `until: 24h`. `label` является специальным случаем фильтра, который может быть строкой `<key>`, соответствующей наличию метки, строкой `<key>=<value>`, соответствующей определенному значению метки, или списком строк `<key>`/`<key>=<value`. См. документацию Docker для получения дополнительной информации о возможных фильтрах.
debug логическое значение	Режим отладки Варианты: `false` ← (по умолчанию) `true`
disk_usage логическое значение	Сводная информация об используемом дисковом пространстве всеми слоями Docker. Вывод является суммой изображений, томов, контейнеров и кэша сборки. Варианты: `false` ← (по умолчанию) `true`
docker_host aliases: docker_url строка	URL или путь к Unix-сокету для подключения к Docker API. Для подключения к удаленному хосту укажите строку TCP-соединения. Например, `tcp://192.0.2.23:2376`. Если для шифрования соединения используется TLS, модуль автоматически заменит `tcp` в URL соединения на `https`. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_HOST`. Если переменная среды не задана, будет использовано значение по умолчанию. По умолчанию: `"unix:///var/run/docker.sock"`
images логическое значение	Указать список изображений. Варианты: `false` ← (по умолчанию) `true`
images_filters словарь	Словарь значений фильтров для выбора изображений для отображения. Например, `dangling: true`. `label` является специальным случаем фильтра, который может быть строкой `<key>`, соответствующей наличию метки, строкой `<key>=<value>`, соответствующей определенному значению метки, или списком строк `<key>`/`<key>=<value`. См. документацию Docker для получения дополнительной информации о возможных фильтрах.

END_OF_DOCUMENT_MARKER

networks boolean	Выводить ли список сетей. Варианты: `false` ← (default) `true`
networks_filters dictionary	Словарь значений фильтров, используемых для выбора сетей для вывода. `label` является частным случаем фильтра, который может быть строкой `<key>` соответствующей, когда метка присутствует, строкой `<key>=<value>` соответствующей, когда метка имеет определённое значение, или списком строк `<key>`/`<key>=<value`. См. документацию Docker для получения дополнительной информации о возможных фильтрах.
ssl_version string	Укажите допустимый номер версии SSL. Значение по умолчанию определяется модулем SSL Python. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_SSL_VERSION`.
timeout integer	Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_TIMEOUT`. Если переменная среды не установлена, будет использовано значение по умолчанию. По умолчанию: `60`
tls boolean	Обеспечьте безопасное соединение с API, используя TLS без проверки подлинности сервера хоста Docker. Обратите внимание, что если `validate_certs` также установлено в `true`, то оно будет иметь приоритет. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_TLS`. Если переменная среды не установлена, будет использовано значение по умолчанию. Варианты: `false` ← (default) `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` ← (default) `true`
validate_certs алиасы: tls_verify boolean	Обеспечьте безопасное соединение с API, используя TLS и проверяя подлинность сервера хоста Docker. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_TLS_VERIFY`. Если переменная среды не установлена, будет использовано значение по умолчанию. Варианты: `false` ← (default) `true`
verbose_output boolean	Если установлено в `true` и `networks`, `volumes`, `images`, `containers`, или `disk_usage` установлено в `true`, то вывод будет содержать подробную информацию о объектах, соответствующую полному выводу метода API. Для получения подробной информации см. документацию вашей версии Docker API по адресу https://docs.docker.com/engine/api/. Подробный вывод в этом модуле содержит только подмножество информации, возвращаемой этим модулем для каждого типа объектов. Варианты: `false` ← (default) `true`
volumes boolean	Выводить ли список томов. Варианты: `false` ← (default) `true`
volumes_filters dictionary	Словарь значений фильтров, используемых для выбора томов для вывода. `label` является частным случаем фильтра, который может быть строкой `<key>` соответствующей, когда метка присутствует, строкой `<key>=<value>` соответствующей, когда метка имеет определённое значение, или списком строк `<key>`/`<key>=<value`. См. документацию Docker для получения дополнительной информации о возможных фильтрах.

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группы действий: community.docker.docker, docker	Используйте `group/docker` или `group/community.docker.docker` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может работать в `check_mode` и возвращать прогноз изменения статуса без изменения целевого объекта.
diff_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 для Python для взаимодействия с демоном Docker. Он использует код, полученный из Docker SDK или Python, включённый в эту коллекцию.

Примеры

- name: Get info on docker host
  community.docker.docker_host_info:
  register: result

- name: Get info on docker host and list images
  community.docker.docker_host_info:
    images: true
  register: result

- name: Get info on docker host and list images matching the filter
  community.docker.docker_host_info:
    images: true
    images_filters:
      label: "mylabel"
  register: result

- name: Get info on docker host and verbose list images
  community.docker.docker_host_info:
    images: true
    verbose_output: true
  register: result

- name: Get info on docker host and used disk space
  community.docker.docker_host_info:
    disk_usage: true
  register: result

- name: Get info on docker host and list containers matching the filter
  community.docker.docker_host_info:
    containers: true
    containers_filters:
      label:
        - key1=value1
        - key2=value2
  register: result

- name: Show host information
  ansible.builtin.debug:
    var: result.host_info

Возвращаемые значения

Общие возвращаемые значения описаны на странице здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
can_talk_to_docker логический тип	Будет `true` если модуль может взаимодействовать с демоном docker. Возвращаемое значение: как при успехе, так и при ошибке
containers список / элементы=словарь	Список объектов-словаря, содержащих основную информацию о каждом контейнере. Ключи соответствуют выводу `docker container ls` за исключением `verbose_output=true`. См. описание для `verbose_output`. Возвращаемое значение: при `containers=true`
disk_usage словарь	Информация о суммарном использовании диска изображениями, контейнерами и томами на хосте Docker, за исключением `verbose_output=true`. См. описание для `verbose_output`. Возвращаемое значение: при `disk_usage=true`
host_info словарь	Факты, представляющие основное состояние хоста Docker. Соответствует выводу `docker system info`. Возвращаемое значение: всегда
images список / элементы=словарь	Список объектов-словаря, содержащих основную информацию о каждом изображении. Ключи соответствуют выводу `docker image ls` за исключением `verbose_output=true`. См. описание для `verbose_output`. Возвращаемое значение: при `images=true`
networks список / элементы=словарь	Список объектов-словаря, содержащих основную информацию о каждой сети. Ключи соответствуют выводу `docker network ls` за исключением `verbose_output=true`. См. описание для `verbose_output`. Возвращаемое значение: при `networks=true`
volumes список / элементы=словарь	Список объектов-словаря, содержащих основную информацию о каждом томе. Ключи соответствуют выводу `docker volume ls` за исключением `verbose_output=true`. См. описание для `verbose_output`. Возвращаемое значение: при `volumes=true`

Авторы

Piotr Wojciechowski (@WojciechowskiPiotr)

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

© 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_host_info_module.html