fortinet.fortimanager.fmgr_devprof_system_dns module – Настройка DNS.

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_devprof_system_dns.

Добавлено в fortinet.fortimanager 1.0.0

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

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

Этот модуль позволяет настраивать устройство FortiManager.
Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof string / обязательный	Параметр (devprof) в запрошенном URL.
devprof_system_dns dictionary	Параметры верхнего уровня.
alt_primary aliases: alt-primary string	Альтернативный основной DNS-сервер.
alt_secondary aliases: alt-secondary string	Альтернативный вторичный DNS-сервер.
cache_notfound_responses aliases: cache-notfound-responses string	Включить или отключить ответ DNS-сервера, если записи нет в кэше. Варианты: `"disable"` `"enable"`
dns_cache_limit aliases: dns-cache-limit integer	Максимальное количество записей в кэше DNS.
dns_cache_ttl aliases: dns-cache-ttl integer	Время в секундах, в течение которого в кэше DNS сохраняется информация.
dns_over_tls aliases: dns-over-tls string	Включить, отключить или принудительно использовать DNS over TLS. Варианты: `"disable"` `"enable"` `"enforce"`
domain any	(list or str) Суффикс доменного имени для IP-адресов DNS-сервера.
fqdn_cache_ttl aliases: fqdn-cache-ttl integer	Время жизни кэша FQDN в секундах
fqdn_max_refresh aliases: fqdn-max-refresh integer	Максимальный интервал обновления кэша FQDN в секундах
fqdn_min_refresh aliases: fqdn-min-refresh integer	Минимальный интервал обновления кэша FQDN в секундах
hostname_limit aliases: hostname-limit integer	Ограничение на количество записей в таблице имен узлов
hostname_ttl aliases: hostname-ttl integer	TTL записей в таблице имен узлов
interface string	Укажите исходящий интерфейс для связи с сервером.
interface_select_method aliases: interface-select-method string	Укажите способ выбора исходящего интерфейса для связи с сервером. Варианты: `"auto"` `"sdwan"` `"specify"`
ip6_primary aliases: ip6-primary string	IPv6-адрес основного DNS-сервера.
ip6_secondary aliases: 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	Количество повторных попыток
root_servers aliases: root-servers string	Настройте до двух предпочтительных серверов, обслуживающих корневую зону DNS
secondary string	IP-адрес вторичного DNS-сервера.
server_hostname aliases: server-hostname any	(list) Список имен хостов DNS-серверов.
server_select_method aliases: server-select-method string	Укажите способ определения приоритета настроенных серверов. Варианты: `"least-rtt"` `"failover"`
source_ip aliases: source-ip string	IP-адрес, используемый DNS-сервером в качестве исходного IP-адреса.
source_ip_interface aliases: source-ip-interface any	(list) IP-адрес указанного интерфейса, используемый в качестве исходного IP-адреса.
ssl_certificate aliases: ssl-certificate string	Имя локального сертификата для SSL-соединений.
timeout integer	Интервал ожидания ответа на DNS-запрос в секундах
vrf_select aliases: vrf-select integer	Идентификатор VRF, используемый для подключения к серверу.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method string	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия возникновения ошибки.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия успешного выполнения.
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другое значение, включая root.
workspace_locking_timeout integer	Максимальное время ожидания (в секундах) освобождения блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы используют соглашение об именовании с подчеркиваниями (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании выводятся предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля завершается ошибкой при возврате ненулевого значения rc. Условия возникновения ошибки или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure DNS.
      fortinet.fortimanager.fmgr_devprof_system_dns:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        devprof: <your own value>
        devprof_system_dns:
          # cache_notfound_responses: <value in [disable, enable]>
          # dns_cache_limit: <integer>
          # dns_cache_ttl: <integer>
          # domain: <list or string>
          # ip6_primary: <string>
          # ip6_secondary: <string>
          # primary: <string>
          # secondary: <string>
          # dns_over_tls: <value in [disable, enable, enforce]>
          # retry: <integer>
          # server_hostname: <list or string>
          # ssl_certificate: <string>
          # timeout: <integer>
          # interface: <string>
          # interface_select_method: <value in [auto, sdwan, specify]>
          # alt_primary: <string>
          # alt_secondary: <string>
          # fqdn_cache_ttl: <integer>
          # fqdn_max_refresh: <integer>
          # fqdn_min_refresh: <integer>
          # log: <value in [disable, error, all]>
          # protocol: ["cleartext", "dot", "doh"]
          # server_select_method: <value in [least-rtt, failover]>
          # source_ip: <string>
          # vrf_select: <integer>
          # source_ip_interface: <list or string>
          # hostname_ttl: <integer>
          # hostname_limit: <integer>
          # root_servers: <string>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запрошенного ресурса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Сведения о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение, если используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortimanager/fmgr_devprof_system_dns_module.html