модуль fortinet.fortios.fortios_system_vdom_exception — глобальные объекты конфигурации, которые можно настраивать независимо на разных узлах HA для всех VDOM или в заданной области VDOM в 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_vdom_exception.

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

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

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

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию system и категорию vdom_exception. Примеры содержат все параметры и значения, которые необходимо настроить в соответствии с источниками данных перед использованием. Проверено на 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"`
state string / обязательный	Указывает, следует ли создать или удалить объект. Варианты: `"present"` `"absent"`
system_vdom_exception dictionary	Глобальные объекты конфигурации, которые можно настраивать независимо на разных узлах HA для всех VDOM или в заданной области VDOM.
id integer / обязательный	Индекс (1–4096). См. <a href=’#notes’>Примечания</a>.
object string	Имя объекта конфигурации, который можно настраивать независимо для всех VDOM. Варианты: `"log.fortianalyzer.setting"` `"log.fortianalyzer.override-setting"` `"log.fortianalyzer2.setting"` `"log.fortianalyzer2.override-setting"` `"log.fortianalyzer3.setting"` `"log.fortianalyzer3.override-setting"` `"log.fortianalyzer-cloud.setting"` `"log.fortianalyzer-cloud.override-setting"` `"log.syslogd.setting"` `"log.syslogd.override-setting"` `"log.syslogd2.setting"` `"log.syslogd2.override-setting"` `"log.syslogd3.setting"` `"log.syslogd3.override-setting"` `"log.syslogd4.setting"` `"log.syslogd4.override-setting"` `"system.gre-tunnel"` `"system.central-management"` `"system.csf"` `"user.radius"` `"system.interface"` `"log.syslogd.setting"` `"log.syslogd.override-setting"` `"firewall.address"` `"vpn.ipsec.phase1-interface"` `"vpn.ipsec.phase2-interface"` `"router.bgp"` `"router.route-map"` `"router.prefix-list"` `"firewall.ippool"` `"firewall.ippool6"` `"router.static"` `"router.static6"` `"firewall.vip"` `"firewall.vip6"` `"system.sdwan"` `"system.saml"` `"router.policy"` `"router.policy6"` `"firewall.vip46"` `"firewall.vip64"`
oid integer	Идентификатор объекта.
scope string	Определяет, можно ли настраивать объект конфигурации отдельно для всех VDOM или некоторые VDOM используют общую конфигурацию. Варианты: `"all"` `"inclusive"` `"exclusive"`
vdom list / elements=dictionary	Имена VDOM.
name string / обязательный	Имя VDOM. Источник: system.vdom.name.
vdom string	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Настоятельно рекомендуем использовать собственное значение id вместо 0. Значение «0» — это специальный заполнитель, позволяющий серверной части назначить объекту последний доступный номер, но у него есть ограничения. Дополнительные сведения см. в разделе «Вопросы и ответы».
Устаревшая библиотека fortiosapi объявлена устаревшей; для запуска плейбуков рекомендуется использовать httpapi.
Модуль поддерживает check_mode.

Примеры

- name: Global configuration objects that can be configured independently across different ha peers for all VDOMs or for the defined VDOM scope.
  fortinet.fortios.fortios_system_vdom_exception:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_vdom_exception:
          id: "3"
          object: "log.fortianalyzer.setting"
          oid: "32767"
          scope: "all"
          vdom:
              -
                  name: "default_name_8 (source system.vdom.name)"

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

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

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи конфигурации на FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, полученный от FortiGate после выполнения последней операции Возвращается: всегда Пример: `"200"`
mkey string	Главный ключ (id), использованный при последнем обращении к 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_vdom_exception_module.html