Модуль community.docker.docker_network_info – Получение информации о сети Docker
Примечание
Этот модуль является частью коллекции community.docker (версия 3.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.docker. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.
Чтобы использовать его в playbook, укажите: community.docker.docker_network_info.
Обзор
- Получает информацию о сети Docker.
- В сущности возвращает вывод
docker network inspect <name>, аналогично тому, что возвращает community.docker.docker_network для неотсутствующей сети.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. Если значение не указано в задании, используется значение переменной окружения По умолчанию: |
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 строка / обязательно | Имя сети для проверки. При идентификации существующей сети имя может быть именем или длинным или коротким ID сети. |
ssl_version строка | Укажите допустимый номер версии SSL. Значение по умолчанию определяется модулем SSL Python. Если значение не указано в задании, используется значение переменной окружения |
timeout целое число | Максимальное время ожидания ответа от API в секундах. Если значение не указано в задании, используется значение переменной окружения По умолчанию: |
tls булево | Защитить соединение с API с помощью TLS, не проверяя подлинность Docker-хоста. Обратите внимание, что если Если значение не указано в задании, используется значение переменной окружения Варианты:
|
tls_hostname строка | При проверке подлинности Docker-хоста укажите ожидаемое имя сервера. Если значение не указано в задании, используется значение переменной окружения Обратите внимание, что у этого параметра было значение по умолчанию |
use_ssh_client булево добавлено в community.docker 1.5.0 | Для SSH-транспортов используйте инструмент Варианты:
|
validate_certs aliases: tls_verify boolean | Защитите соединение с API, используя TLS и проверяя подлинность сервера Docker. Если значение не указано в задаче, будет использовано значение переменной окружения Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
action_group | Группы действий: community.docker.docker, docker | Используйте |
check_mode | Поддержка: полная Данное действие не изменяет состояние. | Может работать в режиме |
diff_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 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 boolean | Возвращает, существует ли сеть. Возвращаемое значение: всегда Пример: |
network dictionary | Факты, представляющие текущее состояние сети. Соответствует выводу docker inspection. Будет Возвращаемое значение: всегда Пример: |
Ссылки на сборку
© 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_network_info_module.html
