Модуль fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_dns — настройка параметров протокола DNS.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.0.0

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_profileprotocoloptions_dns dictionary	Параметры верхнего уровня.
ports any	(список) Порты для сканирования содержимого
status string	Включить или отключить активное сканирование этого протокола. Варианты: `"disable"` `"enable"`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
profile-protocol-options string	Устаревший параметр, используйте “profile_protocol_options”
profile_protocol_options string	Параметр (profile-protocol-options) в запрашиваемом URL.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме workspace. В качестве значения можно указать global, а также другие значения, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь освободит блокировку workspace. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, имена всех входных аргументов записываются в стиле snake_case с использованием символов подчёркивания. Замените аргументы, например “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, однако при их использовании будут появляться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки workspace; параметры верхнего уровня 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 protocol options.
      fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_dns:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        profile_protocol_options: <your own value>
        firewall_profileprotocoloptions_dns:
          # ports: <list or integer>
          # status: <value in [disable, enable]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный запрошенный URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=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_firewall_profileprotocoloptions_dns_module.html