модуль fortinet.fortimanager.fmgr_system_dnsdatabase — настройка баз данных DNS.

Примечание

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

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Метод, переопределяющий метод базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
system_dnsdatabase dictionary	Набор параметров верхнего уровня.
allow_transfer псевдонимы: allow-transfer list / элементы=string	Список IP-адресов для передачи зоны DNS.
authoritative string	Включить или отключить авторитетную зону. Варианты: `"disable"` `"enable"`
contact string	Адрес электронной почты администратора этой зоны.
dns_entry псевдонимы: dns-entry list / элементы=dictionary	Запись DNS.
canonical_name псевдонимы: canonical-name string	Каноническое имя хоста.
hostname string	Имя хоста.
id integer	Идентификатор записи DNS.
ip string	IPv4-адрес хоста.
ipv6 string	IPv6-адрес хоста.
preference integer	Приоритет записи DNS.
status string	Включить или отключить состояние ресурсной записи. Варианты: `"disable"` `"enable"`
ttl integer	Время жизни этой записи.
type string	Тип ресурсной записи. Варианты: `"NS"` `"MX"` `"CNAME"` `"A"` `"AAAA"` `"PTR"` `"PTR_V6"`
domain string	Доменное имя.
forwarder list / элементы=string	Список IP-адресов перенаправления запросов зоны DNS.
forwarder6 string	IPv6-адрес перенаправления запросов.
interface list / элементы=string	Укажите исходящий интерфейс для подключения к серверу.
interface_select_method псевдонимы: interface-select-method string	Укажите способ выбора исходящего интерфейса для подключения к серверу. Варианты: `"auto"` `"sdwan"` `"specify"`
ip_master псевдонимы: ip-master string	IP-адрес главного DNS-сервера.
ip_primary псевдонимы: ip-primary string	IP-адрес первичного DNS-сервера.
name string / обязательный	Имя зоны.
primary_name псевдонимы: primary-name string	Доменное имя DNS-сервера по умолчанию для этой зоны.
rr_max псевдонимы: rr-max integer	Максимальное количество ресурсных записей.
source_ip псевдонимы: source-ip string	Исходный IP-адрес для перенаправления запросов на DNS-сервер.
source_ip6 псевдонимы: source-ip6 string	Исходный IPv6-адрес для перенаправления запросов на DNS-сервер.
source_ip_interface псевдонимы: source-ip-interface list / элементы=string	IP-адрес указанного интерфейса, используемый в качестве исходного IP-адреса.
status string	Включить или отключить эту зону DNS. Варианты: `"disable"` `"enable"`
ttl integer	Значение времени жизни по умолчанию для записей этой зоны DNS.
type string	Тип зоны. Варианты: `"primary"` `"secondary"` `"master"` `"slave"`
view string	Представление зоны. Варианты: `"shadow"` `"public"` `"shadow-ztna"` `"proxy"`
vrf_select псевдонимы: vrf-select integer	Идентификатор VRF, используемый для подключения к серверу.
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая 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.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure DNS databases.
      fortinet.fortimanager.fmgr_system_dnsdatabase:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        system_dnsdatabase:
          name: "your value" # Required variable, string
          # allow_transfer: <list or string>
          # authoritative: <value in [disable, enable]>
          # contact: <string>
          # dns_entry:
          #   - canonical_name: <string>
          #     hostname: <string>
          #     id: <integer>
          #     ip: <string>
          #     ipv6: <string>
          #     preference: <integer>
          #     status: <value in [disable, enable]>
          #     ttl: <integer>
          #     type: <value in [NS, MX, CNAME, ...]>
          # domain: <string>
          # forwarder: <list or string>
          # forwarder6: <string>
          # ip_primary: <string>
          # primary_name: <string>
          # rr_max: <integer>
          # source_ip: <string>
          # source_ip6: <string>
          # status: <value in [disable, enable]>
          # ttl: <integer>
          # type: <value in [primary, secondary, master, ...]>
          # view: <value in [shadow, public, shadow-ztna, ...]>
          # interface_select_method: <value in [auto, sdwan, specify]>
          # interface: <list or string>
          # source_ip_interface: <list or string>
          # vrf_select: <integer>
          # ip_master: <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_system_dnsdatabase_module.html