community.general.utm_dns_host – создание, обновление или удаление записи DNS в Sophos UTM
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.utm_dns_host.
Обзор
- Создайте, обновите или удалите запись DNS в SOPHOS UTM.
- Для работы с этим модулем необходимо активировать REST-возможности UTM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| address строка | Значение по умолчанию: "0.0.0.0" | IP-адрес IPv4 записи. Можно оставить пустым для автоматического разрешения. |
| address6 строка | Значение по умолчанию: "::" | IP-адрес IPv6 записи. Можно оставить пустым для автоматического разрешения. |
| comment строка | Необязательный комментарий для объекта dns host. | |
| headers словарь | Словарь дополнительных заголовков для отправки в запросах POST и PUT. Необходим для некоторых модулей. | |
| hostname строка | Имя хоста для объекта dns host. | |
| interface строка | Имя интерфейса для использования. Если не указано, используется интерфейс по умолчанию. | |
| name строка / обязательно | Имя объекта. Будет использоваться для идентификации записи. | |
| resolved логическое значение |
| Указание, разрешен ли IP-адрес хоста или нет. |
| resolved6 логическое значение |
| Указание, разрешен ли IP-адрес IPv6 хоста или нет. |
| state строка |
| Желаемое состояние объекта. present создаст или обновит объект.absent удалит объект, если он присутствовал. |
| timeout целое число | Значение по умолчанию: 0 | Время ожидания для UTM при повторном разрешении IP-адреса для имени хоста. |
| utm_host строка / обязательно | REST-адрес Sophos UTM. | |
| utm_port целое число | Значение по умолчанию: 4444 | Порт REST-интерфейса. |
| utm_protocol строка |
| Протокол REST-адреса. |
| utm_token строка / обязательно | Токен для идентификации в REST-API. См. https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en, глава 2.4.2. | |
| validate_certs логическое значение |
| Требовать проверку SSL-сертификата REST-интерфейса или нет. |
Примеры
- name: Create UTM dns host entry
community.general.utm_dns_host:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestDNSEntry
hostname: testentry.some.tld
state: present
- name: Remove UTM dns host entry
community.general.utm_dns_host:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestDNSEntry
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| result сложное | успех | Объект utm, который был создан. | |
| _locked логическое значение | успех | Заблокирован ли объект в данный момент. | |
| _ref строка | успех | Имя ссылки объекта. | |
| address строка | успех | IP-адрес IPv4 объекта. | |
| address6 строка | успех | IP-адрес IPv6 объекта. | |
| comment строка | успех | Строка комментария. | |
| hostname строка | успех | Имя хоста объекта. | |
| interface строка | успех | Имя ссылки интерфейса, к которому связан объект. | |
| name строка | успех | Имя объекта. | |
| resolved логическое значение | успех | Разрешен ли IP-адрес IPv4. | |
| resolved6 логическое значение | успех | Разрешен ли IP-адрес IPv6. | |
| timeout целое число | успех | Время ожидания до следующей попытки разрешения. | |
Авторы
- Johannes Brunswicker (@MatrixCrawler)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/utm_dns_host_module.html
