Модуль fortinet.fortios.fortios_user_quarantine — настройка поддержки карантина в Fortinet FortiOS и FortiGate.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для работы с этим модулем требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: fortinet.fortios.fortios_user_quarantine.

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

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

Обзор

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функций пользователя и категорию карантина. Перед использованием необходимо настроить все параметры и значения, указанные в примерах, в соответствии с источниками данных. Проверено на 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"`
user_quarantine dictionary	Настройка поддержки карантина.
firewall_groups string	Группа адресов брандмауэра, включающая все MAC-адреса в карантине. Источник: firewall.addrgrp.name.
quarantine string	Включить или отключить карантин. Варианты: `"enable"` `"disable"`
targets list / elements=dictionary	Запись карантина, содержащая несколько MAC-адресов.
description string	Описание записи карантина.
entry string / обязательный	Имя записи карантина.
macs list / elements=dictionary	MAC-адреса в карантине.
description string	Описание MAC-адреса в карантине.
drop string	Включить или отключить отбрасывание трафика устройства, помещенного в карантин. Варианты: `"disable"` `"enable"`
entry_id integer	Идентификатор записи FSW для MAC-адреса в карантине.
mac string / обязательный	MAC-адрес в карантине.
parent string	Имя родительской записи.
traffic_policy string	Политика трафика для MAC-адресов в карантине. Источник: switch-controller.traffic-policy.name.
vdom string	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi больше не поддерживается; для запуска сценариев рекомендуется использовать httpapi
Модуль поддерживает check_mode.

Примеры

- name: Configure quarantine support.
  fortinet.fortios.fortios_user_quarantine:
      vdom: "{{ vdom }}"
      user_quarantine:
          firewall_groups: "<your_own_value> (source firewall.addrgrp.name)"
          quarantine: "enable"
          targets:
              -
                  description: "<your_own_value>"
                  entry: "<your_own_value>"
                  macs:
                      -
                          description: "<your_own_value>"
                          drop: "disable"
                          entry_id: "2147483647"
                          mac: "<your_own_value>"
                          parent: "<your_own_value>"
          traffic_policy: "<your_own_value> (source switch-controller.traffic-policy.name)"

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

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

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