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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general.

Для использования в плейбуке укажите: community.general.utm_dns_host.

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

Описание

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

Параметры

Параметр	Комментарии
address строка	IP-адрес IPv4 записи. Может быть оставлен пустым для автоматического разрешения. По умолчанию: `"0.0.0.0"`
address6 строка	IP-адрес IPv6 записи. Может быть оставлен пустым для автоматического разрешения. По умолчанию: `"::"`
comment строка	Необязательный комментарий к объекту DNS-хоста. По умолчанию: `""`
headers словарь	Словарь дополнительных заголовков для отправки в запросах POST и PUT. Необходим для некоторых модулей. По умолчанию: `{}`
hostname строка	Имя хоста для объекта DNS-хоста.
interface строка	Имя интерфейса для использования. Если не указан, используется по умолчанию. По умолчанию: `""`
name строка / обязательно	Имя объекта. Используется для идентификации записи.
resolved булево	Разрешен ли IP-адрес IPv4 имени хоста. Варианты: `false` ← (по умолчанию) `true`
resolved6 булево	Разрешен ли IP-адрес IPv6 имени хоста. Варианты: `false` ← (по умолчанию) `true`
state строка	Желаемое состояние объекта. `present` создаст или обновит объект. `absent` удалит объект, если он существует. Варианты: `"absent"` `"present"` ← (по умолчанию)
timeout целое число	Таймаут для разрешения IP-адреса имени хоста в UTM. По умолчанию: `0`
utm_host строка / обязательно	REST-точка входа Sophos UTM.
utm_port целое число	Порт REST-интерфейса. По умолчанию: `4444`
utm_protocol строка	Протокол REST-точки входа. Варианты: `"http"` `"https"` ← (по умолчанию)
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-интерфейса или нет. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/utm_dns_host_module.html