модуль fortinet.fortimanager.fmgr_system_dnsdatabase_dnsentry — запись DNS.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
dns-database string	Устаревший параметр, используйте «dns_database»
dns_database string	Параметр (dns-database) в запрошенном URL.
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, переопределяющий условия, при которых выполнение считается успешным.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание создать, обновить или удалить объект. Варианты: `"present"` `"absent"`
system_dnsdatabase_dnsentry dictionary	Набор параметров верхнего уровня.
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"`
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.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: DNS entry.
      fortinet.fortimanager.fmgr_system_dnsdatabase_dnsentry:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        dns_database: <your own value>
        state: present # <value in [present, absent]>
        system_dnsdatabase_dnsentry:
          id: 0 # Required variable, integer
          # canonical_name: <string>
          # hostname: <string>
          # ip: <string>
          # ipv6: <string>
          # preference: <integer>
          # status: <value in [disable, enable]>
          # ttl: <integer>
          # type: <value in [NS, MX, CNAME, ...]>

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

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

Ключ	Описание
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_dnsentry_module.html