community.general.utm_dns_host – создание, обновление или удаление записи DNS в Sophos UTM
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.utm_dns_host.
Обзор
- Создаёт, обновляет или удаляет запись DNS в SOPHOS UTM.
- Для этого модуля необходимо активировать REST-возможности UTM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| address строка | По умолчанию: "0.0.0.0" | Адрес IPV4 записи. Можно оставить пустым для автоматического разрешения. |
| address6 строка | По умолчанию: "::" | Адрес IPV6 записи. Можно оставить пустым для автоматического разрешения. |
| comment строка | Необязательный комментарий для объекта DNS-хоста. | |
| headers словарь | Словарь дополнительных заголовков для отправки в запросах POST и PUT. Необходим для некоторых модулей. | |
| hostname строка | Имя хоста для объекта DNS-хоста. | |
| 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/utm_dns_host_module.html
