Модуль fortinet.fortios.fortios_system_dns — настройка DNS в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для работы с этим модулем могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_dns.

Добавлено в fortinet.fortios 2.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры системной функции и категории dns. Перед использованием необходимо настроить источники данных для всех параметров и значений, приведённых в примерах. Проверено с FOS v6.0.0

Требования

На хосте, выполняющем этот модуль, необходимы следующие компоненты.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, разделяйте их символом косой черты. Параметр member_path можно использовать для выполнения операции над элементом.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
system_dns dictionary	Настройка DNS.
alt_primary string	Альтернативный основной DNS-сервер. Не используется в качестве резервного DNS-сервера.
alt_secondary string	Альтернативный вторичный DNS-сервер. Не используется в качестве резервного DNS-сервера.
cache_notfound_responses string	Включить или отключить ответ DNS-сервера, если записи нет в кэше. Варианты: `"disable"` `"enable"`
dns_cache_limit integer	Максимальное количество записей в кэше DNS.
dns_cache_ttl integer	Время в секундах, в течение которого информация хранится в кэше DNS.
dns_over_tls string	Включить, отключить или принудительно использовать DNS over TLS. Варианты: `"disable"` `"enable"` `"enforce"`
domain list / elements=dictionary	Список суффиксов поиска для поиска имени хоста.
domain string / обязательный	Список доменов поиска DNS, разделённых пробелами (не более 8 доменов).
fqdn_cache_ttl integer	Время жизни записей кэша FQDN в секундах (0–86400).
fqdn_max_refresh integer	Максимальный интервал обновления кэша FQDN в секундах (3600–86400).
fqdn_min_refresh integer	Минимальный интервал обновления кэша FQDN в секундах (10–3600).
hostname_limit integer	Ограничение количества записей в таблице имён хостов (0–50000).
hostname_ttl integer	TTL записей в таблице имён хостов (60–86400).
interface string	Укажите исходящий интерфейс для подключения к серверу. Источник: system.interface.name.
interface_select_method string	Укажите способ выбора исходящего интерфейса для подключения к серверу. Варианты: `"auto"` `"sdwan"` `"specify"`
ip6_primary string	IPv6-адрес основного DNS-сервера.
ip6_secondary string	IPv6-адрес вторичного DNS-сервера.
log string	Настройка локального журнала DNS. Варианты: `"disable"` `"error"` `"all"`
primary string	IP-адрес основного DNS-сервера.
protocol list / elements=string	Транспортные протоколы DNS. Варианты: `"cleartext"` `"dot"` `"doh"`
retry integer	Количество повторных попыток (0–5).
root_servers list / elements=string	Настройка до двух предпочтительных серверов, обслуживающих корневую зону DNS.
secondary string	IP-адрес вторичного DNS-сервера.
server_hostname list / elements=dictionary	Список имён хостов DNS-серверов.
hostname string / обязательный	Список имён хостов DNS-серверов, разделённых пробелами (не более 4 доменов).
server_select_method string	Укажите способ определения приоритета настроенных серверов. Варианты: `"least-rtt"` `"failover"`
source_ip string	IP-адрес, используемый DNS-сервером в качестве исходного IP-адреса.
source_ip_interface string	IP-адрес указанного интерфейса, используемый в качестве исходного IP-адреса. Источник: system.interface.name.
ssl_certificate string	Имя локального сертификата для SSL-соединений. Источник: certificate.local.name.
timeout integer	Интервал ожидания ответа на DNS-запрос в секундах (1–10).
vrf_select integer	Идентификатор VRF, используемый для подключения к серверу.
vdom string	Виртуальный домен из числа ранее определённых. vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска плейбуков — httpapi
Модуль поддерживает check_mode.

Примеры

- name: Configure DNS.
  fortinet.fortios.fortios_system_dns:
      vdom: "{{ vdom }}"
      system_dns:
          alt_primary: "<your_own_value>"
          alt_secondary: "<your_own_value>"
          cache_notfound_responses: "disable"
          dns_cache_limit: "5000"
          dns_cache_ttl: "1800"
          dns_over_tls: "disable"
          domain:
              -
                  domain: "<your_own_value>"
          fqdn_cache_ttl: "0"
          fqdn_max_refresh: "3600"
          fqdn_min_refresh: "60"
          hostname_limit: "5000"
          hostname_ttl: "86400"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          ip6_primary: "<your_own_value>"
          ip6_secondary: "<your_own_value>"
          log: "disable"
          primary: "<your_own_value>"
          protocol: "cleartext"
          retry: "2"
          root_servers: "<your_own_value>"
          secondary: "<your_own_value>"
          server_hostname:
              -
                  hostname: "myhostname"
          server_select_method: "least-rtt"
          source_ip: "84.230.14.43"
          source_ip_interface: "<your_own_value> (source system.interface.name)"
          ssl_certificate: "<your_own_value> (source certificate.local.name)"
          timeout: "5"
          vrf_select: "0"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи данных в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, возвращённый FortiGate при последней выполненной операции Возвращается: всегда Пример: `"200"`
mkey string	Главный ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name string	Имя таблицы, использованной для обработки запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для обработки запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Результат операции Возвращается: всегда Пример: `"success"`
vdom string	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

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

© 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/fortinet/fortios/fortios_system_dns_module.html