Модуль community.docker.docker_network_info – получение фактов о сети Docker
Примечание
Этот модуль входит в коллекцию community.docker (версия 5.2.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.docker. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.docker.docker_network_info.
Краткое описание
- Получает факты о сети Docker.
- По сути, возвращает результат выполнения
docker network inspect <name>, аналогично тому, как community.docker.docker_network возвращает данные для существующей сети.
Требования
На хосте, на котором выполняется этот модуль, необходимы следующие компоненты.
- 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. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения По умолчанию: |
ca_path псевдонимы: ca_cert, tls_ca_cert, cacert_path путь | Для проверки сервера используйте сертификат CA, указав путь к файлу сертификата CA. Если значение не указано в задаче, а переменная окружения Ранее этот параметр назывался |
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 | Поддержка: Н/Д Это действие не изменяет состояние. | В режиме различий вернёт сведения об изменениях (или о возможных необходимых изменениях в |
idempotent | Поддержка: полная Это действие не изменяет состояние. | При повторном запуске с теми же аргументами вне режима проверки модуль сообщает об отсутствии изменений. При этом предполагается, что система, управляемая или проверяемая модулем, не изменилась существенным образом. |
Примечания
Примечание
- Подключайтесь к демону Docker, передавая параметры в каждой задаче или задавая переменные окружения. Можно задать переменные
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. Вместо этого он использует код, производный от Docker SDK или Python и включённый в эту коллекцию.
Примеры
---
- name: Get infos on network
community.docker.docker_network_info:
name: mydata
register: result
- name: Does network exist?
ansible.builtin.debug:
msg: "The network {{ 'exists' if result.exists else 'does not exist' }}"
- name: Print information about network
ansible.builtin.debug:
var: result.network
when: result.exists
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
exists логический | Возвращает сведения о том, существует ли сеть. Возвращается: всегда Пример: |
network словарь | Факты, описывающие текущее состояние сети. Соответствует результату проверки Docker. Если сеть не существует, значение будет Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_network_info_module.html
