Модуль community.general.utm_dns_host — создание, обновление или удаление записи DNS в Sophos UTM

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.utm_dns_host.

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

Краткое описание

Создание, обновление или удаление записи DNS в SOPHOS UTM.
Для работы этого модуля необходимо активировать REST-интерфейс UTM.

Параметры

Параметр	Комментарии
address string	IPv4-адрес записи. Можно оставить пустым для автоматического разрешения имени. По умолчанию: `"0.0.0.0"`
address6 string	IPv6-адрес записи. Можно оставить пустым для автоматического разрешения имени. По умолчанию: `"::"`
comment string	Необязательный комментарий, добавляемый к объекту DNS-хоста. По умолчанию: `""`
headers dictionary	Словарь дополнительных заголовков, отправляемых в запросах POST и PUT. Требуется для некоторых модулей. По умолчанию: `{}`
hostname string	Имя хоста для объекта DNS-хоста.
interface string	Ссылочное имя используемого интерфейса. Если не указано, используется интерфейс по умолчанию. По умолчанию: `""`
name string / обязательный	Имя объекта, идентифицирующее запись.
resolved boolean	Разрешён ли уже IPv4-адрес имени хоста. Варианты: `false` ← (по умолчанию) `true`
resolved6 boolean	Разрешён ли уже IPv6-адрес имени хоста. Варианты: `false` ← (по умолчанию) `true`
state string	Требуемое состояние объекта. `present` создаёт или обновляет объект. `absent` удаляет объект, если он существует. Варианты: `"absent"` `"present"` ← (по умолчанию)
timeout integer	Тайм-аут, по истечении которого UTM повторно разрешает IP-адрес имени хоста. По умолчанию: `0`
utm_host string / обязательный	Конечная точка REST Sophos UTM.
utm_port integer	Порт REST-интерфейса. По умолчанию: `4444`
utm_protocol string	Протокол конечной точки REST. Варианты: `"http"` `"https"` ← (по умолчанию)
utm_token string / обязательный	Токен для идентификации в REST API. См. https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en, раздел 2.4.2.
validate_certs boolean	Следует ли проверять SSL-сертификат REST-интерфейса. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: none	Может работать в режиме `check_mode` и возвращать прогноз изменения статуса без изменения целевого объекта.
diff_mode	Поддержка: none	В режиме сравнения возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

- 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 complex	Созданный объект UTM. Возвращается: при успешном выполнении
_locked boolean	Заблокирован ли объект в данный момент. Возвращается: при успешном выполнении
_ref string	Ссылочное имя объекта. Возвращается: при успешном выполнении
address string	IPv4-адрес объекта. Возвращается: при успешном выполнении
address6 string	IPv6-адрес объекта. Возвращается: при успешном выполнении
comment string	Строка комментария. Возвращается: при успешном выполнении
hostname string	Имя хоста объекта. Возвращается: при успешном выполнении
interface string	Ссылочное имя интерфейса, с которым связан объект. Возвращается: при успешном выполнении
name string	Имя объекта. Возвращается: при успешном выполнении
resolved boolean	Разрешён ли IPv4-адрес. Возвращается: при успешном выполнении
resolved6 boolean	Разрешён ли IPv6-адрес. Возвращается: при успешном выполнении
timeout integer	Тайм-аут до следующей попытки разрешения имени. Возвращается: при успешном выполнении

Авторы

Johannes Brunswicker (@MatrixCrawler)

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

© 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/general/utm_dns_host_module.html